Authentication API

The Froomle Authentication API provides endpoints to obtain OAuth 2.0 Bearer tokens for machine-to-machine authentication. Conceptual information and integration strategies can be found in the Authentication Flow guide.

Specifications

Get Access Token

Obtain an access token using your client credentials.

POST /oauth/token

Parameters

Type Name Schema

Body

client_id
required

string

Body

client_secret
required

string

Body

grant_type
required

string (must be client_credentials)

Responses

HTTP Code Description Schema

200

The token was successfully generated

401

Invalid client credentials

No Content

Consumes

  • application/json

cURL Example

$ curl --location --request POST 'https://{tenant}.froomle.com/oauth/token' \
--header 'Content-Type: application/json' \
--data-raw '{
    "client_id": "{CLIENT_ID}",
    "client_secret": "{CLIENT_SECRET}",
    "grant_type": "client_credentials"
}'

Definitions

Token Response

The response containing the access token.

Name Description Schema

access_token
required

The generated JWT access token.

string

expires_in
required

The number of seconds until the token expires (default is 86400).

integer

scope
optional

The scope(s) associated with the token (e.g., specific environments).

string

token_type
required

The type of token issued (typically Bearer).

string