Skip to content

OAuth

OAuth Operations

Generate Access Tokens

Request

Bodyapplication/jsonrequired

Our API uses a client based OAuth method for authenticating. Firstly you’ll need to request an access token using your client id and secret. This token then will have to be passed in the headers for all requests.

Token lifetime and reuse

Access tokens issued by this endpoint are valid for one year from the time of issue. You should request a token once and store it securely within your application, then reuse the same token across all subsequent API calls until it expires. Do not call /v3/oauth/token on every request — the endpoint is rate-limited and treating it as part of your per-request flow will cause your integration to be throttled (HTTP 429) under normal traffic. Only request a new token when the current one is approaching expiry, has been revoked, or an API call returns 401 Unauthorized indicating the token is no longer valid.

client_idintegerrequired
Example:1
client_secretstringrequired
Example:"VFCcW5gYwy4RDn9hhK16DoPK6nrqvNkIPoeeyMnG"
grant_typestringrequired
Example:"client_credentials"
scopestringrequired
Example:"*"
POST
/v3/oauth/token
curl -i -X POST \
  https://propello-cloud.redocly.app/_mock/openapi/v3/oauth/token \
  -H 'Content-Type: application/json' \
  -d '{
    "client_id": 1,
    "client_secret": "VFCcW5gYwy4RDn9hhK16DoPK6nrqvNkIPoeeyMnG",
    "grant_type": "client_credentials",
    "scope": "*"
  }'

Responses

OK

Bodyapplication/json
token_typestring
Example:"Bearer"
expires_ininteger
Example:31536000
access_tokenstring
Example:"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIzMjIiLCJqdGkiOiI1MTY4ZTZkNzlhNjcyZDViZmM2ODAzZDI4MWI4NmNiNzQ1NDhkY2QzMjQ3MWI2OTM4MDhlYTNhOGFmZjU3ZGU0
Response
{ "token_type": "Bearer", "expires_in": 31536000, "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIzMjIiLCJqdGkiOiI1MTY4ZTZkNzlhNjcyZDViZmM2ODAzZDI4MWI4NmNiNzQ1NDhkY2QzMjQ3MWI2OTM4MDhlYTNhOGFmZjU3ZGU0MmU2MDliNDkxNGRlNzM0ZCIsImlhdCI6MTczNDM0MTk2NS41MDcxMTYsIm5iZiI6MTczNDM0MTk2NS41MDcxMjEsImV4cCI6MTc2NTg3Nzk2NS4zODcxNzEsInN1YiI6IiIsInNjb3BlcyI6WyIqIl19.Q-2atcKqCsd41nqH96yCOoaz8uhrauE3tdi0MhIcVNXvTjjBIytn7LTd3g4s-GLp3WejdJnLDnabszexafA6PKlVVHZUbN2SjQMBXzm9NKI9hB4LWtLvMcmiCyod4V6m0pZC5UeF3VQHkaMz1nPOfnbfI2rf5dzED6aGB7TkN_XjgqzhGwQObyRPbtVFdl7ceUZL5rDsDEOWvDj85KRoczuJSGFAWHnPCHJXLxP6UjwNoXn1AeJ8snHwvlHHZwfXWDPBXqGrm5OYsL7Mw_B8qCCuOQbofVRaN1Yur8XxNjMejflbAnIM5tgpjmCjUhxBiWfTYi4PfCUM4UrXVLDqDmCWlqMwrTmn34jbbGxJ50D4T7eSEMjfxbzhKthrfSV3FpY5oZm8AuRKmla2diniAfrLSocgDARyOCT-blI6bG_E54YPOop1EucEVRkh2AlgMjpwOJwREBp-zfPG7SPmryiH4wcUl_2g4JUzytQxImMklECkLpruurgLTzqkRVjJW2kKwNEtccsB6YaLtD31Scf3jplXUdFoomPzKixe4x98bpvJS2sVRSIzvuJhBh9nooRrXNTFyUJzo417tFHNnFOt_a6ib23AxJ8v363SP0Eq0ql4WUSDQeM93SyPF-e-8gBrfOFZHh8C3PZr90zRacffI8bop4oUu6NgH4ia4nE" }