interface UserPoolIdentityProviderGoogleProps

Language	Type name
.NET	`Amazon.CDK.AWS.Cognito.UserPoolIdentityProviderGoogleProps`
Java	`software.amazon.awscdk.services.cognito.UserPoolIdentityProviderGoogleProps`
Python	`aws_cdk.aws_cognito.UserPoolIdentityProviderGoogleProps`
TypeScript (source)	`@aws-cdk/aws-cognito` » `UserPoolIdentityProviderGoogleProps`

Properties to initialize UserPoolGoogleIdentityProvider.

Example

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

declare const providerAttribute: cognito.ProviderAttribute;
declare const userPool: cognito.UserPool;
const userPoolIdentityProviderGoogleProps: cognito.UserPoolIdentityProviderGoogleProps = {
  clientId: 'clientId',
  clientSecret: 'clientSecret',
  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,
  },
  scopes: ['scopes'],
};

Properties

Name	Type	Description
clientId	`string`	The client id recognized by Google APIs.
clientSecret	`string`	The client secret to be accompanied with clientId for Google APIs to authenticate the client.
userPool	`IUserPool`	The user pool to which this construct provides identities.
attributeMapping?	`AttributeMapping`	Mapping attributes from the identity provider to standard and custom attributes of the user pool.
scopes?	`string[]`	The list of google permissions to obtain for getting access to the google profile.

clientId

Type: string

The client id recognized by Google APIs.

clientSecret

Type: string

The client secret to be accompanied with clientId for Google APIs to authenticate the client.

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.

scopes?

Type: string[] (optional, default: [ profile ])

The list of google permissions to obtain for getting access to the google profile.