AXIAM PHP SDK

OAuth2ClientResponse
in package
implements JsonSerializable

FinalYes

OAuth2 client response -- omits client_secret_hash.

Table of Contents

Interfaces

JsonSerializable

Properties

$clientId  : string
$createdAt  : string
$dpopBoundAccessTokens  : bool
$dpopRequireNonce  : bool
$grantTypes  : array<string|int, mixed>
$id  : string
$jwks  : string|null
$jwksUri  : string|null
$name  : string
$profile  : ClientProfile
$redirectUris  : array<string|int, mixed>
$requirePar  : bool
$scopes  : array<string|int, mixed>
$selfSignedTlsClientAuthThumbprints  : array<string|int, mixed>
$tenantId  : string
$tlsClientAuthSanDns  : string|null
$tlsClientAuthSanUri  : string|null
$tlsClientAuthSubjectDn  : string|null
$tlsClientCertificateBoundAccessTokens  : bool
$tokenEndpointAuthMethod  : ClientAuthMethod
$updatedAt  : string

Methods

__construct()  : mixed
Constructs a OAuth2ClientResponse.
fromArray()  : self
Rebuilds a OAuth2ClientResponse 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

$selfSignedTlsClientAuthThumbprints read-only

public array<string|int, mixed> $selfSignedTlsClientAuthThumbprints

$tlsClientCertificateBoundAccessTokens read-only

public bool $tlsClientCertificateBoundAccessTokens

Methods

__construct()

Constructs a OAuth2ClientResponse.

public __construct(string $clientId, string $createdAt, bool $dpopBoundAccessTokens, bool $dpopRequireNonce, array<int, string> $grantTypes, string $id, string $name, ClientProfile $profile, array<int, string> $redirectUris, bool $requirePar, array<int, string> $scopes, array<int, string> $selfSignedTlsClientAuthThumbprints, string $tenantId, bool $tlsClientCertificateBoundAccessTokens, ClientAuthMethod $tokenEndpointAuthMethod, string $updatedAt[, string|null $jwks = null ][, string|null $jwksUri = null ][, string|null $tlsClientAuthSanDns = null ][, string|null $tlsClientAuthSanUri = null ][, string|null $tlsClientAuthSubjectDn = null ]) : mixed
Parameters
$clientId : string

the server's client_id field

$createdAt : string

the server's created_at field

$dpopBoundAccessTokens : bool

the server's dpop_bound_access_tokens field

$dpopRequireNonce : bool

the server's dpop_require_nonce 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

$profile : ClientProfile

X5.1 — the registered posture and mTLS credentials. Read-back matters: an operator auditing which clients are financial-grade should be able to answer it from this endpoint rather than from the database.

$redirectUris : array<int, string>

the server's redirect_uris field

$requirePar : bool

the server's require_par field

$scopes : array<int, string>

the server's scopes field

$selfSignedTlsClientAuthThumbprints : array<int, string>

the server's self_signed_tls_client_auth_thumbprints field

$tenantId : string

the server's tenant_id field

$tlsClientCertificateBoundAccessTokens : bool

the server's tls_client_certificate_bound_access_tokens field

$tokenEndpointAuthMethod : ClientAuthMethod

the server's token_endpoint_auth_method field

$updatedAt : string

the server's updated_at field

$jwks : string|null = null

X5.1 — echoed so an operator can confirm which key source is registered. The document itself is public key material, so returning it leaks nothing; a jwks_uri is likewise public by construction. (optional)

$jwksUri : string|null = null

the server's jwks_uri field (optional)

$tlsClientAuthSanDns : string|null = null

the server's tls_client_auth_san_dns field (optional)

$tlsClientAuthSanUri : string|null = null

the server's tls_client_auth_san_uri field (optional)

$tlsClientAuthSubjectDn : string|null = null

the server's tls_client_auth_subject_dn field (optional)

fromArray()

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