IFS Cloud for API Task Capability

Overview

The IFS Cloud Integration connects IFS Loops to your IFS Cloud environment to pull service requests, knowledge articles, and Projection APIs. It uses OAuth client credentials for authentication, which are generated directly in IFS Cloud and entered during setup in IFS Loops.

Setup instructions

Create OAuth Client in IFS Cloud

1

Log in to your IFS Cloud account.

2

Search for IAM Clients.

3

Click on the "+" (Add) button to create a new client (or use an existing one).

4

Enter a unique Client ID.

5

Enable the following options:

1. Enable Client
2. Enable Service Account

6

(Optional) Add a description.

7

Click OK.

8

Copy the Client Secret.

Create OAuth Client in IFS Cloud

1

After creating IAM client, open client details and record the service account username.

2

Navigate to: Solution Manager -> Users and Permissions -> Users

3

Filter by Directory ID set to the service account username.

4

If a record exists, know that this is the user profile of the Loops digital worker.

• Any necessary permission sets should be granted to this user.

5

If a record does not exist, create a user:

1. Click the +
2. Set identity as IFS_AIAGENT
3. Set description as IFS Loops digital worker
4. Make sure Active is toggled on
5. Fill Directory ID with the service account username

   1. This must be an exact match or it will not link to the IAM Client
   2. If it it does not link, repeat the process
6. For User Type select Service User
7. Click Save
8. Verify for the created user that under IAM User tab it shows one entry with username set the same as the IAM Client service account username

Add Permission Set to User

1

To function correct the digital worker needs a configured permission set.

2

The Loops team will provide the permission set in .xml format, after you receive it:

1. Navigate on IFS Cloud to Solution Manager -> Users and Permissions -> Permission Sets -> Import Permission Sets
2. Upload the .xml.

3

Navigate to Solution Manager -> Users and Permissions -> Permission Sets -> Permission Set

4

Search for the name of the permission set

5

Under Users Granted tab, add the digital worker user

Add IFS Cloud Integration in IFS Loops

1

Log in to the IFS Loops platform using your credentials.

2

Navigate to the Connectors section from the sidebar.

3

Click on the Add Integration button.

4

Choose IFS Cloud from the list.

5

Provide the following details:

1. Integration Name: Enter a unique name.
2. Select Capability:

   1. APITask: To perform API operations.
3. Domain Name: Enter your IFS Cloud domain. Extract only the domain part from the full URL. For example, from https://example-instance.ifscloud.com/, use only example-instance.ifscloud.com.
4. Namespace: Enter the required namespace.

   1. To find the namespace:

      1. Open your IFS Cloud login page (use an incognito browser if necessary)
      2. Check what follows "/auth/realms/" in the URL. (i.e. "/auth/realms/abcd/" means that "abcd" is the namespace)
5. Client ID & Client Secret: Use the values created in IFS Cloud.
6. IAM Client Has Offline Access Scope:

   1. Select Yes if your IAM client has offline_scope access
   2. Otherwise, keep it as No.

6

Click on the Connect button.

7

On success, you will see a popup: "Integration Configured Successfully"

Import APIs as tools

1

Go to your IFS Cloud integration.

2

Click on the Edit button.

3

Navigate to the API tab.

4

Click on the Import button.

5

You will see a list of available Projection APIs.

1. Search for the APIs you want to import as tools.

6

To import APIs as tools:

1. Click on the View API Details (👁) icon.
2. Then click on Import.

If no APIs are visible, you need to run the job to fetch APIs from IFS Cloud. (Refer to Launch Data Ingestion Job.)