UserPoolIdentityProviderSamlProps Struct
Properties to initialize UserPoolIdentityProviderSaml.
Example
ts
const userpool = new cognito.UserPool(this, 'Pool');
// specify the metadata as a file content
new cognito.UserPoolIdentityProviderSaml(this, 'userpoolIdpFile', {
userPool: userpool,
metadata: cognito.UserPoolIdentityProviderSamlMetadata.file('my-file-contents'),
// Whether to require encrypted SAML assertions from IdP
encryptedResponses: true,
// The signing algorithm for the SAML requests
requestSigningAlgorithm: cognito.SigningAlgorithm.RSA_SHA256,
// Enable IdP initiated SAML auth flow
idpInitiated: true,
});
// specify the metadata as a URL
new cognito.UserPoolIdentityProviderSaml(this, 'userpoolidpUrl', {
userPool: userpool,
metadata: cognito.UserPoolIdentityProviderSamlMetadata.url('https://my-metadata-url.com'),
});
Properties
attributeMappingAttributeMappingattribute_mappingAttributeMappingattributeMappingAttributeMappingAttributeMappingAttributeMappingAttributeMappingAttributeMapping= no attribute mapping#Mapping attributes from the identity provider to standard and custom attributes of the user pool.
encryptedResponsesbooleanencrypted_responsesboolencryptedResponsesBooleanEncryptedResponsesboolEncryptedResponses*bool= false#Whether to require encrypted SAML assertions from IdP.
identifiersstring[]identifierstyping.List[str]identifiersList<String>Identifiersstring[]Identifiers*[]*string= no identifiers used#Identifiers.
Identifiers can be used to redirect users to the correct IdP in multitenant apps.
Whether to enable IdP-initiated SAML auth flows.
Whether to enable the "Sign-out flow" feature.
metadataUserPoolIdentityProviderSamlMetadatametadataUserPoolIdentityProviderSamlMetadatametadataUserPoolIdentityProviderSamlMetadataMetadataUserPoolIdentityProviderSamlMetadataMetadataUserPoolIdentityProviderSamlMetadatarequired#The SAML metadata.
The name of the provider.
Must be between 3 and 32 characters.
requestSigningAlgorithmSigningAlgorithmrequest_signing_algorithmSigningAlgorithmrequestSigningAlgorithmSigningAlgorithmRequestSigningAlgorithmSigningAlgorithmRequestSigningAlgorithmSigningAlgorithm= don't sign requests#The signing algorithm for SAML requests.