Amazonka.CognitoIdentityProvider.AdminDisableProviderForUser

Prevents the user from signing in with the specified external (SAML or social) identity provider (IdP). If the user that you want to deactivate is a Amazon Cognito user pools native username + password user, they can't use their password to sign in. If the user to deactivate is a linked external IdP user, any link between that user and an existing user is removed. When the external user signs in again, and the user is no longer attached to the previously linked DestinationUser, the user 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 deactivate a native username + password user, the ProviderName value must be Cognito and the ProviderAttributeName must be Cognito_Subject. The ProviderAttributeValue must be the name that is used in the user pool for the user.

The ProviderAttributeName must always be Cognito_Subject for social IdPs. 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 using 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

data AdminDisableProviderForUser

See: newAdminDisableProviderForUser smart constructor.

Constructors

AdminDisableProviderForUser'

Fields

• userPoolId :: Text

  The user pool ID for the user pool.

• user :: ProviderUserIdentifierType

  The user to be disabled.

Instances

ToJSON AdminDisableProviderForUser

Defined in Amazonka.CognitoIdentityProvider.AdminDisableProviderForUser

Methods

toJSON :: AdminDisableProviderForUser -> Value

toEncoding :: AdminDisableProviderForUser -> Encoding

toJSONList :: [AdminDisableProviderForUser] -> Value

toEncodingList :: [AdminDisableProviderForUser] -> Encoding

ToHeaders AdminDisableProviderForUser

Defined in Amazonka.CognitoIdentityProvider.AdminDisableProviderForUser

Methods

toHeaders :: AdminDisableProviderForUser -> [Header]

ToPath AdminDisableProviderForUser

Defined in Amazonka.CognitoIdentityProvider.AdminDisableProviderForUser

Methods

toPath :: AdminDisableProviderForUser -> ByteString

ToQuery AdminDisableProviderForUser

Defined in Amazonka.CognitoIdentityProvider.AdminDisableProviderForUser

Methods

toQuery :: AdminDisableProviderForUser -> QueryString

AWSRequest AdminDisableProviderForUser

Defined in Amazonka.CognitoIdentityProvider.AdminDisableProviderForUser

Associated Types

type AWSResponse AdminDisableProviderForUser

Methods

request :: (Service -> Service) -> AdminDisableProviderForUser -> Request AdminDisableProviderForUser

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy AdminDisableProviderForUser -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse AdminDisableProviderForUser)))

Generic AdminDisableProviderForUser

Defined in Amazonka.CognitoIdentityProvider.AdminDisableProviderForUser

Associated Types

type Rep AdminDisableProviderForUser :: Type -> Type

Methods

from :: AdminDisableProviderForUser -> Rep AdminDisableProviderForUser x

to :: Rep AdminDisableProviderForUser x -> AdminDisableProviderForUser

Read AdminDisableProviderForUser

Defined in Amazonka.CognitoIdentityProvider.AdminDisableProviderForUser

Methods

readsPrec :: Int -> ReadS AdminDisableProviderForUser

readList :: ReadS [AdminDisableProviderForUser]

readPrec :: ReadPrec AdminDisableProviderForUser

readListPrec :: ReadPrec [AdminDisableProviderForUser]

Show AdminDisableProviderForUser

Defined in Amazonka.CognitoIdentityProvider.AdminDisableProviderForUser

Methods

showsPrec :: Int -> AdminDisableProviderForUser -> ShowS

show :: AdminDisableProviderForUser -> String

showList :: [AdminDisableProviderForUser] -> ShowS

NFData AdminDisableProviderForUser

Defined in Amazonka.CognitoIdentityProvider.AdminDisableProviderForUser

Methods

rnf :: AdminDisableProviderForUser -> ()

Eq AdminDisableProviderForUser

Defined in Amazonka.CognitoIdentityProvider.AdminDisableProviderForUser

Methods

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

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

Hashable AdminDisableProviderForUser

Defined in Amazonka.CognitoIdentityProvider.AdminDisableProviderForUser

Methods

hashWithSalt :: Int -> AdminDisableProviderForUser -> Int

hash :: AdminDisableProviderForUser -> Int

type AWSResponse AdminDisableProviderForUser

Defined in Amazonka.CognitoIdentityProvider.AdminDisableProviderForUser

