All Products
Search
Document Center

App Streaming:LockUsers

Last Updated:Feb 20, 2025

Locks one or more convenience users.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ecd:LockUsersupdate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
UsersarrayYes

The usernames of the convenience users that you want to lock.

stringYes

The username of the convenience user that you want to lock.

test1

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

1CBAFFAB-B697-4049-A9B1-67E1FC5F****
LockUsersResultobject

The result of the locking the convenience user.

LockedUsersarray

The convenience users that were locked.

LockedUsersstring

The convenience user that was locked.

test1
FailedUsersarray<object>

The convenience users that failed to be locked.

FailedUsersobject

The convenience user that failed to be locked.

EndUserIdstring

The ID of the convenience user that failed to be locked.

test123
ErrorCodestring

The error code.

InvalidUsername
ErrorMessagestring

The error message.

test123 is an invalid username.

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-11-06The request parameters of the API has changedView Change Details