OAuth Token Object

The OAuth Token Object represents an access token issued to an OAuth client or partner. Tokens grant temporary access to the API and may include both an access token and a refresh token for renewal. Each token also carries metadata such as creation time, expiration date, and associated partner information.

This object is commonly used when authenticating API requests or managing token lifecycles.

OAuth Token Object Attributes

The fields listed in the table below will be returned in a JSON object when a successful request has been made. The client_secret field is never returned in the response for security reasons.

Attribute	Data Type	Description
access_token read only	string	The access token value to be used in authentication.
client_id read only	string	The OAuth client ID associated with this token. See Body Arguments on Generate OAuth Bearer Token for how to obtain one.
client_secret read only	string	The OAuth client secret used to generate this token. Never returned in the response.
date_created read only	string	The date and time when the token was created.
date_expiration_access_token createupdate	string	The date and time when the token expires.
date_expiration_refresh_token createupdate	string	The date and time when the refresh token expires.
date_last_accessed read only	string	The date and time when the token was last accessed.
ip_last_accessed read only	string	The IP address from which the token was last accessed.
name createupdate	string	The friendly name used to identify the token.
partner read only	object	The Partner object associated with the OAuth token. This field is displayed if with_related is set to true when performing the GET queries.
partner_login_sid read only	string	The secure ID of the Partner Login (sub-login) the token was issued to. null when the token was issued to the partner itself.
partner_sid read only	string	The secure ID of the partner associated with the OAuth token.
refresh_token read only	string	The refresh token value to create a new token.
scopes createupdate	string	The scope of the access request available for this specific token. Any values in scopes must exist in available_scopes on the Partner object. Refer to the available_scopes table for a comprehensive list of scopes that can be assigned to a partner. If this field is not specified when creating an OAuth Token object, all available_scopes from the Partner object are added.
status read only	string	The token activation status. Values accepted in this field are active and pending_mfa. A token is created with pending_mfa when the OAuth Client used to generate it has mfa_required set to true and the authenticating partner login has an MFA configuration. A pending_mfa token only accepts requests to Verify MFA Code; once a valid code is submitted, the status changes to active.
token_sid read only	string	The token secure ID.
token_type read only	string	The type of the token. The value is always bearer. The token is passed in request headers as Authorization: Bearer {token} and used as credentials for authentication with the API.