Interface OAuthFlows
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
OAuthFlows.Jsii$Proxy
@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
date="2024-09-06T01:36:25.582Z")
@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:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forOAuthFlows
static final class
An implementation forOAuthFlows
-
Method Summary
Modifier and TypeMethodDescriptionstatic OAuthFlows.Builder
builder()
default Boolean
Initiate an authorization code grant flow, which provides an authorization code as the response.default Boolean
Client should get the access token and ID token from the token endpoint using a combination of client and client_secret.default Boolean
The client should get the access token and ID token directly.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getAuthorizationCodeGrant
Initiate an authorization code grant flow, which provides an authorization code as the response.Default: false
-
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
The client should get the access token and ID token directly.Default: false
-
builder
- Returns:
- a
OAuthFlows.Builder
ofOAuthFlows
-