Documentation

Authentication

Aforza APIs use OAuth 2.0 for authentication. A private client_id and client_secret are required to request a token and will be provided by Aforza.

Request a token

Aforza's token endpoint is:

• https://login.aforza.com/oauth2/default/v1/token

Example

Here is an example of how to request a token using curl:

Code
curl -X POST https://login.aforza.com/oauth2/default/v1/token \
-H "Content-Type: application/x-www-form-urlencoded" \
--data-urlencode grant_type=client_credentials \
--data-urlencode client_id=YOUR_CLIENT_ID \
--data-urlencode client_secret=YOUR_CLIENT_SECRET \
--data-urlencode scope=SCOPES

Response

The token response is a JSON object in the following format:

Code
{
    "token_type": "Bearer",
    "expires_in": 43200,
    "access_token": "YOUR_ACCESS_TOKEN",
    "scope": "users.manage"
}

Use the token

All API requests to Aforza APIs must include an Authorization header with the value Bearer <access_token>.

Example

Here is an example of how to make a request to the Aforza Users API using curl:

Code
curl -X GET https://api.aforza.com/v1/users \
-H "Authorization: Bearer <access_token>"