VOvoucherifyio
OAuth

Introspect OAuth 2.0 Token

Introspect an OAuth 2.0 token for an API client.

post/v1/oauth/introspect

Request

  • Base URL
    https://api.voucherify.io
  • URL
    https://api.voucherify.io/v1/oauth/introspect
  • Auth
    API key in header X-App-Id and API key in header X-App-Token

Request body application/x-www-form-urlencoded

access_tokenstring required

An OAuth 2.0 token generated with the API token and key.

Example request

{
  "access_token": "1ABCde2FGHijKl3m4NO5pqR6STUv7wxYzAbc8dE90FgH1IJkLm"
}

Response

Returns details about an existing token and its expiration times. If an nonexistent token is sent in the request, the response returns that it is inactive.

access_tokenstring required

The access token used to authorize access to the Voucherify API.

client_idstring required

Unique client identifier, assigned by Voucherify, for OAuth.

expires_atinteger required

Timestamp in seconds in the Unix format indicating when the token expires.

expires_ininteger required

Number of seconds left until the token expires.

scopestring required

Defines the scope of possible actions that can be done with the OAuth token. The api scope allows using the server-side API. The client_api scope allows using the whole client-side API. Possible values: api, assets, async-actions, campaigns, categories, client_api, client_consents, client_customers, client_events, client_promotions, client_publish, client_qualifications, client_redeem, client_redemptions, client_validate, client_validations, client_vouchers, consents, customers, events, exports, locations, loyalties, metadata-schemas, orders, product-collections, products, promotions, publications, qualifications, redemptions, referrals, rewards, segments, skus, task-results, templates, trash-bin, validation-rules-assignments, validation-rules, validations, vouchers.

token_type'Bearer' required

Type of the token. Use the value as the header prefix for authorization.

activeboolean required

Determines if the token is active. Nonexistent tokens are also marked as inactive.

Changes

No recorded changes to this operation across all 1 revision of this API.