Package software.amazon.awscdk.services.cognito

Interface UserPoolIdentityProviderOidcProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, UserPoolIdentityProviderProps

All Known Implementing Classes:

UserPoolIdentityProviderOidcProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-21T06:34:05.627Z")
@Stability(Stable)
public interface UserPoolIdentityProviderOidcProps
extends software.amazon.jsii.JsiiSerializable, UserPoolIdentityProviderProps

Properties to initialize UserPoolIdentityProviderOidc.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cognito.*;
 ProviderAttribute providerAttribute;
 UserPool userPool;
 UserPoolIdentityProviderOidcProps userPoolIdentityProviderOidcProps = UserPoolIdentityProviderOidcProps.builder()
         .clientId("clientId")
         .clientSecret("clientSecret")
         .issuerUrl("issuerUrl")
         .userPool(userPool)
         // the properties below are optional
         .attributeMapping(AttributeMapping.builder()
                 .address(providerAttribute)
                 .birthdate(providerAttribute)
                 .custom(Map.of(
                         "customKey", providerAttribute))
                 .email(providerAttribute)
                 .emailVerified(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)
                 .build())
         .attributeRequestMethod(OidcAttributeRequestMethod.GET)
         .endpoints(OidcEndpoints.builder()
                 .authorization("authorization")
                 .jwksUri("jwksUri")
                 .token("token")
                 .userInfo("userInfo")
                 .build())
         .identifiers(List.of("identifiers"))
         .name("name")
         .scopes(List.of("scopes"))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	UserPoolIdentityProviderOidcProps.Builder	A builder for UserPoolIdentityProviderOidcProps
static final class	UserPoolIdentityProviderOidcProps.Jsii$Proxy	An implementation for UserPoolIdentityProviderOidcProps

Method Summary

Modifier and Type	Method	Description
static UserPoolIdentityProviderOidcProps.Builder	builder()
default OidcAttributeRequestMethod	getAttributeRequestMethod()	The method to use to request attributes.
String	getClientId()	The client id.
String	getClientSecret()	The client secret.
default OidcEndpoints	getEndpoints()	OpenID connect endpoints.
default List<String>	getIdentifiers()	Identifiers.
String	getIssuerUrl()	Issuer URL.
default String	getName()	The name of the provider.
default List<String>	getScopes()	The OAuth 2.0 scopes that you will request from OpenID Connect.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface software.amazon.awscdk.services.cognito.UserPoolIdentityProviderProps

getAttributeMapping, getUserPool

Method Details

getClientId

@Stability(Stable)
@NotNull
String getClientId()

The client id.

getClientSecret

@Stability(Stable)
@NotNull
String getClientSecret()

The client secret.

getIssuerUrl

@Stability(Stable)
@NotNull
String getIssuerUrl()

Issuer URL.

getAttributeRequestMethod

@Stability(Stable)
@Nullable
default OidcAttributeRequestMethod getAttributeRequestMethod()

The method to use to request attributes.

Default: OidcAttributeRequestMethod.GET

getEndpoints

@Stability(Stable)
@Nullable
default OidcEndpoints getEndpoints()

OpenID connect endpoints.

Default: - auto discovered with issuer URL

getIdentifiers

@Stability(Stable)
@Nullable
default List<String> getIdentifiers()

Identifiers.

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

Default: - no identifiers used

getName

@Stability(Stable)
@Nullable
default String getName()

The name of the provider.

Default: - the unique ID of the construct

getScopes

@Stability(Stable)
@Nullable
default List<String> getScopes()

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']

builder

@Stability(Stable)
static UserPoolIdentityProviderOidcProps.Builder builder()

Returns:

a UserPoolIdentityProviderOidcProps.Builder of UserPoolIdentityProviderOidcProps