v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1444236171.7 KB

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.

get/api/v1/users

Query parameters

organizationIdstring

The ID of the organization.

userIdsstring

The IDs of the users.

querystring password
<p>A query to filter users by user name. Remember the following about the <code>Userids</code> and <code>Query</code> parameters:</p> <ul> <li> <p>If you don't use either parameter, the API returns a paginated list of all users on the site.</p> </li> <li> <p>If you use both parameters, the API ignores the <code>Query</code> parameter.</p> </li> <li> <p>The <code>Userid</code> parameter only returns user names that match a corresponding user ID.</p> </li> <li> <p>The <code>Query</code> parameter runs a "prefix" search for users by the <code>GivenName</code>, <code>SurName</code>, or <code>UserName</code> fields included in a <a href="https://docs.aws.amazon.com/workdocs/latest/APIReference/API_CreateUser.html">CreateUser</a> API call. For example, querying on <code>Ma</code> returns Márcia Oliveira, María García, and Mateo Jackson. If you use multiple characters, the API only returns data that matches all characters. For example, querying on <code>Ma J</code> only returns Mateo Jackson.</p> </li> </ul>
include'ALL' | 'ACTIVE_PENDING'

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

order'ASCENDING' | 'DESCENDING'

The order for the results.

sort'USER_NAME' | 'FULL_NAME' | 'STORAGE_LIMIT' | 'USER_STATUS' | 'STORAGE_USED'

The sorting criteria.

markerstring

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

limitinteger

The maximum number of items to return.

fieldsstring

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

Limitstring

Pagination limit

Markerstring

Pagination token

Headers

Authenticationstring password

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

Response

Success

TotalNumberOfUsersinteger

The total number of users included in the results.

Markerstring

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