Copyright | (c) 2013-2017 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 |
Allows the developer to update the specified user pool client and password policy.
- updateUserPoolClient :: Text -> Text -> UpdateUserPoolClient
- data UpdateUserPoolClient
- uupcRefreshTokenValidity :: Lens' UpdateUserPoolClient (Maybe Natural)
- uupcExplicitAuthFlows :: Lens' UpdateUserPoolClient [ExplicitAuthFlowsType]
- uupcSupportedIdentityProviders :: Lens' UpdateUserPoolClient [Text]
- uupcLogoutURLs :: Lens' UpdateUserPoolClient [Text]
- uupcAllowedOAuthFlowsUserPoolClient :: Lens' UpdateUserPoolClient (Maybe Bool)
- uupcDefaultRedirectURI :: Lens' UpdateUserPoolClient (Maybe Text)
- uupcWriteAttributes :: Lens' UpdateUserPoolClient [Text]
- uupcReadAttributes :: Lens' UpdateUserPoolClient [Text]
- uupcAllowedOAuthScopes :: Lens' UpdateUserPoolClient [Text]
- uupcAllowedOAuthFlows :: Lens' UpdateUserPoolClient [OAuthFlowType]
- uupcClientName :: Lens' UpdateUserPoolClient (Maybe Text)
- uupcCallbackURLs :: Lens' UpdateUserPoolClient [Text]
- uupcUserPoolId :: Lens' UpdateUserPoolClient Text
- uupcClientId :: Lens' UpdateUserPoolClient Text
- updateUserPoolClientResponse :: Int -> UpdateUserPoolClientResponse
- data UpdateUserPoolClientResponse
- uupcrsUserPoolClient :: Lens' UpdateUserPoolClientResponse (Maybe UserPoolClientType)
- uupcrsResponseStatus :: Lens' UpdateUserPoolClientResponse Int
Creating a Request
Creates a value of UpdateUserPoolClient
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
uupcRefreshTokenValidity
- The time limit, in days, after which the refresh token is no longer valid and cannot be used.uupcExplicitAuthFlows
- Explicit authentication flows.uupcSupportedIdentityProviders
- A list of provider names for the identity providers that are supported on this client.uupcLogoutURLs
- A list of allowed logout URLs for the identity providers.uupcAllowedOAuthFlowsUserPoolClient
- Set to TRUE if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.uupcDefaultRedirectURI
- The default redirect URI. Must be in theCallbackURLs
list.uupcWriteAttributes
- The writeable attributes of the user pool.uupcReadAttributes
- The read-only attributes of the user pool.uupcAllowedOAuthScopes
- A list of allowedOAuth
scopes. Currently supported values are"phone"
,"email"
,"openid"
, andCognito
.uupcAllowedOAuthFlows
- 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.uupcClientName
- The client name from the update user pool client request.uupcCallbackURLs
- A list of allowed callback URLs for the identity providers.uupcUserPoolId
- The user pool ID for the user pool where you want to update the user pool client.uupcClientId
- The ID of the client associated with the user pool.
data UpdateUserPoolClient Source #
Represents the request to update the user pool client.
See: updateUserPoolClient
smart constructor.
Request Lenses
uupcRefreshTokenValidity :: Lens' UpdateUserPoolClient (Maybe Natural) Source #
The time limit, in days, after which the refresh token is no longer valid and cannot be used.
uupcExplicitAuthFlows :: Lens' UpdateUserPoolClient [ExplicitAuthFlowsType] Source #
Explicit authentication flows.
uupcSupportedIdentityProviders :: Lens' UpdateUserPoolClient [Text] Source #
A list of provider names for the identity providers that are supported on this client.
uupcLogoutURLs :: Lens' UpdateUserPoolClient [Text] Source #
A list of allowed logout URLs for the identity providers.
uupcAllowedOAuthFlowsUserPoolClient :: Lens' UpdateUserPoolClient (Maybe Bool) Source #
Set to TRUE if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
uupcDefaultRedirectURI :: Lens' UpdateUserPoolClient (Maybe Text) Source #
The default redirect URI. Must be in the CallbackURLs
list.
uupcWriteAttributes :: Lens' UpdateUserPoolClient [Text] Source #
The writeable attributes of the user pool.
uupcReadAttributes :: Lens' UpdateUserPoolClient [Text] Source #
The read-only attributes of the user pool.
uupcAllowedOAuthScopes :: Lens' UpdateUserPoolClient [Text] Source #
A list of allowed OAuth
scopes. Currently supported values are "phone"
, "email"
, "openid"
, and Cognito
.
uupcAllowedOAuthFlows :: Lens' UpdateUserPoolClient [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.
uupcClientName :: Lens' UpdateUserPoolClient (Maybe Text) Source #
The client name from the update user pool client request.
uupcCallbackURLs :: Lens' UpdateUserPoolClient [Text] Source #
A list of allowed callback URLs for the identity providers.
uupcUserPoolId :: Lens' UpdateUserPoolClient Text Source #
The user pool ID for the user pool where you want to update the user pool client.
uupcClientId :: Lens' UpdateUserPoolClient Text Source #
The ID of the client associated with the user pool.
Destructuring the Response
updateUserPoolClientResponse Source #
Creates a value of UpdateUserPoolClientResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
uupcrsUserPoolClient
- The user pool client value from the response from the server when an update user pool client request is made.uupcrsResponseStatus
- -- | The response status code.
data UpdateUserPoolClientResponse Source #
Represents the response from the server to the request to update the user pool client.
See: updateUserPoolClientResponse
smart constructor.
Response Lenses
uupcrsUserPoolClient :: Lens' UpdateUserPoolClientResponse (Maybe UserPoolClientType) Source #
The user pool client value from the response from the server when an update user pool client request is made.
uupcrsResponseStatus :: Lens' UpdateUserPoolClientResponse Int Source #
- - | The response status code.