| Field | Type | Required | Description | Example |
|---|---|---|---|---|
name |
str | ✔️ | The name to use as a label for this SAML Connection | My SAML Connection |
domain |
str | ✔️ | The domain of your organization. Sign in flows using an email with this domain, will use this SAML Connection. | example.org |
provider |
models.Provider | ✔️ | The IdP provider of the connection. | saml_custom |
idp_entity_id |
OptionalNullable[str] | ➖ | The Entity ID as provided by the IdP | http://idp.example.org/ |
idp_sso_url |
OptionalNullable[str] | ➖ | The Single-Sign On URL as provided by the IdP | http://idp.example.org/sso |
idp_certificate |
OptionalNullable[str] | ➖ | The X.509 certificate as provided by the IdP | MIIDdzCCAl+gAwIBAgIJAKcyBaiiz+DT... |
idp_metadata_url |
OptionalNullable[str] | ➖ | The URL which serves the IdP metadata. If present, it takes priority over the corresponding individual properties | http://idp.example.org/metadata.xml |
idp_metadata |
OptionalNullable[str] | ➖ | The XML content of the IdP metadata file. If present, it takes priority over the corresponding individual properties | <EntityDescriptor ... |
attribute_mapping |
OptionalNullable[models.CreateSAMLConnectionAttributeMapping] | ➖ | Define the attribute name mapping between Identity Provider and Clerk's user properties |