AXIAM PHP SDK

ScimTargetAuthOauth2ClientCredentials
in package
implements ScimTargetAuthVariant

FinalYes

The `oauth2_client_credentials` arm of {@see ScimTargetAuth} (`type: "oauth2_client_credentials"`).

Table of Contents

Interfaces

ScimTargetAuthVariant
How AXIAM authenticates to the downstream service provider, without the credential itself.

Properties

$clientId  : string
$scope  : string|null
$tokenUrl  : string

Methods

__construct()  : mixed
Constructs the `oauth2_client_credentials` arm.
fromArray()  : self
Rebuilds the `oauth2_client_credentials` arm from one decoded JSON object.
jsonSerialize()  : array<string, mixed>
Renders this arm for `json_encode()`.
toArray()  : array<string, mixed>
Renders this arm to its wire form, re-attaching `type: "oauth2_client_credentials"`.

Properties

Methods

__construct()

Constructs the `oauth2_client_credentials` arm.

public __construct(string $clientId, string $tokenUrl[, string|null $scope = null ]) : mixed
Parameters
$clientId : string

The OAuth2 client id.

$tokenUrl : string

The token endpoint the client secret is sent to.

$scope : string|null = null

The scope requested, if any.

fromArray()

Rebuilds the `oauth2_client_credentials` arm from one decoded JSON object.

public static fromArray(array<string, mixed> $data) : self
Parameters
$data : array<string, mixed>

The raw wire object.

Return values
self

toArray()

Renders this arm to its wire form, re-attaching `type: "oauth2_client_credentials"`.

public toArray() : array<string, mixed>
Return values
array<string, mixed>
On this page

Search results