software.amazon.awscdk.services.cognito

Interface OAuthFlows

All Known Implementing Classes:

OAuthFlows.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:46.867Z")
public interface OAuthFlows

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 and Description
static class	OAuthFlows.Builder A builder for OAuthFlows
static class	OAuthFlows.Jsii$Proxy An implementation for OAuthFlows

Method Summary

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

Method Detail

getAuthorizationCodeGrant

default java.lang.Boolean getAuthorizationCodeGrant()

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

Default: false

getClientCredentials

default java.lang.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

default java.lang.Boolean getImplicitCodeGrant()

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

Default: false

builder

static OAuthFlows.Builder builder()

Returns:

a OAuthFlows.Builder of OAuthFlows