AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Container for the parameters to the AdminDisableUser operation.
Deactivates a user and revokes all access tokens for the user. A deactivated user
can't sign in, but still appears in the responses to
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 moreGetUser
and ListUsers
API requests.
Namespace: Amazon.CognitoIdentityProvider.Model
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z
public class AdminDisableUserRequest : AmazonCognitoIdentityProviderRequest IAmazonWebServiceRequest
The AdminDisableUserRequest type exposes the following members
Name | Description | |
---|---|---|
AdminDisableUserRequest() |
Name | Type | Description | |
---|---|---|---|
Username | System.String |
Gets and sets the property Username.
The username of the user that you want to query or modify. The value of this parameter
is typically your user's username, but it can be any of their alias attributes. If
|
|
UserPoolId | System.String |
Gets and sets the property UserPoolId. The user pool ID for the user pool where you want to disable the user. |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5