AXIAM PHP SDK

SsfStream
in package

Application

implements JsonSerializable

FinalYes

A registered SSF stream, as the management API returns it. **The push `Authorization` header is never returned**; `authorization_header_set` says whether one is stored.

Interfaces

JsonSerializable

Properties

$audience : string
$authorizationHeaderSet : bool
$createdAt : string
$deliveryMethod : SsfDeliveryMethod
$description : string|null
$endpointUrl : string|null
$eventsAllowed : array<string|int, mixed>
$eventsDelivered : array<string|int, mixed>
$eventsRequested : array<string|int, mixed>
$id : string
$lastVerificationAt : string|null
$receiverClientId : string
$status : SsfStreamStatus
$statusActor : SsfStatusActor
$statusReason : string|null
$subjectFormat : SsfSubjectFormat
$tenantId : string
$transmitterActive : bool
$transmitterInactiveReason : string|null
$updatedAt : string

Methods

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

$audience read-only


        public
            string
    $audience

$authorizationHeaderSet read-only


        public
            bool
    $authorizationHeaderSet

$createdAt read-only


        public
            string
    $createdAt

$deliveryMethod read-only


        public
            SsfDeliveryMethod
    $deliveryMethod

$description read-only


        public
            string|null
    $description
     = null

$endpointUrl read-only


        public
            string|null
    $endpointUrl
     = null

$eventsAllowed read-only


        public
            array<string|int, mixed>
    $eventsAllowed

$eventsDelivered read-only


        public
            array<string|int, mixed>
    $eventsDelivered

$eventsRequested read-only


        public
            array<string|int, mixed>
    $eventsRequested

$id read-only


        public
            string
    $id

$lastVerificationAt read-only


        public
            string|null
    $lastVerificationAt
     = null

$receiverClientId read-only


        public
            string
    $receiverClientId

$status read-only


        public
            SsfStreamStatus
    $status

$statusActor read-only


        public
            SsfStatusActor
    $statusActor

$statusReason read-only


        public
            string|null
    $statusReason
     = null

$subjectFormat read-only


        public
            SsfSubjectFormat
    $subjectFormat

$tenantId read-only


        public
            string
    $tenantId

$transmitterActive read-only


        public
            bool
    $transmitterActive

$transmitterInactiveReason read-only


        public
            string|null
    $transmitterInactiveReason
     = null

$updatedAt read-only


        public
            string
    $updatedAt

__construct()

Constructs a SsfStream.


    public
                    __construct(string $audience, bool $authorizationHeaderSet, string $createdAt, SsfDeliveryMethod $deliveryMethod, array<int, SsfEventType|string> $eventsAllowed, array<int, SsfEventType|string> $eventsDelivered, array<int, SsfEventType|string> $eventsRequested, string $id, string $receiverClientId, SsfStreamStatus $status, SsfStatusActor $statusActor, SsfSubjectFormat $subjectFormat, string $tenantId, bool $transmitterActive, string $updatedAt[, string|null $description = null ][, string|null $endpointUrl = null ][, string|null $lastVerificationAt = null ][, string|null $statusReason = null ][, string|null $transmitterInactiveReason = null ]) : mixed

Parameters

$audience : string: The SET aud. Unique across the deployment.
$authorizationHeaderSet : bool: Whether a push Authorization header is stored.
$createdAt : string: When the stream was registered.
$deliveryMethod : SsfDeliveryMethod: push (RFC 8935) or poll (RFC 8936).
$eventsAllowed : array<int, SsfEventType|string>: The event types the receiver may have.
$eventsDelivered : array<int, SsfEventType|string>: What the stream carries: the intersection of the two.
$eventsRequested : array<int, SsfEventType|string>: The event types the receiver asked for (a subset of events_allowed).
$id : string: The stream id, also the SSF stream_id.
$receiverClientId : string: The OAuth2 client_id whose client-credentials token (scope ssf.manage) is this stream's receiver on the stream management API.
$status : SsfStreamStatus: enabled, paused or disabled.
$statusActor : SsfStatusActor: Who set the status: admin or receiver.
$subjectFormat : SsfSubjectFormat: iss_sub (default) or email.
$tenantId : string: The owning tenant.
$transmitterActive : bool: Whether the tenant's transmitter is active: its ssf_enabled is on and the deployment does not make every tenant share one issuer (D-55). A stream of an inactive transmitter is kept, and carries nothing.
$updatedAt : string: When it was last written.
$description : string|null = null: A description. (optional)
$endpointUrl : string|null = null: The push endpoint, or null for a poll stream. (optional)
$lastVerificationAt : string|null = null: When the receiver last asked for a verification event, or null. (optional)
$statusReason : string|null = null: Why, if anyone said. (optional)
$transmitterInactiveReason : string|null = null: Why the transmitter is inactive, when it is. (optional)

fromArray()

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

SsfStream in package Application implements JsonSerializable

Table of Contents

Interfaces

Properties

Methods

Properties

$audience read-only

$authorizationHeaderSet read-only

$createdAt read-only

$deliveryMethod read-only

$description read-only

$endpointUrl read-only

$eventsAllowed read-only

$eventsDelivered read-only

$eventsRequested read-only

$id read-only

$lastVerificationAt read-only

$receiverClientId read-only

$status read-only

$statusActor read-only

$statusReason read-only

$subjectFormat read-only

$tenantId read-only

$transmitterActive read-only

$transmitterInactiveReason read-only

$updatedAt read-only

Methods

__construct()

Parameters

fromArray()

Parameters

Return values

jsonSerialize()

Return values

toArray()

Return values

unknownEnumValue()

Parameters

Return values

SsfStream
in package

Application

implements JsonSerializable