FederationProviderList
in package
FinalYes
The result of `ssoProviders` (wire schema `PublicFederationProvidersResponse`, CONTRACT.md §12.1).
An empty $providers is a normal success, never an error (§12.1 note 9).
An unknown organization, a known one with nothing configured, and a request
naming no workspace at all all answer 200 this way, precisely so the endpoint
cannot be used to enumerate organization or tenant slugs.
Table of Contents
Constants
- HANDOFF_CODE_TTL_SECONDS : mixed = 60
- How long a handoff code is valid, in seconds (§12.1 note 12). It exists to survive one redirect. Redeem it immediately, once.
- HANDOFF_QUERY_PARAM : mixed = 'axiam_handoff'
- The query parameter the server delivers a handoff code in, on the SPA's own callback URL (§12.1 note 12).
Properties
- $providers : array<string|int, mixed>
Methods
- __construct() : mixed
Constants
HANDOFF_CODE_TTL_SECONDS
How long a handoff code is valid, in seconds (§12.1 note 12). It exists to survive one redirect. Redeem it immediately, once.
public
mixed
HANDOFF_CODE_TTL_SECONDS
= 60
HANDOFF_QUERY_PARAM
The query parameter the server delivers a handoff code in, on the SPA's own callback URL (§12.1 note 12).
public
mixed
HANDOFF_QUERY_PARAM
= 'axiam_handoff'
Properties
$providers read-only
public
array<string|int, mixed>
$providers
Methods
__construct()
public
__construct(array<int, FederationProvider> $providers) : mixed
Parameters
- $providers : array<int, FederationProvider>
-
The providers to offer, in a stable server-defined order.