README.md

Oauth2

(oauth2)

Overview

Available Operations

• authorize - Authorize
• introspect - Introspect Token
• token - Request Token
• revoke - Revoke Token
• userinfo - Get User Info

authorize

Authorize

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Polar;

$sdk = Polar\Polar::builder()
    ->setSecurity(
        '<YOUR_BEARER_TOKEN_HERE>'
    )
    ->build();



$response = $sdk->oauth2->authorize(

);

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

Response

?Operations\Oauth2AuthorizeResponse

Errors

Error Type	Status Code	Content Type
Errors\APIException	4XX, 5XX	*/*

introspect

Get information about an access token.

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Polar;
use Polar\Models\Components;

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

$request = new Components\IntrospectTokenRequest(
    token: '<value>',
    clientId: '<id>',
    clientSecret: '<value>',
);

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

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

Parameters

Parameter	Type	Required	Description
$request	Components\IntrospectTokenRequest	✔️	The request object to use for the request.

Response

?Operations\Oauth2IntrospectTokenResponse

Errors

Error Type	Status Code	Content Type
Errors\APIException	4XX, 5XX	*/*

token

Request an access token using a valid grant.

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Polar;
use Polar\Models\Components;

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

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

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

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

Parameters

Parameter	Type	Required	Description
$request	Components\AuthorizationCodeTokenRequest|Components\RefreshTokenRequest	✔️	The request object to use for the request.

Response

?Operations\Oauth2RequestTokenResponse

Errors

Error Type	Status Code	Content Type
Errors\APIException	4XX, 5XX	*/*

revoke

Revoke an access token or a refresh token.

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Polar;
use Polar\Models\Components;

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

$request = new Components\RevokeTokenRequest(
    token: '<value>',
    clientId: '<id>',
    clientSecret: '<value>',
);

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

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

Parameters

Parameter	Type	Required	Description
$request	Components\RevokeTokenRequest	✔️	The request object to use for the request.

Response

?Operations\Oauth2RevokeTokenResponse

Errors

Error Type	Status Code	Content Type
Errors\APIException	4XX, 5XX	*/*

userinfo

Get information about the authenticated user.

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Polar;

$sdk = Polar\Polar::builder()
    ->setSecurity(
        '<YOUR_BEARER_TOKEN_HERE>'
    )
    ->build();



$response = $sdk->oauth2->userinfo(

);

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

Response

?Operations\Oauth2UserinfoResponse

Errors

Error Type	Status Code	Content Type
Errors\APIException	4XX, 5XX	*/*