Authentication

Endpoints for authenticating with the API via OAuth2 flows

Get an access token

This endpoint is used to obtain an access token by using client credentials or user credentials.

Request
Request Body schema: application/x-www-form-urlencoded
required
grant_type
required
string

Grant type value - currently only client_credentials is explicitly supported.

Value: "client_credentials"
client_id
required
string <uuid>

The client's identifier.

client_secret
required
string <password>

The client's secret.

Responses
200

A successful response containing the access token.

400

Bad Request - Invalid request parameters.

401

Unauthorized - Invalid client credentials.

post/oauth2/token
Request samples
application/x-www-form-urlencoded
grant_type=client_credentials&client_id=your-client-id&client_secret=your-client-secret
Response samples
application/json
{}

Gets the details of the current access token.

Securityazure_auth
Responses
200

A successful response containing the details of the access token.

400

Malformed Request (ProblemDetails)

get/oauth2/introspect
Request samples
Response samples
application/json
{
  • "roles": [
    ],
  • "clientId": "97b47a5b-b5f9-4838-9b46-e1d84ca7aa1f (Test Automation)",
  • "expiry": "2021-03-04T15:00:00Z",
  • "audience": "27010c79-524b-4daf-8016-4372c0fbafb3 (Slipstream Internal)",
  • "software": [
    ],
}