SSO Configuration

Update SSO configuration

Updates an existing Partition Enforced SSO configuration with Identity Provider details.

put/v2/authn/sso-config/partitions/enforced/{partitionId}

Request

Path parameters

partitionIdstring required

ID of partition, refers to <a href="#/~schema/PartitionX">partition.id</a>

Request body

identityProviderSignInUrlstring uri required

Identity Provider sign-in endpoint URL where SAML authentication requests are sent.

identityProviderSigningCertificatestring required

Identity Provider signing certificate in PEM or CER format.

userIdAttributeFieldMappingstring

SAML attribute name that contains the Alianza user ID.

externalIdAttributeFieldMappingstring required

SAML attribute name containing the user's unique identifier in the IdP.

externalEmailAttributeFieldMappingstring

SAML attribute name containing the user's email address.

ssoNamestring required
identityProviderLogoutUrlstring uri
samlRequestProtocolBinding'POST' | 'REDIRECT'

SAML Request Protocol Binding.

enforcedSubPartitionsstring[]
allowSpInitiatedAuthenticationFlowboolean
allowAlianzaAuthenticationboolean

Response

SSO configuration updated successfully

partitionIdstring
accountIdstring nullable
ssoNamestring
assertionConsumerResponseUrlstring uri
serviceProviderEntityIdstring
serviceProviderSigningCertificatestring
identityProviderUserIdstring
identityProviderUserEmailstring
alianzaUserIdFieldMappingstring
identityProviderSignInUrlstring uri
identityProviderLogoutUrlstring uri
identityProviderSigningKeyNamestring
status'DRAFT' | 'READY' | 'ENABLED' | 'DISABLED'
createdAtstring date-time
updatedAtstring date-time
validatedboolean
allowAlianzaAuthenticationboolean
allowSpInitiatedAuthenticationFlowboolean
enforcedSubPartitionsstring[]

Changes

No recorded changes to this operation across all 1 revision of this API.