All Products
Search
Document Center

WUYING Workspace:ListDirectoryUsers

Last Updated:Mar 26, 2024

Queries the information about users of an AD directory.

Operation description

If you use an AD directory to connect to an AD system, you can call this operation to obtain the user information in the AD system.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:
    • The required resource types are displayed in bold characters.
    • 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:ListDirectoryUsersLIST
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region.

cn-hangzhou
FilterstringNo

The query string for fuzzy match. If you specify this parameter, the system returns all results that contain the string.

alice
DirectoryIdstringYes

The ID of the AD directory.

cn-hangzhou+dir-jedbpr4sl9l37****
NextTokenstringNo

The token used to start the next query. If the value of this parameter is empty, all results are returned.

caeba0bbb2be03f84eb48b699f0a4883
MaxResultsintegerNo

The number of entries to return on each page.

Valid values: 1 to 100.

Default value: 10.

10
OUPathstringNo

The organizational unit (OU) in the specified AD domain.

example.com/Domain Controllers

Response parameters

ParameterTypeDescriptionExample
object
NextTokenstring

The token used to start the next query. If the value of this parameter is empty, all results are returned.

caeba0bbb2be03f84eb48b699f0a4883
RequestIdstring

The ID of the request.

1CBAFFAB-B697-4049-A9B1-67E1FC5F****
Usersobject []

The names of users corresponding to the AD directory. If the AD directory corresponds only to the Administrator and Guest users, the returned Users value is empty.

EndUserstring

The name of the user.

Alice
DisplayNamestring

The display name.

Alice

Examples

Sample success responses

JSONformat

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "Users": [
    {
      "EndUser": "Alice",
      "DisplayName": "Alice"
    }
  ]
}

Error codes

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

Change history

Change timeSummary of changesOperation
2021-08-19The request parameters of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: OUPath
2021-08-19The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.