software.amazon.awscdk.services.cognito

Interface OAuthSettings

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

OAuthSettings.Jsii$Proxy

@Generated(value="jsii-pacmak/1.29.0 (build 41df200)",
           date="2021-06-02T09:55:16.765Z")
 @Stability(value=Experimental)
public interface OAuthSettings
extends software.amazon.jsii.JsiiSerializable

(experimental) OAuth settings to configure the interaction between the app and this client.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static OAuthSettings.Builder	builder()
default List<String>	getCallbackUrls() (experimental) List of allowed redirect URLs for the identity providers.
default OAuthFlows	getFlows() (experimental) OAuth flows that are allowed with this client.
default List<String>	getLogoutUrls() (experimental) List of allowed logout URLs for the identity providers.
default List<OAuthScope>	getScopes() (experimental) OAuth scopes that are allowed with this client.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getCallbackUrls

@Stability(value=Experimental)
 @Nullable
default List<String> getCallbackUrls()

(experimental) List of allowed redirect URLs for the identity providers.

Default: - ['https://example.com'] if either authorizationCodeGrant or implicitCodeGrant flows are enabled, no callback URLs otherwise.

getFlows

@Stability(value=Experimental)
 @Nullable
default OAuthFlows getFlows()

(experimental) OAuth flows that are allowed with this client.

Default: {authorizationCodeGrant:true,implicitCodeGrant:true}

See Also:

the 'Allowed OAuth Flows' section at https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-app-idp-settings.html

getLogoutUrls

@Stability(value=Experimental)
 @Nullable
default List<String> getLogoutUrls()

(experimental) List of allowed logout URLs for the identity providers.

Default: - no logout URLs

getScopes

@Stability(value=Experimental)
 @Nullable
default List<OAuthScope> getScopes()

(experimental) OAuth scopes that are allowed with this client.

Default: [OAuthScope.PHONE,OAuthScope.EMAIL,OAuthScope.OPENID,OAuthScope.PROFILE,OAuthScope.COGNITO_ADMIN]

See Also:

https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-app-idp-settings.html

builder

@Stability(value=Experimental)
static OAuthSettings.Builder builder()

Returns:

a OAuthSettings.Builder of OAuthSettings