Authorization

Get an access token.

Get the OAUTH v2 access token in order to access other v2 endpoints. The Black Kite API v2 uses Client Credential grant type. This endpoint is an alternative to the default Authorization method provided specifically for Swagger, which uses Basic Authentication for in order to get an access token. <br/> This same endpoint version, on the other hand, supports POST body for sending client id and client credential values.

post/api/v2/oauth/token

Request

Base URL
https://app.blackkitetech.com
Auth
OAuth 2
Client credentials
Token URLhttps://app.blackkitetech.com//api/v2/oauth/token
TypeScript
https://skmtc.dev/blackkitetech/apis/black-kite-api/docs/api/v2/oauth/token/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

grant_type'client_credentials' required

client_idstring required

client_secretstring required

Example request

{
  "grant_type": "client_credentials",
  "client_id": "269d98e4922fb3895e9ae2108cbb5064",
  "client_secret": "f2a1ed52710d4533bde25be6da03b6e3"
}

Response

Success

access_tokenstring

The JWT token produced as an access token.

token_type'bearer'

The type of the token, which should contain only bearer.

expires_innumber

The life time of the access_token in seconds.

tenant_idnumber

The identifier of tenant owning the client credentials.

Example response

{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkZXNjcmlwdGlvbiI6IlN3YWdnZXIgdGFyZ2V0ZWQgY2xpZW504oCmIiwiaWF0IjoxNTE2MjM5MDIyLCJyb2xlIjoiRWNvc3lzdGVtIEFkbWluIiwiYXV0aG9yaXplX29uIjpbIk15IENvbXBhbmllcyIsIkZpbmFuY2UiXSwiY2FuU3RhcnRTY2FuIjpmYWxzZSwiY2FuQWRkRG9tYWlucyI6dHJ1ZX0.rouDngjt0q9JeF-TY6fF-kZDHH9ECKFG5kVOAPkmfH8",
  "token_type": "bearer"
}

Changes

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