Skip to content
/Authentication

Authentication

The Authentication operation is the authentication layer when you integrate data with Zuora Revenue APIs. Use this operation to authenticate and generate a token that can be valid for a specific time period. The token is required for all the subsequent API calls. By default, a token will be valid for 30 minutes before it expires. If the issued token expires, call this operation again with valid credentials to get a new token.

To acquire the token, you must provide the user role and client name as well as basic authorization in the HTTP request header. An example of basic authorization header is as follows:

Basic c3lzYWRtaW46fsDFsgsV2cHJvJTEyMw==

An example of the returned authentication token is as follows:

ybmFtZSI6InZpbm90aC5iYWFsYWppIiwiaXNzIjoiUkV```
Operations

Create authentication

Request

Authenticates and gets the Json Web Token to push and pull data from your Zuora Revenue instance.

Security
basicAuth
Headers
rolestringrequired
Default:"API Role"
clientnamestringrequired
Default:"Default"
cURL
curl -i -X POST \
  -u '<username>:<password>' \
  https://one.zuora.com/api/integration/v1/authenticate \
  -H 'clientname: Default' \
  -H 'role: API Role'

Responses

Authentication token is returned.

Bodyapplication/json; charset=utf-8
Messagestring

Token

Default:"Token Generated"
statusstring

Response Status

Default:"success"
Response
{
  "Message": "Token Generated",
  "status": "success"
}