AWS Fundamentals Logo
AWS Fundamentals
L2 Construct

UserPoolIdentityProviderOidc

Represents an identity provider that integrates with OpenID Connect.

Import

import { UserPoolIdentityProviderOidc } from 'aws-cdk-lib/aws-cognito';

Or use the module namespace:

import * as cognito from 'aws-cdk-lib/aws-cognito';
// cognito.UserPoolIdentityProviderOidc

Properties

Configuration passed to the constructor as UserPoolIdentityProviderOidcProps.

clientIdRequired
string

The client id.

clientSecretRequired
string

The client secret.

issuerUrlRequired
string

Issuer URL.

attributeRequestMethodOptional
OidcAttributeRequestMethod

The method to use to request attributes.

Default: OidcAttributeRequestMethod.GET

endpointsOptional
OidcEndpoints

OpenID connect endpoints.

Default: - auto discovered with issuer URL

identifiersOptional
string[]

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

Default: - no identifiers used

nameOptional
string

The name of the provider.

Default: - the unique ID of the construct

scopesOptional
string[]

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.

Default: ['openid']

2 properties inherited from UserPoolIdentityProviderProps
userPoolRequiredinherited from UserPoolIdentityProviderProps
IUserPool

The user pool to which this construct provides identities.

attributeMappingOptionalinherited from UserPoolIdentityProviderProps
AttributeMapping

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

Default: - no attribute mapping

Get the Amazon Cognito Cheat Sheet

Everything you need to know about Amazon Cognito on one page. HD quality, print-friendly.

Download Free Infographic

Quick Facts

LevelL2 (Higher-level)
Moduleaws-cognito
Properties10

Related Constructs

Explore This Service

External Links