amazonka-cognito-idp-1.6.1: Amazon Cognito Identity Provider SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.CognitoIdentityProvider.UpdateUserPoolClient

Contents

Description

Allows the developer to update the specified user pool client and password policy.

Synopsis

Creating a Request

updateUserPoolClient Source #

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 the CallbackURLs list.
  • uupcWriteAttributes - The writeable attributes of the user pool.
  • uupcReadAttributes - The read-only attributes of the user pool.
  • uupcAllowedOAuthScopes - A list of allowed OAuth scopes. Currently supported values are "phone" , "email" , "openid" , and Cognito .
  • uupcAllowedOAuthFlows - 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.
  • uupcAnalyticsConfiguration - The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.
  • 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.

Instances
Eq UpdateUserPoolClient Source # 
Instance details

Defined in Network.AWS.CognitoIdentityProvider.UpdateUserPoolClient

Data UpdateUserPoolClient Source # 
Instance details

Defined in Network.AWS.CognitoIdentityProvider.UpdateUserPoolClient

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UpdateUserPoolClient -> c UpdateUserPoolClient #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UpdateUserPoolClient #

toConstr :: UpdateUserPoolClient -> Constr #

dataTypeOf :: UpdateUserPoolClient -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c UpdateUserPoolClient) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UpdateUserPoolClient) #

gmapT :: (forall b. Data b => b -> b) -> UpdateUserPoolClient -> UpdateUserPoolClient #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UpdateUserPoolClient -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UpdateUserPoolClient -> r #

gmapQ :: (forall d. Data d => d -> u) -> UpdateUserPoolClient -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> UpdateUserPoolClient -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UpdateUserPoolClient -> m UpdateUserPoolClient #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateUserPoolClient -> m UpdateUserPoolClient #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateUserPoolClient -> m UpdateUserPoolClient #

Show UpdateUserPoolClient Source # 
Instance details

Defined in Network.AWS.CognitoIdentityProvider.UpdateUserPoolClient

Generic UpdateUserPoolClient Source # 
Instance details

Defined in Network.AWS.CognitoIdentityProvider.UpdateUserPoolClient

Associated Types

type Rep UpdateUserPoolClient :: Type -> Type #

Hashable UpdateUserPoolClient Source # 
Instance details

Defined in Network.AWS.CognitoIdentityProvider.UpdateUserPoolClient

ToJSON UpdateUserPoolClient Source # 
Instance details

Defined in Network.AWS.CognitoIdentityProvider.UpdateUserPoolClient

AWSRequest UpdateUserPoolClient Source # 
Instance details

Defined in Network.AWS.CognitoIdentityProvider.UpdateUserPoolClient

Associated Types

type Rs UpdateUserPoolClient :: Type #

ToHeaders UpdateUserPoolClient Source # 
Instance details

Defined in Network.AWS.CognitoIdentityProvider.UpdateUserPoolClient

ToPath UpdateUserPoolClient Source # 
Instance details

Defined in Network.AWS.CognitoIdentityProvider.UpdateUserPoolClient

ToQuery UpdateUserPoolClient Source # 
Instance details

Defined in Network.AWS.CognitoIdentityProvider.UpdateUserPoolClient

NFData UpdateUserPoolClient Source # 
Instance details

Defined in Network.AWS.CognitoIdentityProvider.UpdateUserPoolClient

Methods

rnf :: UpdateUserPoolClient -> () #

type Rep UpdateUserPoolClient Source # 
Instance details

Defined in Network.AWS.CognitoIdentityProvider.UpdateUserPoolClient

