Exchange OIDC authorization code

curl --request POST \
  --url https://api.extole.io/v4/tokens/openid-connect/authorization-code-flow \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "code": "code",
  "state": "state"
}
'

import requests

url = "https://api.extole.io/v4/tokens/openid-connect/authorization-code-flow"

payload = {
    "code": "code",
    "state": "state"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({code: 'code', state: 'state'})
};

fetch('https://api.extole.io/v4/tokens/openid-connect/authorization-code-flow', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.extole.io/v4/tokens/openid-connect/authorization-code-flow",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'code' => 'code',
    'state' => 'state'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.extole.io/v4/tokens/openid-connect/authorization-code-flow"

	payload := strings.NewReader("{\n  \"code\": \"code\",\n  \"state\": \"state\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.extole.io/v4/tokens/openid-connect/authorization-code-flow")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"code\": \"code\",\n  \"state\": \"state\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.extole.io/v4/tokens/openid-connect/authorization-code-flow")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"code\": \"code\",\n  \"state\": \"state\"\n}"

response = http.request(request)
puts response.read_body

{
  "access_token": "<string>",
  "client_id": "<string>",
  "expires_in": 123,
  "identity_id": "<string>",
  "person_id": "<string>",
  "scopes": []
}

POST

tokens

openid-connect

authorization-code-flow

Exchange OIDC authorization code

curl --request POST \
  --url https://api.extole.io/v4/tokens/openid-connect/authorization-code-flow \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "code": "code",
  "state": "state"
}
'

import requests

url = "https://api.extole.io/v4/tokens/openid-connect/authorization-code-flow"

payload = {
    "code": "code",
    "state": "state"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({code: 'code', state: 'state'})
};

fetch('https://api.extole.io/v4/tokens/openid-connect/authorization-code-flow', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.extole.io/v4/tokens/openid-connect/authorization-code-flow",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'code' => 'code',
    'state' => 'state'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.extole.io/v4/tokens/openid-connect/authorization-code-flow"

	payload := strings.NewReader("{\n  \"code\": \"code\",\n  \"state\": \"state\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.extole.io/v4/tokens/openid-connect/authorization-code-flow")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"code\": \"code\",\n  \"state\": \"state\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.extole.io/v4/tokens/openid-connect/authorization-code-flow")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"code\": \"code\",\n  \"state\": \"state\"\n}"

response = http.request(request)
puts response.read_body

{
  "access_token": "<string>",
  "client_id": "<string>",
  "expires_in": 123,
  "identity_id": "<string>",
  "person_id": "<string>",
  "scopes": []
}

Authorizations

Authorization

string

header

required

Headers

X-CSRF-TOKEN

string

X-NONCE

string

Body

application/json

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.

code

string

required

Authorization code received from the OpenID Connect provider. Validated alongside the X-CSRF-TOKEN and X-NONCE headers; missing or expired codes return 403 authorization_code_response_invalid.

state

string

required

Opaque state value the relying party round-tripped through the authorization-code flow. Must match the value the relying party generated when starting the flow; mismatches return 403 authorization_code_missing_state.

Response

Successful response

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/tokens/exchange/{token}. Pass access_token in the Authorization header (Bearer ...) on subsequent requests.

access_token

string

Token string. Send as Authorization: Bearer <access_token> on subsequent requests, or as the access_token query parameter / extole_token cookie.

client_id

string

Stable Extole identifier for the client (tenant) this token authenticates against.

expires_in

integer<int64>

Seconds until this token expires. Once expired, requests using it return 401 invalid_access_token; rotate via PUT /v4/tokens/exchange/{token} before expiry to keep long-lived integrations alive.

identity_id

string

Stable Extole identifier for the identity (user, managed identity, or resource) that this token represents.

person_id

string

deprecated

Deprecated alias for identity_id. New integrations should use identity_id.

scopes

enum<string>[]

Authorization scopes granted to this token. Determines which API operations the token may invoke.

Available options:

BACKEND,

CLIENT_ADMIN,

CLIENT_REPORT_DOWNLOAD,

CLIENT_SUPERUSER,

ONE_TIME,

PASSWORD_RESET,

UPDATE_PROFILE,

USER_SUPPORT,

VERIFIED_CONSUMER

type

enum<string>

Authentication shape backing the token. USER represents a human dashboard user, MANAGED an OAuth-style managed identity, and RESOURCE a scoped per-resource token.

Available options:

MANAGED,

RESOURCE,

USER

Create a managed token via authorization code Exchange an IdP-initiated OIDC authorization code

Getting Started

Consumer to Extole API

Server to Extole API

Management API

Management Expert API

Exchange OIDC authorization code

Authorizations

Headers

Body

Response