CreateConnectionSAMLOptions
in package
implements
JsonSerializable
uses
JsonSerializableTrait
Table of Contents
Interfaces
- JsonSerializable
Properties
- $acsUrl : string|null
- A custom Assertion Consumer Service (ACS) URL override. When omitted, the standard WorkOS-generated ACS URL is used.
- $idpEntityId : string|null
- The Identity Provider Entity ID.
- $idpMetadataUrl : string|null
- The Identity Provider metadata URL. When provided, the IdP fields and signing certificates are imported from the metadata document. Mutually exclusive with the manual IdP fields.
- $idpSigningCerts : array<string|int, string>|null
- The X.509 certificates used to verify signed SAML responses from the Identity Provider. Required when configuring the connection with manual IdP fields.
- $idpSSOUrl : string|null
- The Identity Provider SSO URL. Required when configuring the connection with manual IdP fields.
- $spEncryptionKeyPairs : array<string|int, CreateConnectionKeyPair>|null
- The customer-owned key pairs used to decrypt encrypted SAML responses from the Identity Provider. When omitted, WorkOS generates and manages the encryption key pair.
- $spEntityId : string|null
- A custom Service Provider Entity ID (audience) override. When omitted, the connection external key is used.
- $spSigningKeyPair : CreateConnectionKeyPair|null
- The customer-owned key pair used to sign SAML requests sent to the Identity Provider. When omitted, WorkOS generates and manages the signing key pair.
Methods
- __construct() : mixed
- fromArray() : self
- jsonSerialize() : array<string|int, mixed>
- toArray() : array<string|int, mixed>
Properties
$acsUrl
A custom Assertion Consumer Service (ACS) URL override. When omitted, the standard WorkOS-generated ACS URL is used.
public
string|null
$acsUrl
= null
$idpEntityId
The Identity Provider Entity ID.
public
string|null
$idpEntityId
= null
$idpMetadataUrl
The Identity Provider metadata URL. When provided, the IdP fields and signing certificates are imported from the metadata document. Mutually exclusive with the manual IdP fields.
public
string|null
$idpMetadataUrl
= null
$idpSigningCerts
The X.509 certificates used to verify signed SAML responses from the Identity Provider. Required when configuring the connection with manual IdP fields.
public
array<string|int, string>|null
$idpSigningCerts
= null
$idpSSOUrl
The Identity Provider SSO URL. Required when configuring the connection with manual IdP fields.
public
string|null
$idpSSOUrl
= null
$spEncryptionKeyPairs
The customer-owned key pairs used to decrypt encrypted SAML responses from the Identity Provider. When omitted, WorkOS generates and manages the encryption key pair.
public
array<string|int, CreateConnectionKeyPair>|null
$spEncryptionKeyPairs
= null
$spEntityId
A custom Service Provider Entity ID (audience) override. When omitted, the connection external key is used.
public
string|null
$spEntityId
= null
$spSigningKeyPair
The customer-owned key pair used to sign SAML requests sent to the Identity Provider. When omitted, WorkOS generates and manages the signing key pair.
public
CreateConnectionKeyPair|null
$spSigningKeyPair
= null
Methods
__construct()
public
__construct([string|null $idpMetadataUrl = null ][, string|null $acsUrl = null ][, string|null $spEntityId = null ][, string|null $idpEntityId = null ][, string|null $idpSSOUrl = null ][, array<string|int, mixed>|null $idpSigningCerts = null ][, CreateConnectionKeyPair|null $spSigningKeyPair = null ][, array<string|int, mixed>|null $spEncryptionKeyPairs = null ]) : mixed
Parameters
- $idpMetadataUrl : string|null = null
- $acsUrl : string|null = null
- $spEntityId : string|null = null
- $idpEntityId : string|null = null
- $idpSSOUrl : string|null = null
- $idpSigningCerts : array<string|int, mixed>|null = null
- $spSigningKeyPair : CreateConnectionKeyPair|null = null
- $spEncryptionKeyPairs : array<string|int, mixed>|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>