@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
date="2023-03-22T19:35:46.870Z")
public interface OAuthSettings
Example:
UserPool pool = new UserPool(this, "Pool"); ResourceServerScope readOnlyScope = ResourceServerScope.Builder.create().scopeName("read").scopeDescription("Read-only access").build(); ResourceServerScope fullAccessScope = ResourceServerScope.Builder.create().scopeName("*").scopeDescription("Full access").build(); UserPoolResourceServer userServer = pool.addResourceServer("ResourceServer", UserPoolResourceServerOptions.builder() .identifier("users") .scopes(List.of(readOnlyScope, fullAccessScope)) .build()); UserPoolClient readOnlyClient = pool.addClient("read-only-client", UserPoolClientOptions.builder() // ... .oAuth(OAuthSettings.builder() // ... .scopes(List.of(OAuthScope.resourceServer(userServer, readOnlyScope))) .build()) .build()); UserPoolClient fullAccessClient = pool.addClient("full-access-client", UserPoolClientOptions.builder() // ... .oAuth(OAuthSettings.builder() // ... .scopes(List.of(OAuthScope.resourceServer(userServer, fullAccessScope))) .build()) .build());
Modifier and Type | Interface and Description |
---|---|
static class |
OAuthSettings.Builder
A builder for
OAuthSettings |
static class |
OAuthSettings.Jsii$Proxy
An implementation for
OAuthSettings |
Modifier and Type | Method and Description |
---|---|
static OAuthSettings.Builder |
builder() |
default java.util.List<java.lang.String> |
getCallbackUrls()
List of allowed redirect URLs for the identity providers.
|
default OAuthFlows |
getFlows()
OAuth flows that are allowed with this client.
|
default java.util.List<java.lang.String> |
getLogoutUrls()
List of allowed logout URLs for the identity providers.
|
default java.util.List<OAuthScope> |
getScopes()
OAuth scopes that are allowed with this client.
|
default java.util.List<java.lang.String> getCallbackUrls()
Default: - ['https://example.com'] if either authorizationCodeGrant or implicitCodeGrant flows are enabled, no callback URLs otherwise.
default OAuthFlows getFlows()
Default: {authorizationCodeGrant:true,implicitCodeGrant:true}
default java.util.List<java.lang.String> getLogoutUrls()
Default: - no logout URLs
default java.util.List<OAuthScope> getScopes()
Default: [OAuthScope.PHONE,OAuthScope.EMAIL,OAuthScope.OPENID,OAuthScope.PROFILE,OAuthScope.COGNITO_ADMIN]
static OAuthSettings.Builder builder()
OAuthSettings.Builder
of OAuthSettings