Skip to content

Authorization

Endpoints for handling the OAuth 2.0 Client Credentials Grant flow.

Operations

Request an access token

Request

Request an access token using your client credentials

Security
Basic
Bodyapplication/x-www-form-urlencoded

Access token request

grant_typestringrequired
Value:"client_credentials"
curl -i -X POST \
  -u '<username>:<password>' \
  https://api.cloud.hypatos.ai/v2/auth/token \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d grant_type=client_credentials

Responses

Access token provided

Bodyapplication/json
access_tokenstringrequired

The access token issued by the authorization server

Example:"MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"
expires_inintegerrequired

The lifetime of the access token in seconds

Example:3600
token_typestringrequired
Value:"Bearer"
scopestring

Scopes allowed for the client

Example:"documents.write projects.write"
Response
{
  "access_token": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3",
  "expires_in": 3600,
  "token_type": "Bearer",
  "scope": "documents.write projects.write"
}