Package software.amazon.awscdk.services.cognito

Interface OAuthFlows

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

OAuthFlows.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:04.708Z")
@Stability(Stable)
public interface OAuthFlows
extends software.amazon.jsii.JsiiSerializable

Types of OAuth grant flows.

Example:

 UserPool userpool = UserPool.Builder.create(this, "UserPool").build();
 UserPoolClient client = userpool.addClient("Client", UserPoolClientOptions.builder()
         // ...
         .oAuth(OAuthSettings.builder()
                 .flows(OAuthFlows.builder()
                         .implicitCodeGrant(true)
                         .build())
                 .callbackUrls(List.of("https://myapp.com/home", "https://myapp.com/users"))
                 .build())
         .build());
 UserPoolDomain domain = userpool.addDomain("Domain", UserPoolDomainOptions.builder().build());
 String signInUrl = domain.signInUrl(client, SignInUrlOptions.builder()
         .redirectUri("https://myapp.com/home")
         .build());
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static OAuthFlows.Builder	builder()
default Boolean	getAuthorizationCodeGrant()	Initiate an authorization code grant flow, which provides an authorization code as the response.
default Boolean	getClientCredentials()	Client should get the access token and ID token from the token endpoint using a combination of client and client_secret.
default Boolean	getImplicitCodeGrant()	The client should get the access token and ID token directly.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAuthorizationCodeGrant

@Stability(Stable)
@Nullable
default Boolean getAuthorizationCodeGrant()

Initiate an authorization code grant flow, which provides an authorization code as the response.

Default: false

getClientCredentials

@Stability(Stable)
@Nullable
default Boolean getClientCredentials()

Client should get the access token and ID token from the token endpoint using a combination of client and client_secret.

Default: false

getImplicitCodeGrant

@Stability(Stable)
@Nullable
default Boolean getImplicitCodeGrant()

The client should get the access token and ID token directly.

Default: false

builder

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

Returns:

a OAuthFlows.Builder of OAuthFlows