Generate Application Client

Purpose: Use the Generate Application Client window to:

•         Generate a new client for another application, if it does not already exist in IDCS or OCI IAM and it directly integrates with a cloud service.

How to display this screen: Select New Client from the Manage External Application Access screen.

Note:             Only users with Manage External Application Access authority can display this window. See the Role Wizard for more information.

Before you start: Before beginning the generation steps, you would typically select the Refresh option at the Manage External Application Access screen to confirm that the required client application was not already created.

Creation steps: If the required client application is not displayed after you select Refresh:

1.      Complete the Application Details. 

•         Application Type:

•         External: The application integrates with IDCS or OCI IAM and an OAuth Client does not already exist in IDCS or OCI IAM.

Selecting an Application Type is required.

•         Application Description: Enter a brief description of the application. This will be the Description in IDCS or OCI IAM, and is informational. If you require multiple environments, such as one for production and one for stage, you can include this information in the application description. Alphanumeric, 50 positions; required.

2.      Click Generate Client to request a new client be generated through Retail Home; otherwise, select Cancel to close the window without generating the client. Retail Home communicates with IDCS or OCI IAM for saving the generated client.

3.      If you click Generate Client and the generation is successful, the window displays the Generated Credentials:

•         The new generated Client ID, and a link to copy it to the clipboard.

•         The new generated Secret, and a link to copy it the clipboard.

Important:                           Copy and paste the new client ID and the new client secret so that you can update an external application so that it can request the token from IDCS or OCI IAM. This information will not be available later so should be stored in a secure location.

Note:             If your browser displays a warning message when you select the Copy to Clipboard option, click Allow Access.

The window displays an error if it cannot create the client, such as if the client ID already exists, or if communication with Retail Home fails.

Click Done to close the window, and click OK at the confirmation window to confirm that you are done copying the client ID and secret to the clipboard.

About the generated client ID:

•         When the Application Type is External, the generated Client ID is RGBU_OBCS_<RANDOM>_APPID, where <RANDOM> is a random string of 8 characters and OBCS identifies Order Broker.

Define web service access: After creating the client, you can define web service access. See the Edit Web Services window for more information.

Regenerate secret: Use the Regenerate Application Client Secret if you need to regenerate the secret for the client application.

Fields at this screen

Field

Description

Application Details

Application Type

Indicates whether the new application is either:

•         External: Select this option if the application integrates with IDCS or OCI IAM.

Required.

Application Description

The description of the application created for web service authentication. This is the Description in IDCS or OCI IAM. Alphanumeric, 50 positions. Required.

Generated Credentials

If the new client is generated correctly, the following fields are displayed.

Client ID

When the Application Type is External, the generated Client ID is RGBU_OBCS_<RANDOM>_APPID, where <RANDOM> is a random string of 8 characters.

Note:  This is the Name in IDCS or OCI IAM. Note that the Display Name in IDCS or OCI IAM is the Client ID without the _APPID suffix.

Select Copy to Clipboard to copy the client ID to the clipboard, so you can more easily share it with the external application that needs to use it for OAuth authentication. The window indicates that the ID has been successfully copied.

Secret

The client secret to use for generating the OAuth token.

Select Copy to Clipboard to copy the secret to the clipboard, so that you can share it with the external application that needs to use it for OAuth authentication. The window indicates that the secret has been successfully copied.

 

________________________________