OAuthSettings¶
-
class
aws_cdk.aws_cognito.OAuthSettings(*, callback_urls=None, flows=None, scopes=None)¶ Bases:
object-
__init__(*, callback_urls=None, flows=None, scopes=None)¶ OAuth settings to configure the interaction between the app and this client.
- Parameters
callback_urls (
Optional[List[str]]) – 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.flows (
Optional[OAuthFlows]) – OAuth flows that are allowed with this client. Default: {authorizationCodeGrant:true,implicitCodeGrant:true}scopes (
Optional[List[OAuthScope]]) – OAuth scopes that are allowed with this client. Default: [OAuthScope.PHONE,OAuthScope.EMAIL,OAuthScope.OPENID,OAuthScope.PROFILE,OAuthScope.COGNITO_ADMIN]
stability :stability: experimental
- Return type
None
Attributes
-
callback_urls¶ List of allowed redirect URLs for the identity providers.
default :default: - [‘https://example.com’] if either authorizationCodeGrant or implicitCodeGrant flows are enabled, no callback URLs otherwise.
stability :stability: experimental
- Return type
Optional[List[str]]
-
flows¶ OAuth flows that are allowed with this client.
default :default: {authorizationCodeGrant:true,implicitCodeGrant:true}
see :see: - the ‘Allowed OAuth Flows’ section at https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-app-idp-settings.html stability :stability: experimental
- Return type
Optional[OAuthFlows]
-
scopes¶ OAuth scopes that are allowed with this client.
default :default: [OAuthScope.PHONE,OAuthScope.EMAIL,OAuthScope.OPENID,OAuthScope.PROFILE,OAuthScope.COGNITO_ADMIN]
see :see: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-app-idp-settings.html stability :stability: experimental
- Return type
Optional[List[OAuthScope]]
-