Skip to main content

OAuth Token Object

This section outlines the OAuth Token object.

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.

AttributeData TypeDescription
access_token
read only
string

The access token value to be used in authentication.

client_id
read only
string

The client ID. This is a unique string representing the registration information provided to the client upon request.

client_secret
read only
string

The client secret string. This is a unique string representing the registration information provided to the client upon request. This field is hidden and not returned in the response.

date_created
read only
string

The date and time when the token was created.

date_expiration_access_tokenstring

The date and time when the token expires.

date_expiration_refresh_tokenstring

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.

namestring

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_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.

scopesstring

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.

token_sid
read only
string

The token secure ID.

token_type
read only
string

The token type.