AXIAM PHP SDK

FederationProvider
in package

FinalYes

One sign-in button (wire schema `PublicFederationProvider`, CONTRACT.md §12.1, contract 1.38).

This is an unauthenticated response and carries only what a button needs. There is no client_id, no metadata_url, no endpoint URL and no secret — absent by construction rather than filtered out — and §12.1 note 9 forbids an SDK from expecting one.

Table of Contents

Constants

PROTOCOL_OAUTH2  : mixed = 'OAuth2'
`protocol` value selecting `ssoStartOauth2` (§12.1 note 10).
PROTOCOL_OIDC_CONNECT  : mixed = 'OidcConnect'
`protocol` value selecting `ssoStart` (§12.1 note 10).
PROTOCOL_SAML  : mixed = 'Saml'
`protocol` value selecting the SAML login endpoint, which is **not** a §12 vocabulary operation (§12.1 note 10).

Properties

$buttonIcon  : string|null
$displayName  : string
$hasBundledMark  : bool
$id  : string
$inherited  : bool
$protocol  : string
$providerKind  : string

Methods

__construct()  : mixed

Constants

PROTOCOL_OAUTH2

`protocol` value selecting `ssoStartOauth2` (§12.1 note 10).

public mixed PROTOCOL_OAUTH2 = 'OAuth2'

PROTOCOL_OIDC_CONNECT

`protocol` value selecting `ssoStart` (§12.1 note 10).

public mixed PROTOCOL_OIDC_CONNECT = 'OidcConnect'

PROTOCOL_SAML

`protocol` value selecting the SAML login endpoint, which is **not** a §12 vocabulary operation (§12.1 note 10).

public mixed PROTOCOL_SAML = 'Saml'

Properties

Methods

__construct()

public __construct(string $id, string $providerKind, string $displayName, string $protocol, bool $hasBundledMark, bool $inherited[, string|null $buttonIcon = null ]) : mixed
Parameters
$id : string

Config id, echoed back to the matching start operation. Pass it through unmodified: inheritance is resolved server-side (§12.1 note 13) and this id is how the server is told what resolution produced.

$providerKind : string

Which provider this is, for the button's branding — google, github, generic_oidc, … Not what selects the start operation; see $protocol.

$displayName : string

The operator's display name for the provider.

$protocol : string

OidcConnect, Saml or OAuth2 — the value that selects which start operation to call (§12.1 note 10). Kept as the wire string rather than narrowed to an enum: the server owns this vocabulary, and a value added server-side must not become a parse failure for the whole list. An OAuth2 provider issues no ID token (§12.1 note 11), a distinction a surface rendering these buttons SHOULD make visible.

$hasBundledMark : bool

Whether AXIAM ships this provider's own sign-in mark, which its button must then use. false for the generic kinds, whose buttons read "Sign in with $displayName" and use $buttonIcon where one was uploaded.

$inherited : bool

true when the provider is inherited from the organization rather than configured on this tenant (§12.1 note 13). Informational — it is not needed to sign in, and nothing in this SDK computes it.

$buttonIcon : string|null = null

The operator's uploaded button icon as a bounded raster data: URL, or null — which is the case for most providers.

On this page

Search results