AIairship
OAuth

Request token

Changed on

Request an OAuth access token with Basic Auth or an assertion. When making a request with an assertion, do not provide the Basic Auth header. See also OAuth 2.0 in the Airship API Security documentation.

Use oauth2.asnapius.com for Airship's North American cloud site and oauth2.asnapieu.com for Airship's European cloud site when requesting an OAuth token.

post/token

Request

Headers

Content-Typestring required

The request must have a Content-Type of application/x-www-form-urlencoded.

Request body application/x-www-form-urlencoded

OR

Response

Returned on token request success.

access_tokenstring

The issued token that can be used for all endpoints as allowed by set scopes.

expires_ininteger

The number of seconds from the time the token is generated until it expires.

scope'att' | 'chn' | 'cnt' | 'tpl' | 'evt' | 'jny' | 'lst' | 'nu' | 'pln' | 'psh' | 'rpt' | 'sch'

The value of the scope parameter is a list of space-delimited, case-sensitive strings. If multiple scopes are specified, their order does not matter. Each string adds an additional access range to the requested scope. For more information about scope values, see OAuth token scopes in the Airship API Authorization Reference documentation.

  • att: Attachments
  • chn: Channels
  • cnt: Contacts
  • tpl: Content
  • evt: Events
  • jny: Journeys
  • lst: Lists
  • nu: Named Users
  • pln: Pipelines
  • psh: Push
  • rpt: Reports
  • sch: Schedules
token_type'Bearer'

The type of issued token.

Changes

  • 38241778b0c1Revision changes
    • breaking

      removed subschema #1: Request token with Basic Auth subschema #2: Request token with assertion from the request body oneOf list

    • warning

      added the new jny enum value to the response property for the response status

    • warning

      added the new rpt enum value to the response property for the response status

    • warning

      added the new tpl enum value to the response property for the response status

    This list may be incomplete.