Network.AWS.CognitoIdentityProvider.AdminDisableProviderForUser

Disables the user from signing in with the specified external (SAML or social) identity provider. If the user to disable is a Cognito User Pools native username + password user, they are not permitted to use their password to sign-in. If the user to disable is a linked external IdP user, any link between that user and an existing user is removed. The next time the external user (no longer attached to the previously linked DestinationUser ) signs in, they must create a new user account. See AdminLinkProviderForUser .

This action is enabled only for admin access and requires developer credentials.

The ProviderName must match the value specified when creating an IdP for the pool.

To disable a native username + password user, the ProviderName value must be Cognito and the ProviderAttributeName must be Cognito_Subject , with the ProviderAttributeValue being the name that is used in the user pool for the user.

The ProviderAttributeName must always be Cognito_Subject for social identity providers. The ProviderAttributeValue must always be the exact subject that was used when the user was originally linked as a source user.

For de-linking a SAML identity, there are two scenarios. If the linked identity has not yet been used to sign-in, the ProviderAttributeName and ProviderAttributeValue must be the same values that were used for the SourceUser when the identities were originally linked in the AdminLinkProviderForUser call. (If the linking was done with ProviderAttributeName set to Cognito_Subject , the same applies here). However, if the user has already signed in, the ProviderAttributeName must be Cognito_Subject and ProviderAttributeValue must be the subject of the SAML assertion.

Creating a Request

adminDisableProviderForUser

Arguments

:: Text

adpfuUserPoolId

-> ProviderUserIdentifierType

adpfuUser

-> AdminDisableProviderForUser

Creates a value of AdminDisableProviderForUser with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• adpfuUserPoolId - The user pool ID for the user pool.
• adpfuUser - The user to be disabled.

data AdminDisableProviderForUser

See: adminDisableProviderForUser smart constructor.

Instances

Eq AdminDisableProviderForUser

Methods

(==) :: AdminDisableProviderForUser -> AdminDisableProviderForUser -> Bool

(/=) :: AdminDisableProviderForUser -> AdminDisableProviderForUser -> Bool

Data AdminDisableProviderForUser

Methods

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

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

toConstr :: AdminDisableProviderForUser -> Constr

dataTypeOf :: AdminDisableProviderForUser -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c AdminDisableProviderForUser)

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

gmapT :: (forall b. Data b => b -> b) -> AdminDisableProviderForUser -> AdminDisableProviderForUser

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

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

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

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

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

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

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

Read AdminDisableProviderForUser

Methods

readsPrec :: Int -> ReadS AdminDisableProviderForUser

readList :: ReadS [AdminDisableProviderForUser]

readPrec :: ReadPrec AdminDisableProviderForUser

readListPrec :: ReadPrec [AdminDisableProviderForUser]

Show AdminDisableProviderForUser

Methods

showsPrec :: Int -> AdminDisableProviderForUser -> ShowS

show :: AdminDisableProviderForUser -> String

showList :: [AdminDisableProviderForUser] -> ShowS

Generic AdminDisableProviderForUser

Associated Types

type Rep AdminDisableProviderForUser :: * -> *

Methods

from :: AdminDisableProviderForUser -> Rep AdminDisableProviderForUser x

to :: Rep AdminDisableProviderForUser x -> AdminDisableProviderForUser

Hashable AdminDisableProviderForUser

Methods

hashWithSalt :: Int -> AdminDisableProviderForUser -> Int

hash :: AdminDisableProviderForUser -> Int

ToJSON AdminDisableProviderForUser

Methods

toJSON :: AdminDisableProviderForUser -> Value

toEncoding :: AdminDisableProviderForUser -> Encoding

toJSONList :: [AdminDisableProviderForUser] -> Value

toEncodingList :: [AdminDisableProviderForUser] -> Encoding

NFData AdminDisableProviderForUser

Methods

rnf :: AdminDisableProviderForUser -> ()

AWSRequest AdminDisableProviderForUser

Associated Types

type Rs AdminDisableProviderForUser :: *

Methods

request :: AdminDisableProviderForUser -> Request AdminDisableProviderForUser

