Authentication

access_token

Query the authorization server for an access token used to access property resources.</br> If the automatic delivery method for API keys is used, the grant type urn:ietf:params:oauth:grant-type:api-key needs to be used to request an API key. This grant type requires grant_type=urn:ietf:params:oauth:grant-type:api-key, client_id, client_secret, redirect_uri and code.</br> For OAuth 2.0., two different grant types (authorization_code, refresh_token) are supported. Authorization code grant type requires grant_type=authorization_code, client_id, client_secret, redirect_uri, code. Refresh token grant type requires grant_type=refresh_token, client_id, client_secret, refresh_token.</br> Read the Authentication guide for implementation tips, user flows and testing advice.

post/access_token

Request

  • Base URL
    https://api.cloudbeds.com/api/v1.3
  • URL
    https://api.cloudbeds.com/api/v1.3/access_token
  • Auth
    none declared

Request body application/x-www-form-urlencoded

grant_type'authorization_code' | 'refresh_token' | 'urn:ietf:params:oauth:grant-type:api-key' nullable

The OAuth2 grant type.

client_idstring nullable

The client identifier. Each client must be provisioned an identifier.

client_secretstring nullable

The client secret. Each client must be provisioned a secret.

redirect_uristring nullable

The client pre-configured redirect URI. (Required for grant type 'authorization_code' and 'urn:ietf:params:oauth:grant-type:api-key').

codestring nullable

An authorization code provisioned by /oauth (Required for grant type 'authorization_code' and 'urn:ietf:params:oauth:grant-type:api-key').

refresh_tokenstring nullable

A refresh token to renew an access_token (Required for grant type 'refresh_token' only).

Response

200 Response

access_tokenstring

Authenticated access token.

token_typestring

The type of the access token authenticated.

expires_ininteger

The expiration time of the access token in seconds.

refresh_tokenstring

A token to refresh your access token without performing the full auth flow.

Changes

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