Resources

Once all of the required OAuth communication string parameters have been added as a Resource type in the Resource types node, a corresponding OAuth resource must be added and configured. (Think of a resource as an instance of a specific resource type that has it's own configuration values.)
The Resources node exposes resources and their corresponding parameters. On the Resources node, you can add, edit or delete resources, their parameters and values.

Deleting or editing resources and resource parameters may break services or applications that rely on those items. Do not delete or edit these items unless you understand the impact of doing so.

Follow these steps to add a resource:

  1. Click New from the Resources section.
  2. Type the values for the new resource.

    FieldDescription
    Resource NameProvide a unique and descriptive name for the resource
    Resource TypeSelect the resource type that the resource will be associated with
    Authorization Endpoint

    The authorization endpoint is the endpoint on the authorization server, and is the URL used to make OAuth authentication requests to the underlying system. This URL depends on the system that provides the authentication and usually looks something like this:
    https://login.service.com/services/oauth2/authorize
    or
    https://service/authorize/oauth/2/request

    Check with the target system administrator or its documentation to determine the URL for that system's Authorization endpoint.

    Token EndpointThe token endpoint is the endpoint on the authorization server where the authorization code, client ID and client secret are exchanged for an access token. This URL depends on the system that provides the access token and usually looks something like this:

    https://login.service.com/services/oauth2/token
    or
    https://service/token/oauth/2

    Check with the target system administrator or its documentation to determine the URL for that system's token endpoint.

    Use Host Server Authorization EndpointIndicates that this resource uses Trust.
    Refresh Token EndpointThis is the endpoint on the authorization server where the refresh token, client ID and client secret are exchanged for an access token. This URL depends on the system that provides the access token and usually looks something like this:
    https://login.service.com/services/oauth2/token
    or
    https://service/token/oauth/2
    Check with the target system administrator or its documentation to determine the URL for that system's token endpoint.
    Metadata EndpointThis is used to validate the bearer token. This endpoint may be required if the resource requires refresh token validation.
  3. Click OK.

Follow these steps to edit a resource:

  1. Select a resource and click Edit from the Resources section.
  2. Change the values for resource as needed, using the table in Add a resource as guidance.
  3. Click OKto confirm you want to update the resource.

Follow these steps to delete a resource:

  1. Select the resource you want to delete and click Delete.
  2. Click Delete from the Resources section.
  3. Click OK on the confirmation message to confirm you want to delete the resource.

The Refresh button refreshes the resources list after changes have been applied.

Resource parameters

In the Resource Parameters section, you can add and configure the parameters that are required for the selected resource and configure static values for the parameters, if needed.

Follow these steps to add a resource parameter:

  1. Click New from the Resource Parameters section.
  2. Enter values for the new parameter.

    FieldDescription
    Parameter NameUsing the drop-down list, select the parameter you want to provide values for. (This list is populated with the parameters you entered for the resource type)
    Authorization ValueA static value to be used during the authorization step, as required by the service.
    Token ValueA static value to be used during the token step, as required by the service.
    Refresh ValueA static value to be used during the refresh step, as required by the service.
  3. Click OK.

Follow these steps to edit a parameter:

  1. Select a parameter and click Edit from the Resource Parameters section.
  2. Change the values for the fields that needs to edited.
  3. Click OK.

Follow these steps to delete a parameter:

  1. Select the parameter you want to delete and click Delete.
  2. Click OK on the confirmation message to confirm that you want to delete the parameter.

The Refresh button refreshes the resource parameters list after changes have been applied.

Token replacement values

The Token Replacement Values section allows you to override default parameter values for a token and enter alternate default values for selected OAuth token parameters.

Follow these steps to add a token replacement value:

  1. Click New from the token replacement value section.
  2. Enter values for the new token replacement value.

    FieldDescription
    Parameter NameSelect the parameter you want to provide override values for.
    ValueThe value to be used.
  3. Click OK.

Follow these steps to edit a token replacement value:

  1. Select a value and click Edit from the Token Replacement Value section.
  2. Change the values for the parameters that need to be replaced as needed.
  3. Click OK.

Follow these steps to delete a token replacement value:

  1. Select the value you want to delete by clicking on it.
  2. Click Delete from the Token Replacement Value section.
  3. Click OKon the confirmation message to confirm that you want to delete the value.

The Refresh button refreshes the token replacement values list after changes have been applied.