Security

Specifies paths and operations for accessing protected endpoints.

Create API Auth Token

Authorization endpoint for gaining token used for API requests requiring bearerAuth.

You will be provided the required client_id and client_secret as part of onboarding.

The returned bearer token will only enable access to endpoints as per your client's defined role. Refer to Access Control for more information.

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",
"audience": "https://learn.vii.au01.mattr.global",
"grant_type": "client_credentials"
}

Response samples

application/json

{"access_token": "s2dgbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6s2dcaEROemRDf5gbRVEwTTVSVFE0TmtZME9UZzVNVEpDTlVJNFJqRTBPREExTmpZMk1qazFPQSJ9",
"expires_in": 86400,
"token_type": "Bearer"
}

➔ Next to Custom domain