AXIAM PHP SDK

UpdateOAuth2ClientRequest
in package
implements JsonSerializable

FinalYes

The `UpdateOAuth2ClientRequest` schema from the server's OpenAPI document.

Every property is optional, so this is a SPARSE body: what you leave unset is left unchanged, and is omitted from the wire request entirely rather than sent as null (§27.4 rule 5).

Table of Contents

Interfaces

JsonSerializable

Properties

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

Methods

__construct()  : mixed
Constructs a UpdateOAuth2ClientRequest.
fromArray()  : self
Rebuilds a UpdateOAuth2ClientRequest 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>|null $selfSignedTlsClientAuthThumbprints = null

$tlsClientCertificateBoundAccessTokens read-only

public bool|null $tlsClientCertificateBoundAccessTokens = null

Methods

__construct()

Constructs a UpdateOAuth2ClientRequest.

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

Pass an empty string to clear a previously registered URI — the one edit an operator makes when an RP is decommissioned. (optional)

$dpopBoundAccessTokens : bool|null = null

the server's dpop_bound_access_tokens field (optional)

$dpopRequireNonce : bool|null = null

the server's dpop_require_nonce field (optional)

$grantTypes : array<int, string>|null = null

the server's grant_types field (optional)

$jwks : string|null = null

X5.1 — see the create DTO. Some("") clears, so a client can be migrated from an inline key set to a published one. (optional)

$jwksUri : string|null = null

X5.1 — see the create DTO. Some("") clears. (optional)

$name : string|null = null

the server's name field (optional)

$postLogoutRedirectUris : array<int, string>|null = null

the server's post_logout_redirect_uris field (optional)

$profile : ClientProfile|null = null

the server's profile field (optional)

$redirectUris : array<int, string>|null = null

the server's redirect_uris field (optional)

$requirePar : bool|null = null

the server's require_par field (optional)

$scopes : array<int, string>|null = null

the server's scopes field (optional)

$selfSignedTlsClientAuthThumbprints : array<int, string>|null = null

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

Pass an empty string to clear, as with backchannel_logout_uri. (optional)

$tlsClientCertificateBoundAccessTokens : bool|null = null

the server's tls_client_certificate_bound_access_tokens field (optional)

$tokenEndpointAuthMethod : ClientAuthMethod|null = null

the server's token_endpoint_auth_method field (optional)

fromArray()

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