Security

Create API Auth Token

Returns an API access token. This token must then be used as an authorization header for all requests to protected endpoints (this is required for the majority of operations).

This request must be made to an authentication server based on your tenant's region:

  • Sydney, Australia: auth.au01.mattr.global
  • Montreal, Canada: auth.ca01.mattr.global
  • Frankfurt, Germany, Europe: auth.eu01.mattr.global
  • Oregon, United States: auth.us01.mattr.global

Your region details as well as required client_id and client_secret are provided as part of onboarding, or retrieved when you create a tenant on the Self Service Portal. If you do not have your tenant details, or have any other questions, please contact us before proceeding.

Request
Request Body schema: application/json
client_id
required
string

Use the client_id value provided with your tenant details, or retrieved when you created a tenant on the Self Service Portal.

client_secret
required
string

Use the client_secret value provided with your tenant details, or retrieved when you created a tenant on the Self Service Portal.

audience
required
string

Use your tenant URL.

grant_type
required
string

Use client_credentials.

Responses
200

Successful response

401

Unauthorized

post/oauth/token
Request samples
application/json
{
  • "client_id": "htf792W4p4MedZbnoWAs51EfqUt4d2",
  • "client_secret": "d3fYDX7FjPg1D1h2viARXsolPByQ9vMfg8LHylBy8F4s5KJLB4HhHGOxxqJnSj3G",
  • "grant_type": "client_credentials"
}
Response samples
application/json
{
  • "access_token": "s2dgbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6s2dcaEROemRDf5gbRVEwTTVSVFE0TmtZME9UZzVNVEpDTlVJNFJqRTBPREExTmpZMk1qazFPQSJ9",
  • "expires_in": 86400,
  • "token_type": "Bearer"
}