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.
Note
Amazon Cognito evaluates Amazon 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.
Request Syntax
{
"User": {
"ProviderAttributeName": "string
",
"ProviderAttributeValue": "string
",
"ProviderName": "string
"
},
"UserPoolId": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- User
-
The user profile that you want to delete a linked identity from.
Type: ProviderUserIdentifierType object
Required: Yes
- UserPoolId
-
The ID of the user pool where you want to delete the user's linked identities.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 131072.
Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AliasExistsException
-
This exception is thrown when a user tries to confirm the account with an email address or phone number that has already been supplied as an alias for a different user profile. This exception indicates that an account with this email address or phone already exists in a user pool that you've configured to use email address or phone number as a sign-in alias.
HTTP Status Code: 400
- InternalErrorException
-
This exception is thrown when Amazon Cognito encounters an internal error.
HTTP Status Code: 500
- InvalidParameterException
-
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
HTTP Status Code: 400
- NotAuthorizedException
-
This exception is thrown when a user isn't authorized.
HTTP Status Code: 400
- ResourceNotFoundException
-
This exception is thrown when the Amazon Cognito service can't find the requested resource.
HTTP Status Code: 400
- TooManyRequestsException
-
This exception is thrown when the user has made too many requests for a given operation.
HTTP Status Code: 400
- UserNotFoundException
-
This exception is thrown when a user isn't found.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: