aws-cdk-lib.aws_cognito.UserPoolIdentityProviderSamlProps

interface UserPoolIdentityProviderSamlProps

LanguageType name
.NETAmazon.CDK.AWS.Cognito.UserPoolIdentityProviderSamlProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscognito#UserPoolIdentityProviderSamlProps
Javasoftware.amazon.awscdk.services.cognito.UserPoolIdentityProviderSamlProps
Pythonaws_cdk.aws_cognito.UserPoolIdentityProviderSamlProps
TypeScript (source)aws-cdk-lib » aws_cognito » UserPoolIdentityProviderSamlProps

Properties to initialize UserPoolIdentityProviderSaml.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cognito as cognito } from 'aws-cdk-lib';

declare const providerAttribute: cognito.ProviderAttribute;
declare const userPool: cognito.UserPool;
declare const userPoolIdentityProviderSamlMetadata: cognito.UserPoolIdentityProviderSamlMetadata;
const userPoolIdentityProviderSamlProps: cognito.UserPoolIdentityProviderSamlProps = {
  metadata: userPoolIdentityProviderSamlMetadata,
  userPool: userPool,

  // the properties below are optional
  attributeMapping: {
    address: providerAttribute,
    birthdate: providerAttribute,
    custom: {
      customKey: providerAttribute,
    },
    email: providerAttribute,
    familyName: providerAttribute,
    fullname: providerAttribute,
    gender: providerAttribute,
    givenName: providerAttribute,
    lastUpdateTime: providerAttribute,
    locale: providerAttribute,
    middleName: providerAttribute,
    nickname: providerAttribute,
    phoneNumber: providerAttribute,
    preferredUsername: providerAttribute,
    profilePage: providerAttribute,
    profilePicture: providerAttribute,
    timezone: providerAttribute,
    website: providerAttribute,
  },
  identifiers: ['identifiers'],
  idpSignout: false,
  name: 'name',
};

Properties

NameTypeDescription
metadataUserPoolIdentityProviderSamlMetadataThe SAML metadata.
userPoolIUserPoolThe user pool to which this construct provides identities.
attributeMapping?AttributeMappingMapping attributes from the identity provider to standard and custom attributes of the user pool.
identifiers?string[]Identifiers.
idpSignout?booleanWhether to enable the "Sign-out flow" feature.
name?stringThe name of the provider.

metadata

Type: UserPoolIdentityProviderSamlMetadata

The SAML metadata.


userPool

Type: IUserPool

The user pool to which this construct provides identities.


attributeMapping?

Type: AttributeMapping (optional, default: no attribute mapping)

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


identifiers?

Type: string[] (optional, default: no identifiers used)

Identifiers.

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


idpSignout?

Type: boolean (optional, default: false)

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


name?

Type: string (optional, default: the unique ID of the construct)

The name of the provider.

Must be between 3 and 32 characters.