AWS Fundamentals Logo
AWS Fundamentals
L2 Construct

UserPoolIdentityProviderSaml

Represents an identity provider that integrates with SAML.

Import

import { UserPoolIdentityProviderSaml } from 'aws-cdk-lib/aws-cognito';

Or use the module namespace:

import * as cognito from 'aws-cdk-lib/aws-cognito';
// cognito.UserPoolIdentityProviderSaml

Properties

Configuration passed to the constructor as UserPoolIdentityProviderSamlProps.

metadataRequired
UserPoolIdentityProviderSamlMetadata

The SAML metadata.

encryptedResponsesOptional
boolean

Whether to require encrypted SAML assertions from IdP.

Default: false

identifiersOptional
string[]

Identifiers. Identifiers can be used to redirect users to the correct IdP in multitenant apps.

Default: - no identifiers used

idpInitiatedOptional
boolean

Whether to enable IdP-initiated SAML auth flows.

Default: false

idpSignoutOptional
boolean

Whether to enable the "Sign-out flow" feature.

Default: - false

nameOptional
string

The name of the provider. Must be between 3 and 32 characters.

Default: - the unique ID of the construct

requestSigningAlgorithmOptional
SigningAlgorithm

The signing algorithm for SAML requests.

Default: - don't sign requests

2 properties inherited from UserPoolIdentityProviderProps
userPoolRequiredinherited from UserPoolIdentityProviderProps
IUserPool

The user pool to which this construct provides identities.

attributeMappingOptionalinherited from UserPoolIdentityProviderProps
AttributeMapping

Mapping attributes from the identity provider to standard and custom attributes of the user pool.

Default: - no attribute mapping

Get the Amazon Cognito Cheat Sheet

Everything you need to know about Amazon Cognito on one page. HD quality, print-friendly.

Download Free Infographic

Quick Facts

LevelL2 (Higher-level)
Moduleaws-cognito
Properties9

Related Constructs

Explore This Service

External Links