| Field | Type | Required | Description |
|---|---|---|---|
name |
?string | ➖ | The name of the new SAML Connection |
domain |
?string | ➖ | The domain to use for the new SAML Connection |
idpEntityId |
?string | ➖ | The entity id as provided by the IdP |
idpSsoUrl |
?string | ➖ | The SSO url as provided by the IdP |
idpCertificate |
?string | ➖ | The x509 certificated as provided by the IdP |
idpMetadataUrl |
?string | ➖ | The URL which serves the IdP metadata. If present, it takes priority over the corresponding individual properties and replaces them |
idpMetadata |
?string | ➖ | The XML content of the IdP metadata file. If present, it takes priority over the corresponding individual properties |
attributeMapping |
?Operations\UpdateSAMLConnectionAttributeMapping | ➖ | Define the atrtibute name mapping between Identity Provider and Clerk's user properties |
active |
?bool | ➖ | Activate or de-activate the SAML Connection |
syncUserAttributes |
?bool | ➖ | Controls whether to update the user's attributes in each sign-in |
allowSubdomains |
?bool | ➖ | Allow users with an email address subdomain to use this connection in order to authenticate |
allowIdpInitiated |
?bool | ➖ | Enable or deactivate IdP-initiated flows |
disableAdditionalIdentifications |
?bool | ➖ | Enable or deactivate additional identifications |