AXIAM PHP SDK

UpdateOAuth2ClientRequest
in package

Application

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).

Interfaces

JsonSerializable

Properties

$allowedResources : array<string|int, mixed>|null
$authnRequestParams : AuthnRequestParamsMode|null
$backchannelAuthenticationRequestSigningAlg : string|null
$backchannelClientNotificationEndpoint : string|null
$backchannelLogoutUri : string|null
$backchannelTokenDeliveryMode : string|null
$backchannelUserCodeParameter : bool|null
$browserSso : bool|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.
unknownEnumValue() : string|null: The string the server sent for an open-enum member this SDK has no name for, or `null`.

$allowedResources read-only


        public
            array<string|int, mixed>|null
    $allowedResources
     = null

$authnRequestParams read-only


        public
            AuthnRequestParamsMode|null
    $authnRequestParams
     = null

$backchannelAuthenticationRequestSigningAlg read-only


        public
            string|null
    $backchannelAuthenticationRequestSigningAlg
     = null

$backchannelClientNotificationEndpoint read-only


        public
            string|null
    $backchannelClientNotificationEndpoint
     = null

$backchannelLogoutUri read-only


        public
            string|null
    $backchannelLogoutUri
     = null

$backchannelTokenDeliveryMode read-only


        public
            string|null
    $backchannelTokenDeliveryMode
     = null

$backchannelUserCodeParameter read-only


        public
            bool|null
    $backchannelUserCodeParameter
     = null

$browserSso read-only


        public
            bool|null
    $browserSso
     = null

$dpopBoundAccessTokens read-only


        public
            bool|null
    $dpopBoundAccessTokens
     = null

$dpopRequireNonce read-only


        public
            bool|null
    $dpopRequireNonce
     = null

$grantTypes read-only


        public
            array<string|int, mixed>|null
    $grantTypes
     = null

$jwks read-only


        public
            string|null
    $jwks
     = null

$jwksUri read-only


        public
            string|null
    $jwksUri
     = null

$name read-only


        public
            string|null
    $name
     = null

$postLogoutRedirectUris read-only


        public
            array<string|int, mixed>|null
    $postLogoutRedirectUris
     = null

$profile read-only


        public
            ClientProfile|null
    $profile
     = null

$redirectUris read-only


        public
            array<string|int, mixed>|null
    $redirectUris
     = null

$requirePar read-only


        public
            bool|null
    $requirePar
     = null

$scopes read-only


        public
            array<string|int, mixed>|null
    $scopes
     = null

$selfSignedTlsClientAuthThumbprints read-only


        public
            array<string|int, mixed>|null
    $selfSignedTlsClientAuthThumbprints
     = null

$tlsClientAuthSanDns read-only


        public
            string|null
    $tlsClientAuthSanDns
     = null

$tlsClientAuthSanUri read-only


        public
            string|null
    $tlsClientAuthSanUri
     = null

$tlsClientAuthSubjectDn read-only


        public
            string|null
    $tlsClientAuthSubjectDn
     = null

$tlsClientCertificateBoundAccessTokens read-only


        public
            bool|null
    $tlsClientCertificateBoundAccessTokens
     = null

$tokenEndpointAuthMethod read-only


        public
            ClientAuthMethod|null
    $tokenEndpointAuthMethod
     = null

__construct()

Constructs a UpdateOAuth2ClientRequest.


    public
                    __construct([array<int, string>|null $allowedResources = null ][, AuthnRequestParamsMode|null $authnRequestParams = null ][, string|null $backchannelAuthenticationRequestSigningAlg = null ][, string|null $backchannelClientNotificationEndpoint = null ][, string|null $backchannelLogoutUri = null ][, string|null $backchannelTokenDeliveryMode = null ][, bool|null $backchannelUserCodeParameter = null ][, bool|null $browserSso = 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

$allowedResources : array<int, string>|null = null: T21.3 — see [CreateOAuth2ClientRequest::allowed_resources]. A whole-list replacement; [] withdraws every target. (optional)
$authnRequestParams : AuthnRequestParamsMode|null = null: the server's authn_request_params field (optional)
$backchannelAuthenticationRequestSigningAlg : string|null = null: G-7 — see the create DTO. "" clears. (optional)
$backchannelClientNotificationEndpoint : string|null = null: G-7 — see the create DTO. "" clears. (optional)
$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. Any other value is held to the same rule as on create. (optional)
$backchannelTokenDeliveryMode : string|null = null: G-7 — see the create DTO. "" clears. (optional)
$backchannelUserCodeParameter : bool|null = null: G-7 — true refused, as on create. (optional)
$browserSso : bool|null = null: X7.3 — see [CreateOAuth2ClientRequest::browser_sso]. (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: Replace the client's scopes. On a managed_by: dcr | cimd client a scope the request adds that is outside the tenant's effective dcr_allowed_scopes is refused with 422 (#636); an administrator-managed client is not bounded. (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).

Rendering for a log line never fails: an unknown union arm renders its discriminator and an unrecognised enum value its empty Unknown spelling here, and only self::toArray() -- the request path -- refuses to send it (CONTRACT.md §31.2, §34.2 P12.2).

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>

unknownEnumValue()

The string the server sent for an open-enum member this SDK has no name for, or `null`.


    public
                    unknownEnumValue(string $wire) : string|null

Only a model decoded by self::fromArray() knows it, and only for a member that decoded to Unknown (CONTRACT.md §27.6.2 item 4, §34.8 (c)): it lets a refusal name the value. It is for messages -- it is never rendered by self::toArray() or self::jsonSerialize() and so is never sent.

Parameters

$wire : string: The member's wire name.

Return values

string|null

UpdateOAuth2ClientRequest in package Application implements JsonSerializable

Table of Contents

Interfaces

Properties

Methods

Properties

$allowedResources read-only

$authnRequestParams read-only

$backchannelAuthenticationRequestSigningAlg read-only

$backchannelClientNotificationEndpoint read-only

$backchannelLogoutUri read-only

$backchannelTokenDeliveryMode read-only

$backchannelUserCodeParameter read-only

$browserSso read-only

$dpopBoundAccessTokens read-only

$dpopRequireNonce read-only

$grantTypes read-only

$jwks read-only

$jwksUri read-only

$name read-only

$postLogoutRedirectUris read-only

$profile read-only

$redirectUris read-only

$requirePar read-only

$scopes read-only

$selfSignedTlsClientAuthThumbprints read-only

$tlsClientAuthSanDns read-only

$tlsClientAuthSanUri read-only

$tlsClientAuthSubjectDn read-only

$tlsClientCertificateBoundAccessTokens read-only

$tokenEndpointAuthMethod read-only

Methods

__construct()

Parameters

fromArray()

Parameters

Return values

jsonSerialize()

Return values

toArray()

Return values

unknownEnumValue()

Parameters

Return values

UpdateOAuth2ClientRequest
in package

Application

implements JsonSerializable