Connection
in package
implements
JsonSerializable
uses
JsonSerializableTrait
Read onlyYes
Table of Contents
Interfaces
- JsonSerializable
Properties
- $connectionType : ConnectionType
- The type of the SSO Connection used to authenticate the user. The Connection type may be used to dynamically generate authorization URLs.
- $createdAt : DateTimeImmutable
- An ISO 8601 timestamp.
- $domains : array<string|int, ConnectionDomain>
- List of Organization Domains.
- $id : string
- Unique identifier for the Connection.
- $name : string
- A human-readable name for the Connection. This will most commonly be the organization's name.
- $object : string
- Distinguishes the Connection object.
- $options : ConnectionOption|null
- Configuration options for SAML connections. Only present for SAML connection types.
- $organizationId : string|null
- Unique identifier for the Organization in which the Connection resides.
- $state : ConnectionState
- Indicates whether a Connection is able to authenticate users.
- $status : ConnectionStatus
- Deprecated. Use `state` instead.
- $updatedAt : DateTimeImmutable
- An ISO 8601 timestamp.
Methods
- __construct() : mixed
- fromArray() : self
- jsonSerialize() : array<string|int, mixed>
- toArray() : array<string|int, mixed>
Properties
$connectionType
The type of the SSO Connection used to authenticate the user. The Connection type may be used to dynamically generate authorization URLs.
public
ConnectionType
$connectionType
$createdAt
An ISO 8601 timestamp.
public
DateTimeImmutable
$createdAt
$domains
List of Organization Domains.
public
array<string|int, ConnectionDomain>
$domains
$id
Unique identifier for the Connection.
public
string
$id
$name
A human-readable name for the Connection. This will most commonly be the organization's name.
public
string
$name
$object
Distinguishes the Connection object.
public
string
$object
$options
Configuration options for SAML connections. Only present for SAML connection types.
public
ConnectionOption|null
$options
= null
$organizationId
Unique identifier for the Organization in which the Connection resides.
public
string|null
$organizationId
= null
$state
Indicates whether a Connection is able to authenticate users.
public
ConnectionState
$state
$status
Deprecated. Use `state` instead.
public
ConnectionStatus
$status
$updatedAt
An ISO 8601 timestamp.
public
DateTimeImmutable
$updatedAt
Methods
__construct()
public
__construct(string $object, string $id, ConnectionType $connectionType, string $name, ConnectionState $state, ConnectionStatus $status, array<string|int, mixed> $domains, DateTimeImmutable $createdAt, DateTimeImmutable $updatedAt[, string|null $organizationId = null ][, ConnectionOption|null $options = null ]) : mixed
Parameters
- $object : string
- $id : string
- $connectionType : ConnectionType
- $name : string
- $state : ConnectionState
- $status : ConnectionStatus
- $domains : array<string|int, mixed>
- $createdAt : DateTimeImmutable
- $updatedAt : DateTimeImmutable
- $organizationId : string|null = null
- $options : ConnectionOption|null = null
fromArray()
public
static fromArray(array<string|int, mixed> $data) : self
Parameters
- $data : array<string|int, mixed>
Return values
selfjsonSerialize()
public
jsonSerialize() : array<string|int, mixed>
Return values
array<string|int, mixed>toArray()
public
toArray() : array<string|int, mixed>