v2

latestOpenAPI 3.0.3Apache 2.02026-07-31158109678.6 KB
oauth

Create OAuth token

Creates OAuth token using various grant types

post/token

Request body

client_idstring required
client_secretstring required
grant_type'authorization_code' | 'refresh_token' | 'password' | 'client_credentials' required
codestring

Required if grant_type is 'authorization_code'

refresh_tokenstring

Required if grant_type is 'refresh_token'

usernamestring

Required if grant_type is 'password'

passwordstring

Required if grant_type is 'password'

Response

OK. Token created successfully <a href='http://tools.ietf.org/html/rfc6749#section-5.1' target='_blank'>RFC 6749 Section 5.1</a>.

access_tokenstring required

The OAuth access token

tokenstring

The OAuth access token

token_typestring required

The type of token issued

expires_ininteger required

Token expiration time in seconds

refresh_tokenstring

The refresh token (only provided for certain grant types)

scopestring

The scope of the access token

Example response

{
  "access_token": "abcd1234567890efgh",
  "token": "abcd1234567890efgh",
  "token_type": "bearer",
  "expires_in": 3600,
  "refresh_token": "refresh_abcd1234567890efgh",
  "scope": "all"
}