AXIAM PHP SDK

OAuth2ClientCreatedResponse
in package
implements JsonSerializable

FinalYes

Response for client creation -- includes the one-time plaintext secret.

Table of Contents

Interfaces

JsonSerializable

Properties

$clientId  : string
$clientSecret  : Sensitive|null
$createdAt  : string
$grantTypes  : array<string|int, mixed>
$id  : string
$name  : string
$redirectUris  : array<string|int, mixed>
$scopes  : array<string|int, mixed>
$tenantId  : string
$updatedAt  : string

Methods

__construct()  : mixed
Constructs a OAuth2ClientCreatedResponse.
fromArray()  : self
Rebuilds a OAuth2ClientCreatedResponse from one decoded JSON object.
jsonSerialize()  : array<string, mixed>
Renders this object for `json_encode()`.
toArray()  : array<string, mixed>
Renders this object back to its wire form.

Properties

Methods

__construct()

Constructs a OAuth2ClientCreatedResponse.

public __construct(string $clientId, string $createdAt, array<int, string> $grantTypes, string $id, string $name, array<int, string> $redirectUris, array<int, string> $scopes, string $tenantId, string $updatedAt[, Sensitive|null $clientSecret = null ]) : mixed
Parameters
$clientId : string

the server's client_id field

$createdAt : string

the server's created_at field

$grantTypes : array<int, string>

the server's grant_types field

$id : string

the server's id field

$name : string

the server's name field

$redirectUris : array<int, string>

the server's redirect_uris field

$scopes : array<int, string>

the server's scopes field

$tenantId : string

the server's tenant_id field

$updatedAt : string

the server's updated_at field

$clientSecret : Sensitive|null = null

The plaintext client secret, shown exactly once. T21.2 — absent for a client registered with token_endpoint_auth_method: none. A public client is created with no secret, so there is nothing to show; the member is omitted rather than sent as "", which an operator (or an SDK) would reasonably read as a secret that happens to be empty. Every confidential registration — that is, every registration that existed before T21.2 — carries it exactly as before. (optional)

fromArray()

Rebuilds a OAuth2ClientCreatedResponse 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

jsonSerialize()

Renders this object for `json_encode()`.

public jsonSerialize() : array<string, mixed>

Any Sensitive it carries stays WRAPPED here, so a log line or a json_encode($model) in application code prints [SENSITIVE]. The one place a secret is revealed is ManagementTransport, on the way to the wire and nowhere else (§27.5).

Return values
array<string, mixed>

toArray()

Renders this object back to its wire form.

public toArray() : array<string, mixed>

§27.4 rule 5: a null property is OMITTED, not emitted as null. On a sparse update those two say opposite things — "leave this alone" versus "set this to nothing" — and only omission means the first.

Return values
array<string, mixed>
On this page

Search results