| Field | Type | Required | Description | Example |
|---|---|---|---|---|
Name |
string | ➖ | The name of the new SAML Connection | Example SAML Connection |
Domain |
string | ➖ | The domain to use for the new SAML Connection | example.com |
IdpEntityId |
string | ➖ | The entity id as provided by the IdP | entity_123 |
IdpSsoUrl |
string | ➖ | The SSO url as provided by the IdP | https://idp.example.com/sso |
IdpCertificate |
string | ➖ | The x509 certificated as provided by the IdP | MIIDBTCCAe2gAwIBAgIQ... |
IdpMetadataUrl |
string | ➖ | The URL which serves the IdP metadata. If present, it takes priority over the corresponding individual properties and replaces them | https://idp.example.com/metadata |
IdpMetadata |
string | ➖ | The XML content of the IdP metadata file. If present, it takes priority over the corresponding individual properties | ... |
OrganizationId |
string | ➖ | The ID of the organization to which users of this SAML Connection will be added | |
AttributeMapping |
UpdateSAMLConnectionAttributeMapping | ➖ | Define the atrtibute name mapping between Identity Provider and Clerk's user properties | |
Active |
bool | ➖ | Activate or de-activate the SAML Connection | true |
SyncUserAttributes |
bool | ➖ | Controls whether to update the user's attributes in each sign-in | false |
AllowSubdomains |
bool | ➖ | Allow users with an email address subdomain to use this connection in order to authenticate | true |
AllowIdpInitiated |
bool | ➖ | Enable or deactivate IdP-initiated flows | false |
DisableAdditionalIdentifications |
bool | ➖ | Enable or deactivate additional identifications |