Use OAuth 2.0 Client Credentials

To add OAuth 2.0 authentication using the Client Credentials grant type:

  1. Click the Overview tab.

  2. Click Set up authentication.

  3. In the Authentication dialog, select OAuth 2.0 from the Auth Type dropdown list.

  4. For the Grant Type dropdown, select Client Credentials.

  5. For the Client Authentication Type dropdown, select one of the following options:

    • Send as basic auth header (client_secret_basic): authentication sends the client credentials in the HTTP authentication header. This is the recommended option.

    • Send as basic auth body (client_secret_post): authentication sends the client credentials within the body of the request.

  6. Add values to the following fields:

Field Definition
Paths
Token URL The location where the flow sends the client credentials.

This field should be a full URL. For example, https://api.box.com/oauth2/token.
Credentials
Client ID A publicly exposed string provided by the service. This is used to identify the OAuth application and build authorization URLs.

This field can't be removed and appears as a non-editable field in this section of the Preview window.

This field is populated by the end user when they create the connection.
Client Secret

A private value string provided by the service. This value is used to authenticate the application identity to the service.

This field can't be removed and appears as a non-editable field in this section of the Preview window.

This field is populated by the end user when they create the connection.
Parameters (Optional) Parameters allow you to collect additional information from the connector user that might be necessary for authentication, such as their instance or subdomain. These fields are presented to the user when they first create a connection and are required.

Label: The name for the parameter that is shown on the New Connection dialog when setting up the connector.

Key: Text value in the key-value pairing that the service uses. For example, api_key, application_key, or authentication.

Type: You can select three different field types:

  • Text: Shows a plain text field to the user. This is an open text field with no redaction.

  • Password: Shows a redacted text field. The user can't see what text is entered into this field.

  • Dropdown List: A manually created dropdown list of values that the user can select.

For a Client Credentials grant type, the Client ID and Client Secret parameters appear by default. You can add text to create a unique name for these labels, but these parameters can't be removed.
Config Values (Optional) Other configuration values may be needed to define how a user authenticates to your connector. Click Add Config Value.

Label: The name for the configuration value that is shown on the New Connection dialog when setting up the connector.

Definition: Indicate whether this field is populated with a static value or a value from a helper flow.

  • For Static Value, enter the value in the Value field.

  • For Value from Helper Flow, select a flow from the Choose Flow dialog.

Type: You can select two different field types:

  • Text: Shows a plain text field to the user. This is an open text field with no redaction.

  • Password: Shows a redacted text field. The user can't see what text is entered into this field.

The Visible toggle determines whether the configuration value appears in the authentication dialog for the connector.

Next steps

Add option fields to connector cards