Interface IUserPoolIdentityProviderOidcProps

Namespace

Amazon.CDK.AWS.Cognito

Assembly

Amazon.CDK.AWS.Cognito.dll

Properties to initialize UserPoolIdentityProviderOidc.

public interface IUserPoolIdentityProviderOidcProps : IUserPoolIdentityProviderProps

Inherited Members

IUserPoolIdentityProviderProps.UserPool

IUserPoolIdentityProviderProps.AttributeMapping

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 userPoolIdentityProviderOidcProps = new UserPoolIdentityProviderOidcProps {
                ClientId = "clientId",
                ClientSecret = "clientSecret",
                IssuerUrl = "issuerUrl",
                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
                },
                AttributeRequestMethod = OidcAttributeRequestMethod.GET,
                Endpoints = new OidcEndpoints {
                    Authorization = "authorization",
                    JwksUri = "jwksUri",
                    Token = "token",
                    UserInfo = "userInfo"
                },
                Identifiers = new [] { "identifiers" },
                Name = "name",
                Scopes = new [] { "scopes" }
            };

Remarks

ExampleMetadata: fixture=_generated

Properties

AttributeRequestMethod

The method to use to request attributes.

OidcAttributeRequestMethod? AttributeRequestMethod { get; }

Property Value

OidcAttributeRequestMethod?

Remarks

Default: OidcAttributeRequestMethod.GET

ClientId

The client id.

string ClientId { get; }

Property Value

string

ClientSecret

The client secret.

string ClientSecret { get; }

Property Value

string

Endpoints

OpenID connect endpoints.

IOidcEndpoints? Endpoints { get; }

Property Value

IOidcEndpoints

Remarks

Default: - auto discovered with issuer URL

Identifiers

Identifiers.

string[]? Identifiers { get; }

Property Value

string[]

Remarks

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

Default: - no identifiers used

IssuerUrl

Issuer URL.

string IssuerUrl { get; }

Property Value

string

Name

The name of the provider.

string? Name { get; }

Property Value

string

Remarks

Default: - the unique ID of the construct

Scopes

The OAuth 2.0 scopes that you will request from OpenID Connect. Scopes are groups of OpenID Connect user attributes to exchange with your app.

string[]? Scopes { get; }

Property Value

string[]

Remarks

Default: ['openid']