mirror of
https://github.com/LukeHagar/clerk-sdk-java.git
synced 2025-12-08 12:27:45 +00:00
19 lines
9.4 KiB
Markdown
19 lines
9.4 KiB
Markdown
# UpdateSAMLConnectionRequestBody
|
|
|
|
|
|
## Fields
|
|
|
|
| Field | Type | Required | Description |
|
|
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| `name` | *JsonNullable<? extends String>* | :heavy_minus_sign: | The name of the new SAML Connection |
|
|
| `domain` | *JsonNullable<? extends String>* | :heavy_minus_sign: | The domain to use for the new SAML Connection |
|
|
| `idpEntityId` | *JsonNullable<? extends String>* | :heavy_minus_sign: | The entity id as provided by the IdP |
|
|
| `idpSsoUrl` | *JsonNullable<? extends String>* | :heavy_minus_sign: | The SSO url as provided by the IdP |
|
|
| `idpCertificate` | *JsonNullable<? extends String>* | :heavy_minus_sign: | The x509 certificated 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 and replaces them |
|
|
| `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.UpdateSAMLConnectionAttributeMapping>](../../models/operations/UpdateSAMLConnectionAttributeMapping.md) | :heavy_minus_sign: | Define the atrtibute name mapping between Identity Provider and Clerk's user properties |
|
|
| `active` | *JsonNullable<? extends Boolean>* | :heavy_minus_sign: | Activate or de-activate the SAML Connection |
|
|
| `syncUserAttributes` | *JsonNullable<? extends Boolean>* | :heavy_minus_sign: | Controls whether to update the user's attributes in each sign-in |
|
|
| `allowSubdomains` | *JsonNullable<? extends Boolean>* | :heavy_minus_sign: | Allow users with an email address subdomain to use this connection in order to authenticate |
|
|
| `allowIdpInitiated` | *JsonNullable<? extends Boolean>* | :heavy_minus_sign: | Enable or deactivate IdP-initiated flows | |