Authorize a connection
This method starts the OAuth authorization flow for a data connector. The platform returns an authorization URL. Redirect the user to this URL so they can grant access to their account.
After the user grants or denies access, the platform redirects them to the redirect URL you provided, with the outcome appended to that URL as query parameters. Read these parameters from the redirect that your application receives:
- `connection_id`: The identifier of the new connection, returned on success. Store this value and pass it as the `connection_id` path parameter in later requests.
- `status`: Set to `ok` on success.
- `custom_id`: The label you supplied, returned on success when you provided one.
- `error`: An error code, returned instead of the other parameters when the user denies access or the flow fails.
Authentication
x-api-keystring
Your API key.
<Note title="Note">
You can find your API key on the <a href="https://playground.twelvelabs.io/dashboard/api-keys" target="_blank">API Keys</a> page.
</Note>
Request
This endpoint expects an object.
provider
The data connector provider to authorize.
Allowed values:
redirect_uri
The URL where the user is redirected after granting or denying access. If your account has an allow-list of redirect URLs configured, this URL must be on it.
custom_id
A label you supplied, stored on the connection and returned with it. Use a value that does not identify a person so you can match the connection to your own records.
Response
The authorization flow has been successfully initiated.
state
A value the platform uses to secure the authorization flow. You do not need to read or send it: the platform includes it in the authorize_url field and checks it automatically when the user is redirected back. It is returned only so you can match or troubleshoot requests.
Errors
400
Bad Request Error