Create endpoint for external clients

Each client application must register with the instance to participate in OAuth authorization.

Before you begin

Role required: admin

Procedure

  1. Navigate to System OAuth > Application Registry.
  2. Click New.
  3. On the interceptor page, click Create an OAuth API endpoint for external clients.
  4. Fill out the fields, as appropriate (see table).
  5. Click Submit. The record is saved in the Application Registries [oauth_entity] table.
    Creating an endpoint for external clients
    Table 1. Application registration field descriptions
    Field Description
    Name A unique name identifying the application you are requiring OAuth access for.
    Client ID [Read-Only] The automatically-generated unique ID of the application. The instance uses the client ID when requesting an access token.
    Client Secret [Required] The shared secret string that both the instance and the application use to authorize communications with one another. The instance uses the client secret when requesting an access token. Leave this field blank to have the instance automatically generate a client secret.
    Logo URL The URL containing an image to use as the application logo.
    Active A check box for indicating that the instance can authorize access to the application. Only active applications can request access tokens.
    Refresh Token Lifespan The number of seconds a refresh token is valid. The instance uses this lifespan value when requesting a refresh token. By default refresh tokens expire in 100 days (8640000 seconds).
    Access Token Lifespan The number of seconds an access token is valid. The instance uses this lifespan value when requesting an access token. By default access tokens expire in 30 minutes (1800 seconds).
    Comments Any additional information you want to associate with this application.