Auth (1.0.0)

Download OpenAPI specification:Download

The Auth API provides access to other Optoro APIs using the OAuth 2.0 client credentials flow. Optoro's Client Success team will provide the credentials used when requesting an access token. The access token returned from the oauth/tokens endpoint will be used in subsequent requests to Optoro APIs.

Fetch Token

Returns an OAuth 2.0 access token and related metadata. Tokens should be used in subsequent requests to Optoro APIs.

Request

Request Body schema: application/json

grant_type required	string The name of the OAuth flow used to create a token. Use 'client_credentials'.
client_id required	string Identifier used to authenticate. Obtained from Optoro's Client Success team.
client_secret required	string Secret used to authenticate. Obtained from Optoro's Client Success team.

Responses

200

An OAuth 2.0 bearer token and related metadata.

400

Malformed request. Check structure of JSON payload.

401

Invalid credentials used to obtain an access token.

404

The requested resource could not be found.

422

The request could not not be processed. Ensure parameter values are valid.

5XX

Server error. Retry request using an exponential backoff.

post/oauth/token

Request samples

Payload

application/json

{"grant_type": "string",
"client_id": "string",
"client_secret": "string"
}

Response samples

application/json

{"access_token": "G0ybScDl_7CA3tWVou",
"token_type": "Bearer",
"expires_in": 90000,
"scope": "read write",
"created_at": 1656518368
}