Service Authentication¶
Overview¶
The Service Authentication page enables administrators to configure the integration of IFS Cloud Remote deployments with the IFS AI platform. This integration allows access to AI-powered services such as Copilot, ML Service, and more.
Prerequisites¶
Before you begin, ensure the following:
- IFS Cloud Environment Deployment: Your environment must be deployed with version 25.1.1 or later and must be fully operational.
- Custom-values.yaml File: Ensure this file is prepared and ready for updates during the integration process.
Upon your first login, the Service Authentication page will be empty, as no tenants have been created yet.
Registering a Remote Instance¶
To begin the integration, you must provision a new tenant in the IFS AI platform.
- Click the Register Remote Tenant button located in the top-right corner.
- Fill out the Register a New Remote IFS Tenant form as follows:
Tenant Registration Fields¶
| Field | Description | Requirement |
|---|---|---|
| Instance Name | A meaningful, unique name to identify the instance. | Yes |
| Environment Type | The type of IFS Cloud environment for the tenant (options: PROD, UAT, CFG, DEV). |
Yes |
| Instance Type | Defaults to REMOTE. No changes needed. |
Yes |
| IFS Cloud Release | The version of the IFS Cloud environment to be integrated | Yes |
Click Create Tenant to initiate provisioning. You will then be redirected to the Service Authentication page where the Tenant Provisioning Status is displayed.
Tenant Provisioning Statuses¶
| State | Description | |
|---|---|---|
Requested |
The provisioning request has been sent. |  |
Provisioning |
Tenant provisioning is in progress. |  |
Ready for Installation |
Tenant provisioning is complete. You can now configure service access. Start configuring Service Access now. |  |
Configured |
Nonce and Tenant ID have been successfully configured. |  |
Installed |
The IFS Cloud Remote deployment is successfully integrated. |  |
Configuring Service Access¶
Once the tenant status updates to Ready for Installation, proceed with service access configuration:
- Click Configure Service Access
-
On the configuration page, you can:
- Generate a nonce
- Copy the Tenant URL
Nonce Validity and Usage
When using a nonce (a one-time-use token), please keep the following in mind:
- Single Use Only: A nonce can be used only once. After it’s used during installation, it becomes invalid immediately.
- 24-Hour Expiry: Each nonce is valid for 24 hours from the time it’s generated. After this period, it will automatically expire and cannot be used.
- One at a Time per Tenant: Only one active nonce can exist for a tenant at any time. If a new nonce is generated, it will automatically cancel any previously generated one.
These values must be added to the
custom-values.yamlfile used in the IFS Installer. -
Run the IFS Installer with the updated file to complete the integration process.
For additional guidance on updating the IFS Installer, refer to the official installation documentation.
Completion¶
Once the integration is successfully completed, the tenant status will update to Installed, indicating that the IFS Cloud Remote deployment has been fully integrated with the IFS AI platform.