Skip to content
v2.274.0

UserPoolIdentityProviderGoogleProps Struct ​

Properties to initialize UserPoolGoogleIdentityProvider.

Example ​

ts
const userpool = new cognito.UserPool(this, 'Pool');
const secret = secretsmanager.Secret.fromSecretAttributes(this, "CognitoClientSecret", {
    secretCompleteArn: "arn:aws:secretsmanager:xxx:xxx:secret:xxx-xxx"
}).secretValue

const provider = new cognito.UserPoolIdentityProviderGoogle(this, 'Google', {
  clientId: 'amzn-client-id',
  clientSecretValue: secret,
  userPool: userpool,
});

Properties ​

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

Default: no attribute mapping

clientIdstringclient_idstrclientIdStringClientIdstringClientId*stringrequired#
The client id recognized by Google APIs.
clientSecretoptionalstringclient_secretoptionalstrclientSecretoptionalStringClientSecretoptionalstringClientSecretoptional*string= nonedeprecated#
use clientSecretValue instead
clientSecretValueoptionalSecretValueclient_secret_valueoptionalSecretValueclientSecretValueoptionalSecretValueClientSecretValueoptionalSecretValueClientSecretValueoptionalSecretValue= none#
The client secret to be accompanied with clientId for Google APIs to authenticate the client as SecretValue.
scopesoptionalstring[]scopesoptionaltyping.List[str]scopesoptionalList<String>Scopesoptionalstring[]Scopesoptional*[]*string#
The list of Google permissions to obtain for getting access to the Google profile.

Default: [ profile ]

userPoolIUserPooluser_poolIUserPooluserPoolIUserPoolUserPoolIUserPoolUserPoolIUserPoolrequired#
The user pool to which this construct provides identities.