Request Token

Request an access token using a valid grant.

POST /v1/oauth2/token

PHP (SDK)

PHP

declare(strict_types=1);

require 'vendor/autoload.php';

use Spaire;
use Spaire\Models\Components;

$sdk = Spaire\Spaire::builder()->build();

$request = new Components\AuthorizationCodeTokenRequest(
    clientId: '<id>',
    clientSecret: '<value>',
    code: '<value>',
    redirectUri: 'https://memorable-season.name',
);

$response = $sdk->oauth2->token(
    request: $request
);

if ($response->tokenResponse !== null) {
    // handle response
}

200

{
  "access_token": "<string>",
  "token_type": "<string>",
  "expires_in": 123,
  "scope": "<string>",
  "refresh_token": "<string>",
  "id_token": "<string>"
}

Body

application/x-www-form-urlencoded

AuthorizationCodeTokenRequest

RefreshTokenRequest

WebTokenRequest

grant_type · string · required

Allowed value: "authorization_code"

client_id · string · required

client_secret · string · required

code · string · required

redirect_uri · string<uri> · required

Required string length: 1 - 2083

Response

200 - application/json

Successful Response

access_token · string · required

token_type · string · required

Allowed value: "Bearer"

expires_in · integer · required

scope · string · required

refresh_token · string | null

id_token · string | null