OAuth

Issue OAuth token

Generate an OAuth access token for machine-to-machine API access.

post/v2/oauth/token

Request

Base URL
https://api.demo-retail.urbanfox.io
Auth
none required
TypeScript
https://skmtc.dev/urbanfox/apis/urbanfox-customer-api/docs/v2/oauth/token/post.ts
A function with typed inputs. Its response is checked against the schema.

grant_type'client_credentials' required

OAuth 2.0 grant type; must be client_credentials.

client_idstring required

OAuth 2.0 client identifier issued for the tenant.

client_secretstring required

OAuth 2.0 client secret paired with client_id.

{
  "client_id": "A1b2C3d4E5f6G7h8I9j0K1l2M3n4O5p6",
  "client_secret": "csec_example_7q9x2k4m6p8r0t1v3w5y",
  "grant_type": "client_credentials"
}

Successful Response

access_tokenstring required

JWT access token; send as Authorization: Bearer <access_token> on subsequent API requests

token_type'Bearer' required

OAuth 2.0 token type; always Bearer for this API

expires_ininteger required

Number of seconds until the access token expires, counted from issuance

{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example.signature",
  "token_type": "Bearer",
  "expires_in": 86400
}

No recorded changes to this operation across all 8 revisions of this API.