type Rep UpdateUserPoolClient = D1 (MetaData "UpdateUserPoolClient" "Network.AWS.CognitoIdentityProvider.UpdateUserPoolClient" "amazonka-cognito-idp-1.6.1-IATNKTGZSOc4TejpW4Ifw7" False) (C1 (MetaCons "UpdateUserPoolClient'" PrefixI True) (((S1 (MetaSel (Just "_uupcRefreshTokenValidity") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat)) :*: (S1 (MetaSel (Just "_uupcExplicitAuthFlows") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [ExplicitAuthFlowsType])) :*: S1 (MetaSel (Just "_uupcSupportedIdentityProviders") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])))) :*: ((S1 (MetaSel (Just "_uupcLogoutURLs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 (MetaSel (Just "_uupcAllowedOAuthFlowsUserPoolClient") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 (MetaSel (Just "_uupcDefaultRedirectURI") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_uupcWriteAttributes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))))) :*: (((S1 (MetaSel (Just "_uupcReadAttributes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 (MetaSel (Just "_uupcAllowedOAuthScopes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 (MetaSel (Just "_uupcAllowedOAuthFlows") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [OAuthFlowType])) :*: S1 (MetaSel (Just "_uupcAnalyticsConfiguration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe AnalyticsConfigurationType)))) :*: ((S1 (MetaSel (Just "_uupcClientName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_uupcCallbackURLs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 (MetaSel (Just "_uupcUserPoolId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_uupcClientId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Sensitive Text)))))))
type Rs UpdateUserPoolClient Source # 
Instance details

Defined in Network.AWS.CognitoIdentityProvider.UpdateUserPoolClient

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.

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.

uupcAnalyticsConfiguration :: Lens' UpdateUserPoolClient (Maybe AnalyticsConfigurationType) Source #

The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.

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:

data UpdateUserPoolClientResponse Source #

Represents the response from the server to the request to update the user pool client.

See: updateUserPoolClientResponse smart constructor.

Instances
Eq UpdateUserPoolClientResponse Source # 
Instance details

Defined in Network.AWS.CognitoIdentityProvider.UpdateUserPoolClient

Data UpdateUserPoolClientResponse Source # 
Instance details

Defined in Network.AWS.CognitoIdentityProvider.UpdateUserPoolClient

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UpdateUserPoolClientResponse -> c UpdateUserPoolClientResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UpdateUserPoolClientResponse #

toConstr :: UpdateUserPoolClientResponse -> Constr #

dataTypeOf :: UpdateUserPoolClientResponse -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c UpdateUserPoolClientResponse) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UpdateUserPoolClientResponse) #

gmapT :: (forall b. Data b => b -> b) -> UpdateUserPoolClientResponse -> UpdateUserPoolClientResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UpdateUserPoolClientResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UpdateUserPoolClientResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> UpdateUserPoolClientResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> UpdateUserPoolClientResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UpdateUserPoolClientResponse -> m UpdateUserPoolClientResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateUserPoolClientResponse -> m UpdateUserPoolClientResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateUserPoolClientResponse -> m UpdateUserPoolClientResponse #

Show UpdateUserPoolClientResponse Source # 
Instance details

Defined in Network.AWS.CognitoIdentityProvider.UpdateUserPoolClient

Generic UpdateUserPoolClientResponse Source # 
Instance details

Defined in Network.AWS.CognitoIdentityProvider.UpdateUserPoolClient

Associated Types

type Rep UpdateUserPoolClientResponse :: Type -> Type #

NFData UpdateUserPoolClientResponse Source # 
Instance details

Defined in Network.AWS.CognitoIdentityProvider.UpdateUserPoolClient

type Rep UpdateUserPoolClientResponse Source # 
Instance details

Defined in Network.AWS.CognitoIdentityProvider.UpdateUserPoolClient

type Rep UpdateUserPoolClientResponse = D1 (MetaData "UpdateUserPoolClientResponse" "Network.AWS.CognitoIdentityProvider.UpdateUserPoolClient" "amazonka-cognito-idp-1.6.1-IATNKTGZSOc4TejpW4Ifw7" False) (C1 (MetaCons "UpdateUserPoolClientResponse'" PrefixI True) (S1 (MetaSel (Just "_uupcrsUserPoolClient") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe UserPoolClientType)) :*: S1 (MetaSel (Just "_uupcrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))

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.