DescribeUsersRequest

import type { DescribeUsersRequest } from "https://aws-api.deno.dev/v0.4/services/workdocs.ts?docs=full";

interface DescribeUsersRequest {

AuthenticationToken?: string | null;

Fields?: string | null;

Include?: UserFilterType | null;

Limit?: number | null;

Marker?: string | null;

Order?: OrderType | null;

OrganizationId?: string | null;

Query?: string | null;

Sort?: UserSortType | null;

UserIds?: string | null;

}

§Properties

AuthenticationToken?: string | null

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

Fields?: string | null

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

Include?: UserFilterType | null

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

Limit?: number | null

The maximum number of items to return.

Marker?: string | null

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

Order?: OrderType | null

The order for the results.

OrganizationId?: string | null

The ID of the organization.

Query?: string | null

A query to filter users by user name. Remember the following about the Userids and Query parameters:

If you don't use either parameter, the API returns a paginated list of all users on the site.
If you use both parameters, the API ignores the Query parameter.
The Userid parameter only returns user names that match a corresponding user ID.
The Query parameter runs a "prefix" search for users by the GivenName, SurName, or UserName fields included in a CreateUser API call. For example, querying on Ma 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 Ma J only returns Mateo Jackson.

Sort?: UserSortType | null

The sorting criteria.

UserIds?: string | null

The IDs of the users.