response :: MonadResource m => Logger -> Service -> Proxy * AdminDisableProviderForUser -> ClientResponse -> m (Response AdminDisableProviderForUser)

ToQuery AdminDisableProviderForUser

Methods

toQuery :: AdminDisableProviderForUser -> QueryString

ToPath AdminDisableProviderForUser

Methods

toPath :: AdminDisableProviderForUser -> ByteString

ToHeaders AdminDisableProviderForUser

Methods

toHeaders :: AdminDisableProviderForUser -> [Header]

type Rep AdminDisableProviderForUser

type Rep AdminDisableProviderForUser = D1 (MetaData "AdminDisableProviderForUser" "Network.AWS.CognitoIdentityProvider.AdminDisableProviderForUser" "amazonka-cognito-idp-1.5.0-6L4ibyApQsq9OINZIpqhIF" False) (C1 (MetaCons "AdminDisableProviderForUser'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_adpfuUserPoolId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_adpfuUser") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ProviderUserIdentifierType))))

type Rs AdminDisableProviderForUser

type Rs AdminDisableProviderForUser = AdminDisableProviderForUserResponse

Request Lenses

adpfuUserPoolId :: Lens' AdminDisableProviderForUser Text

The user pool ID for the user pool.

adpfuUser :: Lens' AdminDisableProviderForUser ProviderUserIdentifierType

The user to be disabled.

Destructuring the Response

adminDisableProviderForUserResponse

Arguments

:: Int

adpfursResponseStatus

-> AdminDisableProviderForUserResponse

Creates a value of AdminDisableProviderForUserResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• adpfursResponseStatus - -- | The response status code.

data AdminDisableProviderForUserResponse

See: adminDisableProviderForUserResponse smart constructor.

Instances

Eq AdminDisableProviderForUserResponse

Methods

(==) :: AdminDisableProviderForUserResponse -> AdminDisableProviderForUserResponse -> Bool

(/=) :: AdminDisableProviderForUserResponse -> AdminDisableProviderForUserResponse -> Bool

Data AdminDisableProviderForUserResponse

Methods

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

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

toConstr :: AdminDisableProviderForUserResponse -> Constr

dataTypeOf :: AdminDisableProviderForUserResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c AdminDisableProviderForUserResponse)

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

gmapT :: (forall b. Data b => b -> b) -> AdminDisableProviderForUserResponse -> AdminDisableProviderForUserResponse

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

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

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

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

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

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

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

Read AdminDisableProviderForUserResponse

Methods

readsPrec :: Int -> ReadS AdminDisableProviderForUserResponse

readList :: ReadS [AdminDisableProviderForUserResponse]

readPrec :: ReadPrec AdminDisableProviderForUserResponse

readListPrec :: ReadPrec [AdminDisableProviderForUserResponse]

Show AdminDisableProviderForUserResponse

Methods

showsPrec :: Int -> AdminDisableProviderForUserResponse -> ShowS

show :: AdminDisableProviderForUserResponse -> String

showList :: [AdminDisableProviderForUserResponse] -> ShowS

Generic AdminDisableProviderForUserResponse

Associated Types

type Rep AdminDisableProviderForUserResponse :: * -> *

Methods

from :: AdminDisableProviderForUserResponse -> Rep AdminDisableProviderForUserResponse x

to :: Rep AdminDisableProviderForUserResponse x -> AdminDisableProviderForUserResponse

NFData AdminDisableProviderForUserResponse

Methods

rnf :: AdminDisableProviderForUserResponse -> ()

type Rep AdminDisableProviderForUserResponse

type Rep AdminDisableProviderForUserResponse = D1 (MetaData "AdminDisableProviderForUserResponse" "Network.AWS.CognitoIdentityProvider.AdminDisableProviderForUser" "amazonka-cognito-idp-1.5.0-6L4ibyApQsq9OINZIpqhIF" True) (C1 (MetaCons "AdminDisableProviderForUserResponse'" PrefixI True) (S1 (MetaSel (Just Symbol "_adpfursResponseStatus") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)))

Response Lenses

adpfursResponseStatus :: Lens' AdminDisableProviderForUserResponse Int

• - | The response status code.