A user's granted authorization to access a 3rd party service

Attribute

Description

id
number or string

The unique identifier for this authorization. A single authorization corresponds to a single grant by the user to access the accompanying resource.

status
string

One of awaiting_callback, retrieving_tokens, active, or error

error_code
string

For authorizations in the error state, denotes the code (category) of the error, e.g. invalid_credentials.

error_message
string

For authorizations in the error state, the user-friendly error message, e.g. "Installation failed (request error)."

authorizer
Authorizer

The authorizer that this authorization used to be granted access.

access_token
string (optional)

If available, the current token to access the resource (e.g. the current OAuth2 access token).

Only available if status is active.

authorize_url
string (optional)

The URL the user needs to visit in order to grant access to the resource.

Only available if the status is awaiting_callback.