Connector Builder authorization documentation

An authorization help topic should include any relevant information to help a user create and authenticate a connection.

When users add your connector to a flow for the first time, Okta Workflows asks them to configure a connection. This connection is used to verify a user's account or environment.


In your prerequisites section, specify anything a user has to have before configuring a connection. For example, if a user needs to generate an API key or configure an OAuth app integration. For example:

Sample: Generate an API token

Authentication to the API is controlled with instance-level bearer tokens. To generate a token:

  1. Log in and click Settings.

  2. Click the Access tab.

  3. Locate the specific API URL for your instance.

  4. Click Add to create an API key.

  5. Provide a Name for your API token.

  6. Click Save.

  7. In the dialog that provides the API token, click the visibility symbol to show the API token.

  8. Click Copy to copy the API token to your clipboard.

  9. Click Close.

Configure connection

The authorization topic must include instructions on how to create a connection to your service. For example:

Sample: Create a connection

  1. From the Connections page, click New Connection.

  2. In the New Connection dialog, add a string to the Connection Nickname dialog. This is useful when creating multiple connections to share with your team.

  3. Paste the API token created in the prerequisites section into the API Token field.

  4. Click Create.

Supported scopes

For OAuth or other token-based authentication, include a list of the scopes required to use the connector. If anything is required to set up the scopes, include those details in the prerequisites or configuration sections. For example:

Sample: Supported scopes





For reference, see these Connector Builder authorization topics:

Next steps

Connector Builder action card documentation

Connector Builder custom API card documentation