Class UserPoolIdentityProviderGoogleProps
Properties to initialize UserPoolGoogleIdentityProvider.
Inheritance
Namespace: Amazon.CDK.AWS.Cognito
Assembly: Amazon.CDK.AWS.Cognito.dll
Syntax (csharp)
public class UserPoolIdentityProviderGoogleProps : Object, IUserPoolIdentityProviderGoogleProps, IUserPoolIdentityProviderProps
Syntax (vb)
Public Class UserPoolIdentityProviderGoogleProps
Inherits Object
Implements IUserPoolIdentityProviderGoogleProps, IUserPoolIdentityProviderProps
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Cognito;
ProviderAttribute providerAttribute;
UserPool userPool;
var userPoolIdentityProviderGoogleProps = new UserPoolIdentityProviderGoogleProps {
ClientId = "clientId",
ClientSecret = "clientSecret",
UserPool = userPool,
// the properties below are optional
AttributeMapping = new AttributeMapping {
Address = providerAttribute,
Birthdate = providerAttribute,
Custom = new Dictionary<string, ProviderAttribute> {
{ "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 = new [] { "scopes" }
};
Synopsis
Constructors
UserPoolIdentityProviderGoogleProps() |
Properties
AttributeMapping | Mapping attributes from the identity provider to standard and custom attributes of the user pool. |
ClientId | The client id recognized by Google APIs. |
ClientSecret | The client secret to be accompanied with clientId for Google APIs to authenticate the client. |
Scopes | The list of google permissions to obtain for getting access to the google profile. |
UserPool | The user pool to which this construct provides identities. |
Constructors
UserPoolIdentityProviderGoogleProps()
public UserPoolIdentityProviderGoogleProps()
Properties
AttributeMapping
Mapping attributes from the identity provider to standard and custom attributes of the user pool.
public IAttributeMapping AttributeMapping { get; set; }
Property Value
Remarks
Default: - no attribute mapping
ClientId
The client id recognized by Google APIs.
public string ClientId { get; set; }
Property Value
System.String
Remarks
ClientSecret
The client secret to be accompanied with clientId for Google APIs to authenticate the client.
public string ClientSecret { get; set; }
Property Value
System.String
Remarks
Scopes
The list of google permissions to obtain for getting access to the google profile.
public string[] Scopes { get; set; }
Property Value
System.String[]
Remarks
Default: [ profile ]
See: https://developers.google.com/identity/sign-in/web/sign-in
UserPool
The user pool to which this construct provides identities.
public IUserPool UserPool { get; set; }
Property Value