LockUsers-阿里云帮助中心

Operation description

For security purposes, you can lock convenience accounts. Locked convenience users cannot sign in to Wuying clients, and therefore cannot access any Wuying cloud resources.

Note

Call the DescribeUsers operation to check the lock status of convenience accounts. The Status value in the response is 0 for unlocked accounts and 9 for locked accounts.

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 accounts to lock.	test1
	string	Yes	The username of the convenience account to lock.	alice
LogoutSession	boolean	No
BusinessChannel	string	No	The channel.	ENTERPRISE

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The request ID.	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
LockUsersResult	object	The result of the LockUsers operation.
LockedUsers	array	A list of successfully locked convenience accounts.
	string	A successfully locked convenience account.	alice
FailedUsers	array<object>	A list of convenience accounts that failed to lock.
	object	Details of a convenience account that failed to lock.
EndUserId	string	The username of the convenience account that failed to lock.	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.