Managing environment applications
-
Navigate to Administration > Environment > Applications.
To edit the Name, Description, or Owner's email address of any application, click the Edit icon (
) on the same row. The Edit application dialog appears. Make the needed changes and then click Save. -
Locate the name of the application you wish to view. Click the application name.
Tip: To locate an application in the list, click the Search box and enter all or part of an application name. The list automatically updates with your search results as you enter the search term.
-
Select one of the following tabs to access the available information and controls:
-
Properties. Provides the available properties for the selected application:
-
Name
-
Description
-
Short name
-
Owner's email
-
Application access
-
Application authorization
-
Creation date
-
-
Outcomes. Provides a list of all outcomes licensed for the selected application within the current environment.
-
Clients. Provides a list of all clients associated with the selected application. A client is an application that can make authorized resource requests on behalf of the resource owner. Certain clients—usually those that operate without the presence of an interactive user—require credentials to authenticate themselves. Credentials consist of a client ID and a client secret. The Clients tab found here is the same as the Clients tab found under Administration > Tenant > Clients and functions exactly the same. For more information about what actions can be performed on this page, see Clients.
-
Tenants. This tab lists all tenants within the environment for which the application is available.
Tip: To locate a tenant in the list, click the Search box and enter all or part of a tenant name. The list automatically updates with your search results as you enter the search term.
-
To view a tenant's Properties tab, click its name in the Name column. The Properties tab and the other tabs displayed on this screen are the same as the tabs found under Administration > Tenant. For more information about what actions can be performed on any of these tabs, see the relevant topics listed below:
-
To add tenants to the application, click the Add tenant icon (
) near the top of the page. In the dialog that appears, select one or more tenants. Click Add. The newly added tenants should now appear in the table.Tip: To locate a tenant in the dialog, click the Search box and enter all or part of a tenant name. The list automatically updates with your search results as you enter the search term.
-
To remove a tenant from the application, click the Remove icon (
) on the same row. In the dialog that appears, click Remove to confirm that you want to remove the tenant.
-
-
API Resources. Provides a list of Application Programming Interface (API) resources that require access tokens from their callers. For access token validation, API resources must authenticate themselves to call the token validation endpoint of the Identity Server. Three cards appear on this tab: API resource, Secrets, and Scopes.
The API resources card supports the following actions:
-
The Enabled column indicates whether an API resource is currently enabled (
) or disabled (
). To remove an enabled API resource, click the Remove icon (
) on the same row followed by Remove in the confirmation dialog. -
To add an API resource, click the Add API resource icon (
) near the top of the page. In the dialog that appears, the ID field is prepopulated with an automatically generated API resource ID. Enter a Short name and a Name for the new API resource. Optionally, you can enter a Description and the Owner's email address. Click Add. In the New API resource details dialog, click the Copy icon (
) to copy the API resource summary, which includes the unencrypted value of the newly generated secret, to your clipboard. Paste and save this information elsewhere and then click Close. The newly added API resource should now appear in the table with a status of enabled (
).Caution: Be sure to paste and save the secret in a secure location, as you will not be able to retrieve it later.
-
To enable a disabled API resource, click the disabled slider icon (
) in the Enabled column followed by Save in the confirmation dialog. -
To disable an enabled API resource, click the enabled slider icon (
) in the Enabled column followed by Save in the confirmation dialog. -
To populate the Secrets and Scopes cards on this page, click an API resource's name from the Name column in the API resources card.
The Secrets card displays the protective reference tokens for the selected API resource. The following actions are supported:
-
To add a new secret, click the plus icon (
) at the top of the Secrets card. In the dialog that appears, enter a description for the new secret and select either No Expiration or Expiration. If Expiration is selected, an Expiration date box appears. Use the calendar to select an expiration date or type the date in the box manually. Once all of the information has been entered, click Add. After clicking Add, the Add secret confirmation appears. Click the Copy icon (
). The secret is copied to your clipboard. Paste this information immediately to a text file and save it in a secure location.Caution: Be sure to paste and save the secret in a secure location, as you will not be able to retrieve it later.
-
To remove a secret, click the Remove icon (
) on the same row followed by Remove in the confirmation dialog. Tip: Multiple secrets can be removed at the same time. To do so, select the checkbox in the leftmost column for the secrets to be removed followed by the Remove icon (
) at the top of the card.
The scopes card provides a list of the scopes within the selected API resource. A scope is a permission within an API resource. The information on this card is read only and cannot be edited.
The cards on the API resources tab can be reordered in the same way as on the Administration > Tenant > Permissions tab. See Permissions for more information.
-
-