Generate a client ID and secret

The client ID and secret are part of the authentication process that the API user will need to follow before issuing Oracle Clinical One Platform API calls. For more details, see Get started as an API developer.

The client ID and secret must be generated by an Oracle Health Sciences IAMS customer-delegated administrator for each user account that will be using the Oracle Clinical One Platform APIs.

Steps

Steps Screen shot
1. Using your customer-delegated administrator credentials, sign in to your Oracle Health Sciences IAMS OAuth Admin Console account.

For more details on how to get this URL, see Get started as a system administrator.

None.
2. On the home page, click Request New Client. Request New Client is a button.
3. Fill in the following fields:
  • Client Name: This name is only relevant in the context of the OauthAdmin tool and will not be used elsewhere. You may use the same name or a similar name as the one used in the Oracle Health Sciences IAMS user account. That way, it will be obvious to you how the client and the Oracle Health Sciences IAMS account relate. The Oracle Health Sciences IAMS user account may or may not be created already.
  • Client Type: Choose one of the following options
    • Password Grant: Choose this option when an end-user Oracle Health Sciences IAMS account will be used to make the API calls. This option is a good choice for getting started quickly as the user is likely to have an Oracle Health Sciences IAMS account for accessing the application user interface already. In this case, after receiving the client and secret, the user will be all set to start using APIs.
    • Client Credentials: Choose this option for automated system-to-system API calls, where an actual end-user isn't necessarily involved long term. With client credentials, the password is not actually used to authenticate the API call which means you do not need to worry about password rotation every 90 days and it has no impact on your integration when it expires.
  • Business Service: Select the business service of the user who needs to make API calls in their REST client. For an API developer, that business service should be clinicalone-CNE.

    Note:

    This field is only displayed when you have previously selected the Password Grant client type.

This is how you set the client name and client type when choosing the Password Grant option.Password Grant is a radio button.

This is how you set the client name and client type when choosing the Client Credentials option.Client Credentials is a radio button.

4. Click Add Permissions. Add Permissions is a button.

5. On the Add Permissions dialog, select ec-dc-svc, ec-designer-svc, and ec-datahub-svc which are displayed in the list and click Add.

Later on, as you start exploring the Oracle Clinical One Platform APIs and discovering which endpoints are necessary for an API developer's task, you can go back and refine the permissions you granted in the authentication token to the user. For more information on these permissions, see About API tasks and corresponding permissions.

Permissions are check boxes that you must select.

Selected permissions are displayed in a table, on each row.

6. On the Request New Client dialog, copy and paste the client ID and secret in a secure location. Request New Client is a dialog box with a Close button.
7. Depending on what type of client ID you previously selected, here is your next step:
  • If you chose the Password Grant option, then all you have to do now is send the client ID and secret to the API developer, so they start using the APIs. See Get started as an API developer.

    Note:

    If you chose this client type, but the API developer does not already have an Oracle Health Sciences IAMS account, you must create one. See Create a user account in Oracle Health Sciences IAMS.
  • If you chose the Client Credentials option, then you must create a new user account in both Oracle Health Sciences IAMS and Oracle Clinical One Platform, in addition to sending the client ID and secret to the API developer. To create these accounts, see the next steps:
None.