Regenerate Application Client Secret

Purpose: Use the Regenerate Application Client Secret window to generate a new client secret for an existing client application.

Note:             This option is available only for external application clients that were created through Order Broker.

For more information: See Manage External Application Access for background.

How to display this screen: Select New Secret (NewSecretIcon.png)for the application client at 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.

When you regenerate: When you regenerate the secret, the client is deleted and recreated in IDCS or OCI IAM and use of the new secret is required for OAuth. You need to update the external application so that it can request the token from IDCS or OCI IAM as the previous secret is no longer valid.

How to generate a new secret: Click Regenerate and click OK at the confirmation window. There might be a slight delay. If the request is successful, the window displays:

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

•         The new Secret, and a link to copy it to the clipboard. This information will not be available later, so it should be stored in a secure location.

Copy and paste the Client ID and the new Secret if you need to share the information for an application that is not integrated with IDCS or OCI IAM, so that application can use the secret for OAuth authentication.

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 generate the new secret, such as if communication with IDCS or OCI IAM fails. See Manage External Application Access for information on the properties used for communication with IDCS or OCI IAM.

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.

Fields at this screen

Field

Description

Application Details

Client ID

When the Application Type is XOffice On Prem, the generated Client ID is RGBU_XTROFFOP_<ENV>_XOFFICE_APPID, where <ENV> is the specified Environment.

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 represents Order Broker.

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.

Display-only.

Application Description

The description defined when the application was created for web service authentication. This is the Description in IDCS or OCI IAM. Alphanumeric, 50 positions. Display-only.

Application Type

Indicates whether the new application is either:

•         XOffice On Prem: Select this option only if the application was not already created in another application.

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

Display-only.

About XOffice On Prem: The Manage External Application Access screen displays records only if they are not associated in IDCS or OCI IAM with a parent ID. If you use XOffice on premises, each store location record in IDCS or OCI IAM is associated with the XOffice on premises application as its parent ID. Because there can be many store locations associated with the parent application record, the Manage External Application Access screen displays just the XOffice rather than the individual store locations.

Environment

 

Generated Credentials

Client ID

When the Application Type is XOffice On Prem, the generated Client ID is RGBU_XTROFFOP_<ENV>_XOFFICE_APPID, where <ENV> is the specified Environment.

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 represents Order Broker.

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. This information will not be available later, so it should be stored in a secure location.

 

________________________________