Salesforce Docs Portal

OauthToken

Represents an OAuth access token for connected app authentication. Use this object to create a user interface for token management. This object is available in API version 32.0 and later.

A connected app integrates an application with Salesforce using APIs. Connected apps use standard SAML and OAuth protocols to authenticate, provide single sign-on, and provide tokens for use with Salesforce APIs. In addition to standard OAuth capabilities, connected apps allow Salesforce admins to set various security policies and have explicit control over who can use the corresponding apps. Each time that a user grants access to an application, the application obtains a new access token.

Supported Calls

describeSObjects(), query()

Special Access Rules

Users with the Customize Application permission see all tokens for all users in the org. Otherwise, you see only your own tokens.

If you try to use Apex DML operations and then query this object in the same call, you get an UncommittedWork error with this description.

A callout was unsuccessful because of pending uncommitted work related to a process, flow, or Apex operation.
Commit or roll back the work, and then try again.

To avoid this error, execute DML operations and queries in separate, asynchronous calls.

Fields

Field Name Details
AccessToken
Type
string
Properties
Filter, Group, Nillable, Sort
Description

The refresh token for authorization.
AppMenuItemId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description

The unique ID for the App Picker menu item that’s associated with this OAuth token.

This is a relationship field.
Relationship Name
AppMenuItem
Relationship Type
Lookup
Refers To
AppMenuItem
AppName
Type
string
Properties
Filter, Group, Nillable, Sort
Description

The label for the connected app that’s associated with this OAuth token.
DeleteToken
Type
string
Properties
Filter, Group, Nillable, Sort
Description

A token that can be used at the revoke OAuth token endpoint to remove this token.

Id
Type
ID
Properties
Defaulted on create, Filter, Group, idLookup, Sort
Description

Reserved for future use. Currently, the value is always null.
LastUsedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description

The most recent date when the OAuth token was used.
RequestToken
Type
string
Properties
Filter, Group, Nillable, Sort
Description

The authorization code that was used to request the corresponding AccessToken. With this authorization code, you can revoke the corresponding AccessToken by passing the DeleteToken.
UseCount
Type
int
Properties
Filter, Group, Nillable, Sort
Description

How often the token has been used.
UserId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description

The owner of the token.

This is a relationship field.
Relationship Name
User
Relationship Type
Lookup
Refers To
User

Usage

To delete an AccessToken, send a request to the revoke OAuth token endpoint with the DeleteToken as the parameter. For example, the URL https://MyDomainName.my.salesforce.com/services/oauth2/revoke?token=(the Delete Token) causes the deletion of the token.

In API version 34.0 and later, this object was enhanced to help manage high instance counts. A query() call returns up to 500 rows. A queryMore() call returns 500 more, up to 2,500 total. No more records are returned after 2,500. To make sure that you don’t miss any records, issue a COUNT() query in a SELECT clause for OauthToken. This query gives you the total number of records. If there are more than 2,500 records, use these options to manage your results.

  • Divide queries by filtering on fields like UserId to return subsets of less than 2,500 records.
  • Use OFFSET to get batches of 2,000 records. Start with an OFFSET of 0 and then increment by 2,000. If you use this option, we recommend that you also use LIMIT to limit each query to 2,000.
    Note

    Note

    The OFFSET clause is limited to 2,000 rows. Requesting an offset greater than 2,000 results in a NUMBER_OUTSIDE_VALID_RANGE error.

    For example, use an initial query with this structure.

    SELECT <desired fields> FROM OauthToken LIMIT 2000 OFFSET 0

    Then, run another query with an offset of 2,000.

    SELECT <desired fields> FROM OauthToken LIMIT 2000 OFFSET 2000
    Continue to increase the offset by 2,000 until you have results for all records.