v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
OAuth Token

Generate Access Token

Use this API to generate an OAuth access token using the client_credentials grant type.

🗒 Things to Know

  • Client credentials can be generated from within Global Settings in the OneTrust application. For more information, see Managing OAuth 2.0 Client Credentials.
  • Use the client_id and client_secret to generate the OAuth access token using this API.
  • A maximum of 500 OAuth 2.0 client credentials can be created per account.
post/api/access/v1/oauth/token

Response

OK

access_tokenstring

The OAuth access token for API authentication.

emailstring email

The API user email in the format tenantGuid@api.onetrust.com.

expires_ininteger

The token lifetime in seconds.

guidstring uuid

A unique identifier for this token session.

jtistring

The JWT identifier for this token.

languageIdinteger

The numeric identifier for the user's language.

orgGroupGuidstring uuid

The unique identifier of the organization where the credential was created.

orgGroupIdstring uuid

The unique identifier of the organization.

ot_scopesstring

The API scopes granted to this credential.

rolestring

The user role associated with this token.

scopestring

The OAuth scope for this token.

sessionIdstring uuid

The unique identifier for this API session.

tenantGuidstring

The unique identifier of your OneTrust tenant.

tenantIdinteger

The numeric identifier of your OneTrust tenant.

token_typestring

The type of token. Always 'bearer'.

user_namestring email

The API username in the format tenantGuid@api.onetrust.com.