AXIAM PHP SDK

ManagedBy : string
in package

Who created a client registration (D5, T21.4). The discriminator that separates a registration an administrator made from one that arrived over an open endpoint. Three things read it and each would otherwise have to infer provenance from something that is not provenance: * `axiam_oauth2::fapi` refuses a FAPI profile on anything but [`Admin`](Self::Admin) (I5) — a client nobody vetted cannot be financial-grade; * the authorization endpoint forces a consent hop for every other value (D4) — an unrelated party gets a question put to the end user, whatever scopes it asked for; * the T21.4 sweeper deletes only [`Dcr`](Self::Dcr) rows, so an administrator's client is never swept however long it sits unused. [`Admin`](Self::Admin) is the serde default and therefore what every row written before T21.4 decodes to, which is the truth: they were all created through `POST /oauth2-clients` by somebody holding `oauth2_clients:create`.

An open enum. A value this SDK's copy of the spec does not list decodes to self::Unknown rather than failing the response it arrived in (CONTRACT.md §27.11 rule 1). Its own wire spelling is the empty string, which no server value is, so carrying an unrecognised value back into an update is refused by the server rather than written as a spelling it never used. A match over these cases needs an Unknown arm.

Table of Contents

Cases

Admin  = 'admin'
The wire value `admin`.
Cimd  = 'cimd'
The wire value `cimd`.
Dcr  = 'dcr'
The wire value `dcr`.
Unknown  = ''
A value this SDK's copy of the spec does not list; see the type's summary.

Methods

fromWire()  : self
Parses a wire value into a ManagedBy, mapping an unrecognised one to {@see self::Unknown}.
toWire()  : string
The wire spelling of this case, for a request body.

Cases

Unknown

A value this SDK's copy of the spec does not list; see the type's summary.

Methods

fromWire()

Parses a wire value into a ManagedBy, mapping an unrecognised one to {@see self::Unknown}.

public static fromWire(string $value) : self

Never throws. A parse error here would fail the whole response the value arrived in, so one unrecognised field of one record would take down the page it was on (§27.11 rule 1). A match over this enum needs an Unknown arm.

Parameters
$value : string
Return values
self

toWire()

The wire spelling of this case, for a request body.

public toWire() : string

self::Unknown has none: it stands for a value this SDK never saw, and sending it back as the empty string would leave the refusal to the server. It raises a ValidationError here instead, before any request is made (CONTRACT.md §34.2 P12.2(a)). Use ->value to render for a log line.

Tags
throws
ValidationError

when this is Unknown.

Return values
string
On this page

Search results