Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Creates the user pool client.
Synopsis
- createUserPoolClient :: Text -> Text -> CreateUserPoolClient
- data CreateUserPoolClient
- cupcRefreshTokenValidity :: Lens' CreateUserPoolClient (Maybe Natural)
- cupcExplicitAuthFlows :: Lens' CreateUserPoolClient [ExplicitAuthFlowsType]
- cupcSupportedIdentityProviders :: Lens' CreateUserPoolClient [Text]
- cupcLogoutURLs :: Lens' CreateUserPoolClient [Text]
- cupcAllowedOAuthFlowsUserPoolClient :: Lens' CreateUserPoolClient (Maybe Bool)
- cupcGenerateSecret :: Lens' CreateUserPoolClient (Maybe Bool)
- cupcDefaultRedirectURI :: Lens' CreateUserPoolClient (Maybe Text)
- cupcWriteAttributes :: Lens' CreateUserPoolClient [Text]
- cupcReadAttributes :: Lens' CreateUserPoolClient [Text]
- cupcAllowedOAuthScopes :: Lens' CreateUserPoolClient [Text]
- cupcAllowedOAuthFlows :: Lens' CreateUserPoolClient [OAuthFlowType]
- cupcAnalyticsConfiguration :: Lens' CreateUserPoolClient (Maybe AnalyticsConfigurationType)
- cupcCallbackURLs :: Lens' CreateUserPoolClient [Text]
- cupcUserPoolId :: Lens' CreateUserPoolClient Text
- cupcClientName :: Lens' CreateUserPoolClient Text
- createUserPoolClientResponse :: Int -> CreateUserPoolClientResponse
- data CreateUserPoolClientResponse
- cupcrsUserPoolClient :: Lens' CreateUserPoolClientResponse (Maybe UserPoolClientType)
- cupcrsResponseStatus :: Lens' CreateUserPoolClientResponse Int
Creating a Request
Creates a value of CreateUserPoolClient
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cupcRefreshTokenValidity
- The time limit, in days, after which the refresh token is no longer valid and cannot be used.cupcExplicitAuthFlows
- The explicit authentication flows.cupcSupportedIdentityProviders
- A list of provider names for the identity providers that are supported on this client.cupcLogoutURLs
- A list of allowed logout URLs for the identity providers.cupcAllowedOAuthFlowsUserPoolClient
- Set toTrue
if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.cupcGenerateSecret
- Boolean to specify whether you want to generate a secret for the user pool client being created.cupcDefaultRedirectURI
- The default redirect URI. Must be in theCallbackURLs
list.cupcWriteAttributes
- The write attributes.cupcReadAttributes
- The read attributes.cupcAllowedOAuthScopes
- A list of allowedOAuth
scopes. Currently supported values are"phone"
,"email"
,"openid"
, andCognito
.cupcAllowedOAuthFlows
- Set tocode
to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint. Set totoken
to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.cupcAnalyticsConfiguration
- The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.cupcCallbackURLs
- A list of allowed callback URLs for the identity providers.cupcUserPoolId
- The user pool ID for the user pool where you want to create a user pool client.cupcClientName
- The client name for the user pool client you would like to create.
data CreateUserPoolClient Source #
Represents the request to create a user pool client.
See: createUserPoolClient
smart constructor.
Instances
Request Lenses
cupcRefreshTokenValidity :: Lens' CreateUserPoolClient (Maybe Natural) Source #
The time limit, in days, after which the refresh token is no longer valid and cannot be used.
cupcExplicitAuthFlows :: Lens' CreateUserPoolClient [ExplicitAuthFlowsType] Source #
The explicit authentication flows.
cupcSupportedIdentityProviders :: Lens' CreateUserPoolClient [Text] Source #
A list of provider names for the identity providers that are supported on this client.
cupcLogoutURLs :: Lens' CreateUserPoolClient [Text] Source #
A list of allowed logout URLs for the identity providers.
cupcAllowedOAuthFlowsUserPoolClient :: Lens' CreateUserPoolClient (Maybe Bool) Source #
Set to True
if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
cupcGenerateSecret :: Lens' CreateUserPoolClient (Maybe Bool) Source #
Boolean to specify whether you want to generate a secret for the user pool client being created.
cupcDefaultRedirectURI :: Lens' CreateUserPoolClient (Maybe Text) Source #
The default redirect URI. Must be in the CallbackURLs
list.
cupcWriteAttributes :: Lens' CreateUserPoolClient [Text] Source #
The write attributes.
cupcReadAttributes :: Lens' CreateUserPoolClient [Text] Source #
The read attributes.
cupcAllowedOAuthScopes :: Lens' CreateUserPoolClient [Text] Source #
A list of allowed OAuth
scopes. Currently supported values are "phone"
, "email"
, "openid"
, and Cognito
.
cupcAllowedOAuthFlows :: Lens' CreateUserPoolClient [OAuthFlowType] Source #
Set to code
to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint. Set to token
to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.
cupcAnalyticsConfiguration :: Lens' CreateUserPoolClient (Maybe AnalyticsConfigurationType) Source #
The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.
cupcCallbackURLs :: Lens' CreateUserPoolClient [Text] Source #
A list of allowed callback URLs for the identity providers.
cupcUserPoolId :: Lens' CreateUserPoolClient Text Source #
The user pool ID for the user pool where you want to create a user pool client.
cupcClientName :: Lens' CreateUserPoolClient Text Source #
The client name for the user pool client you would like to create.
Destructuring the Response
createUserPoolClientResponse Source #
Creates a value of CreateUserPoolClientResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cupcrsUserPoolClient
- The user pool client that was just created.cupcrsResponseStatus
- -- | The response status code.
data CreateUserPoolClientResponse Source #
Represents the response from the server to create a user pool client.
See: createUserPoolClientResponse
smart constructor.
Instances
Response Lenses
cupcrsUserPoolClient :: Lens' CreateUserPoolClientResponse (Maybe UserPoolClientType) Source #
The user pool client that was just created.
cupcrsResponseStatus :: Lens' CreateUserPoolClientResponse Int Source #
- - | The response status code.