type AWSResponse AdminDisableProviderForUser = AdminDisableProviderForUserResponse

type Rep AdminDisableProviderForUser

Defined in Amazonka.CognitoIdentityProvider.AdminDisableProviderForUser

type Rep AdminDisableProviderForUser = D1 ('MetaData "AdminDisableProviderForUser" "Amazonka.CognitoIdentityProvider.AdminDisableProviderForUser" "amazonka-cognito-idp-2.0-D1ERgMvEVPG9z8cOLXdU2" 'False) (C1 ('MetaCons "AdminDisableProviderForUser'" 'PrefixI 'True) (S1 ('MetaSel ('Just "userPoolId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "user") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ProviderUserIdentifierType)))

newAdminDisableProviderForUser

Arguments

:: Text

AdminDisableProviderForUser

-> ProviderUserIdentifierType

$sel:user:AdminDisableProviderForUser'

-> AdminDisableProviderForUser

Create a value of AdminDisableProviderForUser with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

AdminDisableProviderForUser, adminDisableProviderForUser_userPoolId - The user pool ID for the user pool.

$sel:user:AdminDisableProviderForUser', adminDisableProviderForUser_user - The user to be disabled.

Request Lenses

adminDisableProviderForUser_userPoolId :: Lens' AdminDisableProviderForUser Text

The user pool ID for the user pool.

adminDisableProviderForUser_user :: Lens' AdminDisableProviderForUser ProviderUserIdentifierType

The user to be disabled.

Destructuring the Response

data AdminDisableProviderForUserResponse

See: newAdminDisableProviderForUserResponse smart constructor.

Constructors

AdminDisableProviderForUserResponse'

Fields

• httpStatus :: Int

  The response's http status code.

Instances

Generic AdminDisableProviderForUserResponse

Defined in Amazonka.CognitoIdentityProvider.AdminDisableProviderForUser

Associated Types

type Rep AdminDisableProviderForUserResponse :: Type -> Type

Methods

from :: AdminDisableProviderForUserResponse -> Rep AdminDisableProviderForUserResponse x

to :: Rep AdminDisableProviderForUserResponse x -> AdminDisableProviderForUserResponse

Read AdminDisableProviderForUserResponse

Defined in Amazonka.CognitoIdentityProvider.AdminDisableProviderForUser

Methods

readsPrec :: Int -> ReadS AdminDisableProviderForUserResponse

readList :: ReadS [AdminDisableProviderForUserResponse]

readPrec :: ReadPrec AdminDisableProviderForUserResponse

readListPrec :: ReadPrec [AdminDisableProviderForUserResponse]

Show AdminDisableProviderForUserResponse

Defined in Amazonka.CognitoIdentityProvider.AdminDisableProviderForUser

Methods

showsPrec :: Int -> AdminDisableProviderForUserResponse -> ShowS

show :: AdminDisableProviderForUserResponse -> String

showList :: [AdminDisableProviderForUserResponse] -> ShowS

NFData AdminDisableProviderForUserResponse

Defined in Amazonka.CognitoIdentityProvider.AdminDisableProviderForUser

Methods

rnf :: AdminDisableProviderForUserResponse -> ()

Eq AdminDisableProviderForUserResponse

Defined in Amazonka.CognitoIdentityProvider.AdminDisableProviderForUser

Methods

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

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

type Rep AdminDisableProviderForUserResponse

Defined in Amazonka.CognitoIdentityProvider.AdminDisableProviderForUser

type Rep AdminDisableProviderForUserResponse = D1 ('MetaData "AdminDisableProviderForUserResponse" "Amazonka.CognitoIdentityProvider.AdminDisableProviderForUser" "amazonka-cognito-idp-2.0-D1ERgMvEVPG9z8cOLXdU2" 'False) (C1 ('MetaCons "AdminDisableProviderForUserResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newAdminDisableProviderForUserResponse

Arguments

:: Int

$sel:httpStatus:AdminDisableProviderForUserResponse'

-> AdminDisableProviderForUserResponse

Create a value of AdminDisableProviderForUserResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:AdminDisableProviderForUserResponse', adminDisableProviderForUserResponse_httpStatus - The response's http status code.

Response Lenses

adminDisableProviderForUserResponse_httpStatus :: Lens' AdminDisableProviderForUserResponse Int

The response's http status code.