LockUsers-阿里云帮助中心

Operation description

For security purposes, you can lock convenience users. Locked convenience users cannot log on to Wuying terminals and therefore cannot access any cloud resources.

Note

You can call DescribeUsers to query convenience user information. If the Status field in the response is 0, the convenience user is not locked. If the Status field is 9, the convenience user is locked.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ecd:LockUsers

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Users	array	Yes	The usernames of the convenience users to lock.	test1
	string	Yes	The username of the convenience user to lock.	alice
LogoutSession	boolean	No	Specifies whether to log off the current session of the convenience user when the user is locked.
BusinessChannel	string	No	The channel.	ENTERPRISE

Response elements

Element	Type	Description	Example
	object	The returned information.
RequestId	string	The request ID.	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
LockUsersResult	object	The result of the lock operation for the convenience users.
LockedUsers	array	The list of convenience users that are successfully locked.
	string	The convenience user that is successfully locked.	alice
FailedUsers	array<object>	The list of convenience users that fail to be locked.
	object	The information about the convenience user that fails to be locked.
EndUserId	string	The convenience user that fails to be locked.	alice
ErrorCode	string	The error code.	InvalidUsername
ErrorMessage	string	The error message.	test123 is an invalid username.

Examples

Success response

JSON format

{
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "LockUsersResult": {
    "LockedUsers": [
      "alice"
    ],
    "FailedUsers": [
      {
        "EndUserId": "alice",
        "ErrorCode": "InvalidUsername",
        "ErrorMessage": "test123 is an invalid username."
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.