mirror of
https://github.com/LukeHagar/clerk-sdk-java.git
synced 2025-12-07 04:19:27 +00:00
16 lines
5.7 KiB
Markdown
16 lines
5.7 KiB
Markdown
# CreateSAMLConnectionRequestBody
|
|
|
|
|
|
## Fields
|
|
|
|
| Field | Type | Required | Description |
|
|
| ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
|
|
| `name` | *String* | :heavy_check_mark: | The name to use as a label for this SAML Connection |
|
|
| `domain` | *String* | :heavy_check_mark: | The domain of your organization. Sign in flows using an email with this domain, will use this SAML Connection. |
|
|
| `provider` | [com.clerk.backend_api.models.operations.Provider](../../models/operations/Provider.md) | :heavy_check_mark: | The IdP provider of the connection. |
|
|
| `idpEntityId` | *JsonNullable<? extends String>* | :heavy_minus_sign: | The Entity ID as provided by the IdP |
|
|
| `idpSsoUrl` | *JsonNullable<? extends String>* | :heavy_minus_sign: | The Single-Sign On URL as provided by the IdP |
|
|
| `idpCertificate` | *JsonNullable<? extends String>* | :heavy_minus_sign: | The X.509 certificate as provided by the IdP |
|
|
| `idpMetadataUrl` | *JsonNullable<? extends String>* | :heavy_minus_sign: | The URL which serves the IdP metadata. If present, it takes priority over the corresponding individual properties |
|
|
| `idpMetadata` | *JsonNullable<? extends String>* | :heavy_minus_sign: | The XML content of the IdP metadata file. If present, it takes priority over the corresponding individual properties |
|
|
| `attributeMapping` | [JsonNullable<? extends com.clerk.backend_api.models.operations.AttributeMapping>](../../models/operations/AttributeMapping.md) | :heavy_minus_sign: | Define the attribute name mapping between Identity Provider and Clerk's user properties | |