Menu
Amazon WorkDocs
API Reference (API Version 2016-05-01)

DescribeUsers

Describes the specified users. You can describe all users or filter the results (for example, by status or organization).

By default, Amazon WorkDocs returns the first 24 active or pending users. If there are more results, the response includes a marker that you can use to request the next set of results.

Request Syntax

Copy
GET /api/v1/users?fields=Fields&include=Include&limit=Limit&marker=Marker&order=Order&organizationId=OrganizationId&query=Query&sort=Sort&userIds=UserIds HTTP/1.1 Authentication: AuthenticationToken

URI Request Parameters

The request requires the following URI parameters.

AuthenticationToken

Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.

Length Constraints: Minimum length of 1. Maximum length of 8199.

Fields

A comma-separated list of values. Specify "STORAGE_METADATA" to include the user storage quota and utilization information.

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [\w,]+

Include

The state of the users. Specify "ALL" to include inactive users.

Valid Values: ALL | ACTIVE_PENDING

Limit

The maximum number of items to return.

Valid Range: Minimum value of 1. Maximum value of 999.

Marker

The marker for the next set of results. (You received this marker from a previous call.)

Length Constraints: Minimum length of 1. Maximum length of 2048.

Order

The order for the results.

Valid Values: ASCENDING | DESCENDING

OrganizationId

The ID of the organization.

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [&\w+-.@]+

Query

A query to filter users by user name.

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: [\u0020-\uFFFF]+

Sort

The sorting criteria.

Valid Values: USER_NAME | FULL_NAME | STORAGE_LIMIT | USER_STATUS | STORAGE_USED

UserIds

The IDs of the users.

Length Constraints: Minimum length of 1. Maximum length of 2000.

Pattern: [&\w+-.@, ]+

Request Body

The request does not have a request body.

Response Syntax

Copy
HTTP/1.1 200 Content-type: application/json { "Marker": "string", "TotalNumberOfUsers": number, "Users": [ { "CreatedTimestamp": number, "EmailAddress": "string", "GivenName": "string", "Id": "string", "Locale": "string", "ModifiedTimestamp": number, "OrganizationId": "string", "RecycleBinFolderId": "string", "RootFolderId": "string", "Status": "string", "Storage": { "StorageRule": { "StorageAllocatedInBytes": number, "StorageType": "string" }, "StorageUtilizedInBytes": number }, "Surname": "string", "TimeZoneId": "string", "Type": "string", "Username": "string" } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Marker

The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

TotalNumberOfUsers

The total number of users included in the results.

Type: Long

Users

The users.

Type: Array of User objects

Errors

For information about the errors that are common to all actions, see Common Errors.

FailedDependencyException

The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.

HTTP Status Code: 424

InvalidArgumentException

The pagination marker or limit fields are not valid.

HTTP Status Code: 400

ServiceUnavailableException

One or more of the dependencies is unavailable.

HTTP Status Code: 503

UnauthorizedOperationException

The operation is not permitted.

HTTP Status Code: 403

UnauthorizedResourceAccessException

The caller does not have access to perform the action on the resource.

HTTP Status Code: 404

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: