Skip to navigation
AuthenticationOAuth

Create an OAuth token

View as Markdown

Creates a bearer token that enables an OAuth client to authenticate with the Zuora REST API. The OAuth client must have been created using the Zuora UI. See Authentication for more information.

Note: When using this operation, do not set any authentication headers such as Authorization, apiAccessKeyId, or apiSecretAccessKey.

You should not use this operation to generate a large number of bearer tokens in a short period of time; each token should be used until it expires. If you receive a 429 Too Many Requests response when using this operation, reduce the frequency of requests. This endpoint is rate limited by IP address.

For the rate limit information of authentication, see Rate and concurrent request limits.

Headers

Zuora-Track-IdstringOptional<=64 characters

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.

The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Zuora-Entity-IdsstringOptionalformat: "uuid"

An entity ID if you have Multi-entity enabled.

The value must be a 36-character UUID that contains hyphens(-). If your entity ID is not a valid UUID, convert it to a valid UUID before specifying this parameter.

Request

This endpoint expects an object.
client_idstringRequired=36 characters
The Client ID of the OAuth client.
client_secretstringRequired<=42 characters
The Client Secret that was displayed when the OAuth client was created.
grant_typeenumRequired

The OAuth grant type that will be used to generate the token. The value of this parameter must be client_credentials.

Allowed values:

Response headers

X-RateLimit-Limit-minuteinteger

The rate limit of this operation, in requests per minute. See rate limits for more information.

X-RateLimit-Remaining-minuteinteger

The number of requests that you may make in the next minute. See rate limits for more information.

Zuora-Request-IdstringOptional
The Zuora internal identifier of the API call. You cannot control the value of this header.
Zuora-Track-IdstringOptional
A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.

Response

OK
access_tokenstringOptional
The generated token.
expires_indoubleOptional
The number of seconds until the token expires.
jtistringOptional
A globally unique identifier for the token.
scopestringOptional

A space-delimited list of scopes that the token can be used to access.

token_typestringOptional

The type of token that was generated, i.e., bearer.

Errors

429
Too Many Requests Error