Prerequisites for Registering a Service

To register a service from Workspace and to access and call the REST API endpoints of the service, you have to complete certain prerequisite tasks.

Log in as an administrator to identity domain or Oracle Identity Cloud Service (IDCS) admin console in Oracle Cloud Infrastructure (OCI) and complete the following tasks.
  1. Create and configure an application
  2. Assign the application to the ServiceDeveloper role
  3. Get the client ID, client secret, and scope to register the service

Create and configure an application

You have to create an application and configure OAuth settings including grants and scope for authentication and access management, and then activate the application.

The following steps are for creating and configuring an application from the identity domain.

  1. Navigate to the Applications page.
  2. On the Applications page, click Add application.
  3. In the Add application dialog, select Confidential Application, and click Launch workflow.
  4. Enter the application details such as name (for example, OPAOAuth) and description, and click Next.
  5. In the Configure OAuth page, select Configure this application as a client now.
  6. Under Allowed grant types, select Client credentials. You can also select the Resource Owner and JWT Assertions grant types.
  7. Under Client IP Address, select Anywhere.
  8. Now, add the scopes of the service that you want to register to this application.

    For example, if you want to register Oracle Integration, add the scopes specified in the Oracle Integration IDCS application instance to the application you are creating.

    Adding scopes for the service you want to register enables the client application (that you're creating) to obtain access tokens against the scopes specified, and thus call and access the service instance's APIs.

    1. Under Resources, click Add scope.

      In the resulting Add scope window, IDCS applications of provisioned services are displayed.

    2. Search for the IDCS application instance of the service you want to register.

      For example, if you want to register Oracle Integration then search for the IDCS application of the Oracle Integration service instance.

    3. Click the expand arrow next to the application instance to display the scopes configured for it.
    4. Select the required scopes.
    5. Click Add.

      Note that if you want to select all the scopes configured for the application, select the application and click Add.

  9. Click Next.
  10. Click Finish.
  11. Activate the application. Click Activate and when prompted click Activate application.

The activated application is displayed on the Applications page.

Assign the application to the ServiceDeveloper role

In the IDCS application of the service that you want to register, assign the application that you created to the ServiceDeveloper role.

  1. Navigate to the Oracle Cloud Services page.
  2. Search for the IDCS application of the service instance that you want to register. For example, if you want to register Oracle Integration, search for the IDCS application of the Oracle Integration service instance.
  3. Select the application to open the application details page.
  4. Under Resources, click Application roles.
  5. Under the Application roles section, select the ServiceDeveloper role and click the expand arrow.
  6. Next to Assigned applications, click the Manage link.
  7. In the Manage application assignment window, click the Show available applications link.
  8. Search for the application (OPAOAuth) that you created.
  9. Select the application and click Assign.
  10. Click Close.

Notice that when you expand the ServiceDeveloper role under the Application roles section, you'll see a number (1 ) besides Assigned applications, indicating that an application is assigned to the role.

Get the client ID, client secret, and scope to register the service

Now that you've created, configured, and activated an application, and assigned the ServiceDeveloper role to the application, you can obtain the client ID, client secret, and scope for registering the service from Workspace.

  1. Navigate to the Applications page.
  2. On the Applications page, search for the application (OPAOAuth) that you created.
  3. Select and click the application to open its details page.
  4. Under OAuth configuration, scroll to the General Information section.
  5. Copy and note the client ID.
  6. Click the Show secret link and then copy and note the client secret.
  7. Scroll to the Token issuance policy section, and copy the scope under Resources.
You're all set to register the service now from Workspace. See Register a New Service.