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 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.
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 to be disabled.
Type: ProviderUserIdentifierType object
Required: Yes
- UserPoolId
-
The user pool ID for the user pool.
Type: String
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 or phone number that has already been supplied as an alias from a different account. This exception tells user that an account with this email or phone already exists.
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 is not authorized.
HTTP Status Code: 400
- ResourceNotFoundException
-
This exception is thrown when the Amazon Cognito service cannot 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 is not found.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: