CreateConnection
in package
implements
JsonSerializable
uses
JsonSerializableTrait
Read onlyYes
Table of Contents
Interfaces
- JsonSerializable
Properties
- $attributeMaps : CreateConnectionAttributeMaps|null
- How IdP attributes or claims map onto WorkOS profile fields. Provided fields override the defaults for the connection type.
- $connectionType : string|null
- The type of the Connection. Only SAML and OIDC connection types may be created. When omitted, the type is inferred from the provided options.
- $externalId : string|null
- The customer-owned identifier for the Connection.
- $name : string|null
- A human-readable name for the Connection. This will most commonly be the organization's name.
- $oidcOptions : CreateConnectionOIDCOptions|null
- Protocol configuration for OIDC connections. Mutually exclusive with `saml_options`.
- $organizationId : string
- Unique identifier for the Organization in which the Connection resides.
- $samlOptions : CreateConnectionSAMLOptions|null
- Protocol configuration for SAML connections. Mutually exclusive with `oidc_options`.
Methods
- __construct() : mixed
- fromArray() : self
- jsonSerialize() : array<string|int, mixed>
- toArray() : array<string|int, mixed>
Properties
$attributeMaps
How IdP attributes or claims map onto WorkOS profile fields. Provided fields override the defaults for the connection type.
public
CreateConnectionAttributeMaps|null
$attributeMaps
= null
$connectionType
The type of the Connection. Only SAML and OIDC connection types may be created. When omitted, the type is inferred from the provided options.
public
string|null
$connectionType
= null
$externalId
The customer-owned identifier for the Connection.
public
string|null
$externalId
= null
$name
A human-readable name for the Connection. This will most commonly be the organization's name.
public
string|null
$name
= null
$oidcOptions
Protocol configuration for OIDC connections. Mutually exclusive with `saml_options`.
public
CreateConnectionOIDCOptions|null
$oidcOptions
= null
$organizationId
Unique identifier for the Organization in which the Connection resides.
public
string
$organizationId
$samlOptions
Protocol configuration for SAML connections. Mutually exclusive with `oidc_options`.
public
CreateConnectionSAMLOptions|null
$samlOptions
= null
Methods
__construct()
public
__construct(string $organizationId[, string|null $name = null ][, string|null $externalId = null ][, string|null $connectionType = null ][, CreateConnectionAttributeMaps|null $attributeMaps = null ][, CreateConnectionSAMLOptions|null $samlOptions = null ][, CreateConnectionOIDCOptions|null $oidcOptions = null ]) : mixed
Parameters
- $organizationId : string
- $name : string|null = null
- $externalId : string|null = null
- $connectionType : string|null = null
- $attributeMaps : CreateConnectionAttributeMaps|null = null
- $samlOptions : CreateConnectionSAMLOptions|null = null
- $oidcOptions : CreateConnectionOIDCOptions|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>