/AWS1/CL_CGP=>ADMINDISABLEPROVIDERFORUSER()¶
About 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.
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.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_USERPOOLID TYPE /AWS1/CGPSTRINGTYPE /AWS1/CGPSTRINGTYPE¶
The user pool ID for the user pool.
IO_USER TYPE REF TO /AWS1/CL_CGPPROVIDERUSERIDTYPE /AWS1/CL_CGPPROVIDERUSERIDTYPE¶
The user to be disabled.