| Field | Type | Required | Description |
|---|---|---|---|
name |
JsonNullable<String> | ➖ | The name of the new SAML Connection |
domain |
JsonNullable<String> | ➖ | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. The domain to use for the new SAML Connection |
domains |
List<String> | ➖ | A list of the domains on use for the SAML connection |
idpEntityId |
JsonNullable<String> | ➖ | The Entity ID as provided by the IdP |
idpSsoUrl |
JsonNullable<String> | ➖ | The SSO URL as provided by the IdP |
idpCertificate |
JsonNullable<String> | ➖ | The x509 certificated as provided by the IdP |
idpMetadataUrl |
JsonNullable<String> | ➖ | The URL which serves the IdP metadata. If present, it takes priority over the corresponding individual properties and replaces them |
idpMetadata |
JsonNullable<String> | ➖ | The XML content of the IdP metadata file. If present, it takes priority over the corresponding individual properties |
organizationId |
JsonNullable<String> | ➖ | The ID of the organization to which users of this SAML Connection will be added |
attributeMapping |
JsonNullable<AttributeMapping> | ➖ | Define the attribute name mapping between Identity Provider and Clerk's user properties |
active |
JsonNullable<Boolean> | ➖ | Activate or de-activate the SAML Connection |
syncUserAttributes |
JsonNullable<Boolean> | ➖ | Controls whether to update the user's attributes in each sign-in |
allowSubdomains |
JsonNullable<Boolean> | ➖ | Allow users with an email address subdomain to use this connection in order to authenticate |
allowIdpInitiated |
JsonNullable<Boolean> | ➖ | Enable or deactivate IdP-initiated flows |
disableAdditionalIdentifications |
JsonNullable<Boolean> | ➖ | Enable or deactivate additional identifications |
allowOrganizationAccountLinking |
JsonNullable<Boolean> | ➖ | Whether this connection supports account linking via organization membership |
forceAuthn |
Optional<Boolean> | ➖ | Enable or deactivate ForceAuthn |
consentVerifiedDomainsDeletion |
JsonNullable<Boolean> | ➖ | When enabling the connection, controls behavior when verified domains used for enrollment modes like automatic invitation or automatic suggestion already exist for the same domain. If true, those verified domains are removed and the connection is enabled. If false or omitted, the request fails when any such verified domain exists. |