Class UserPoolIdentityProviderOidc

Namespace

Amazon.CDK.AWS.Cognito

Assembly

Amazon.CDK.AWS.Cognito.dll

Represents a identity provider that integrates with OpenID Connect.

public class UserPoolIdentityProviderOidc : Resource, IUserPoolIdentityProvider, IResource, IConstruct, IConstruct, IDependable

Inheritance

object

UserPoolIdentityProviderOidc

Implements

IUserPoolIdentityProvider

IResource

IConstruct

IConstruct

IDependable

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 userPoolIdentityProviderOidc = new UserPoolIdentityProviderOidc(this, "MyUserPoolIdentityProviderOidc", 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

Resource: AWS::Cognito::UserPoolIdentityProvider

ExampleMetadata: fixture=_generated

Constructors

UserPoolIdentityProviderOidc(Construct, string, IUserPoolIdentityProviderOidcProps)

public UserPoolIdentityProviderOidc(Construct scope, string id, IUserPoolIdentityProviderOidcProps props)

Parameters

scope Construct

id string

props IUserPoolIdentityProviderOidcProps

Properties

ProviderName

The primary identifier of this identity provider.

public virtual string ProviderName { get; }

Property Value

string

Methods

ConfigureAttributeMapping()

protected virtual object ConfigureAttributeMapping()

Returns

object