API resources are configured to group and organize related scopes and claims into one resource.
To configure an API resource:
Launch the Hyland IdP Administration client and log in (see Accessing the Hyland IdP Administration Client).
Upon successfully logging in, the tenant, provider, client connection, and API resource information is displayed. In a wide display, the tenant information is in the left pane and the providers, client connections, and API resources configured for that tenant are listed in the right pane. In a narrow display, the tenant information is at the top of the page and the provider, client connection, and API resource information is below it.
Click the API Resource tab to view the API resources currently configured for the tenant. The number of API resources configured is displayed in parenthesis in the tab heading.
Do one of the following:
If this is a new API resource, click Add New at the upper right of the API resource list.
If you are configuring an existing API resource, click its name in the list of API resources.
The API Resource configuration page is displayed. It is divided into several areas.
At the top of the API Resource configuration page, make sure Enabled is selected and then configure the following settings:
API Resource NameNote:
This setting is required.
The unique name of the API resource.
The API Resource Name is sent back to the Identity Provider Server as part of the access token. It is recommended that the API Resource Name be entered using only alphanumeric characters, underscores (_), or hyphens (-) to ensure compatibility with token generation.
API Resource Display Name
A brief description to help identify this API resource, used mostly for logging purposes.
The list of scopes associated with the API resource.
A list of claims that help identify the user. For example, a few standardized claims are sub, name, or birthdate.
The plain-text value of the word or phrase configured as the API secret for the API resource. The value entered is converted to a hash of the value when the API resource configuration is saved.
- Click Save in the lower right corner of the page.
- Recycle the application pool of the Hyland IdP server in IIS for the changes to take effect.