Credentials
Generic OAuth
Explains how to create a Generic OAuth credential for authenticating with any OAuth-compatible API. Used in the Apicall task for client credentials OAuth flows.
Overview
The Generic OAuth credential can be used to authenticate with any API that supports OAuth client credentials. When created, the platform will immediately attempt to obtain an access token from the specified token URL. This credential can be used in the API Call task.
Fields
Creating the Credential
- Navigate to the Credentials section of the manage platform.
- Click the + Create new itembutton.
- Select Generic OAuth from the credential type dropdown.
- Enter a Credential Name.
- Enter the Token URL.
- Enter the Client ID and Client Secret.
- Optionally, enter the Scope.
- Select the Grant Type.
- Select the Client Authentication Method.
- Click the Createbutton.
The platform will attempt to obtain an access token. If successful, the credential will be created and the token will be stored securely.
Additional Credentials
Some OAuth providers have custom requirements on their token endpoint — for example, requiring a custom x-api-key header alongside the standard OAuth parameters. The Org Credentials field handles these cases.
To use this:
- First, create the credential that satisfies the provider's extra requirement (e.g., a Custom Header credential with the required header key and value).
- Copy the
orgcredentialuuidof that credential (see Getting an orgcredentialuuid). - Paste it into the Org Credentials field when creating the Generic OAuth credential.
If multiple additional credentials are needed, provide them as comma-separated orgcredentialuuid values.