Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Extole Authentication API

The Authentication API from Extole — 16 operation(s) for authentication.

Extole Authentication API is one of 44 APIs that Extole publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Authentication. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 21 operations across 16 paths, and defines 19 schemas. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against a single base URL, https://{brand}.extole.io.

21 operations 16 paths 19 schemas 4 DELETE6 GET10 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://api.extole.io
Authentication
API Key, API Key, API Key
Resource Areas
1

Authentication & Security 3

Extole Authentication API declares 3 security schemes for authenticating requests. An API key is passed in the cookie as extole_token (COOKIE). An API key is passed in the header as Authorization (HEADER). An API key is passed in the query as access_token (QUERY). By default, every request must be authenticated.

Paths & Operations 21

Across 16 paths, the API surfaces 21 operations — 4 DELETE, 6 GET, 10 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Authentication 21
GET
/api/v5/token
Get consumer token details
getConsumerToken → 200400401403415429
POST
/api/v5/token
Create a consumer access token
createConsumerToken body → 200400401403415429
DELETE
/api/v5/token
Delete a consumer access token
deleteConsumerToken → 200400401403415429
GET
/v4/tokens
Get current access token
getCurrentClientAccessToken → 200400401402403415429
POST
/v4/tokens
Create access token
createClientAccessToken body → 200400401402403415429
GET
/v4/tokens/{token}
Get access token by value
getClientAccessTokenByValue 1 param → 200400401402403415429
DELETE
/v4/tokens/{token}
Invalidate access token
deleteClientAccessToken 1 param → 200400401402403415429
PUT
/v4/tokens/exchange/{token}
Exchange access token
exchangeClientAccessToken 1 param → 200400401402403415429
GET
/v4/tokens/resource
Get resource access token
getResourceToken → 200400401402403415429
POST
/v2/consumers/{accessToken}/authorize
Upgrade consumer authorization
upgradeConsumerAuthorization 1 param → 200400401402403415429
POST
/v2/consumers/{personId}/token
Create consumer authorization
createConsumerAuthorization 1 param → 200400401402403415429
POST
/v4/oauth/tokens
Create OAuth client credentials token
createOAuthClientCredentialsToken body → 200400401402403415429
POST
/v4/tokens/managed/openid-connect/authorization-code-flow
Create a managed token via authorization code
createManagedTokenViaAuthorizationCode 2 params body → 200400401402403415429
POST
/v4/tokens/openid-connect/authorization-code-flow
Exchange OIDC authorization code
exchangeAuthorizationCode 2 params body → 200400401403415429
POST
/v4/tokens/openid-connect/idp-initiated-authorization-code-flow
Exchange an IdP-initiated OIDC authorization code
validateIdpInitiated body → 200400401403415429
POST
/v6/security/oauth/flow/exchange
Exchange OAuth authorization code
exchangeOAuthCode body → 200400401402403415429
DELETE
/v4/tokens/resource/{access_token_to_delete}
Delete a resource access token
deleteResourceToken 1 param → 200400401402403415429
GET
/v2/consumers/{accessToken}/debug
Debug consumer access token
debugConsumerAccessToken 1 param → 200400401402403415429
GET
/v4/tokens/managed
List managed access tokens
listManagedTokens → 200400401402403415429
POST
/v4/tokens/managed
Create a managed access token
createManagedToken body → 200400401402403415429
DELETE
/v4/tokens/managed/{access_token_id}
Delete a managed access token
deleteManagedToken 1 param → 200400401402403415429

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are ManagedAccessTokenResponse (9 properties), ConsumerTokenDetailsResponse (8 properties), AccessTokenResponse (7 properties), AuthCodeManagedAccessTokenCreationRequest (5 properties). Each schema is shown below with its type and property counts.

OAuthFlowCodeExchangeRequest
object
4 properties 3 required
AccessTokenResponse
object
Access-token metadata returned by POST /v4/tokens, POST /v4/tokens/openid-connect/authorization-code-flow, GET /v4/tokens, GET /v4/tokens/{token}, and PUT /v4/…
7 properties
AuthCodeManagedAccessTokenCreationRequest
object
5 properties 5 required
ConsumerTokenDetailsResponse
object
8 properties 8 required
IdpInitiatedAuthCodeResponseValidateRequest
object
2 properties 2 required
TokenResponse
object
3 properties 3 required
AccessTokenCreationRequest
object
Optional body for POST /v4/tokens. Omit the body entirely to mirror the calling identity's scopes; supply a body to bind the new token to a specific clientid,…
5 properties 5 required
AccessTokenResourceResponse
object
2 properties
OAuthAccessTokenResponse
object
3 properties 3 required
ConsumerTokenResponse
object
3 properties 3 required
ManagedAccessTokenResponse
object
9 properties 9 required
ManagedAccessTokenCreationRequest
object
4 properties 1 required
ResourceAccessTokenResponse
object
4 properties 4 required
CreateTokenRequest
object
3 properties 3 required
OAuthFlowCodeExchangeResponse
object
1 property 1 required
AuthCodeResponseValidateRequest
object
Body of POST /v4/tokens/openid-connect/authorization-code-flow. Pair with the X-CSRF-TOKEN and X-NONCE headers minted alongside the authorization-code response.
2 properties 2 required
RestExceptionResponse
object
Represents the API error response
5 properties 5 required
SuccessResponse
object
1 property 1 required
ZonedDateTime
string
[RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557section-4) date-time with a num…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

extole-authentication-api-openapi.yml Raw ↑

Other APIs Extole publishes across the network.

Extole Audiences API
Extole Batch Jobs API
Extole Blocks API
Extole Campaign Controllers Actions API
Extole Campaign Controllers API
Extole Campaign Controllers Triggers API
Extole Campaign Flow Steps API
Extole Campaigns API
Extole Components API
Extole Components Grants API
Extole Components Settings API
Extole Components Subscriptions API