Describes the specified users. You can describe all users or filter the results (for example, by status or organization).
See https://www.paws-r-sdk.com/docs/workdocs_describe_users/ for full documentation.
workdocs_describe_users(
AuthenticationToken = NULL,
OrganizationId = NULL,
UserIds = NULL,
Query = NULL,
Include = NULL,
Order = NULL,
Sort = NULL,
Marker = NULL,
Limit = NULL,
Fields = NULL
)Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
The ID of the organization.
The IDs of the users.
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
create_user 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.
The state of the users. Specify "ALL" to include inactive users.
The order for the results.
The sorting criteria.
The marker for the next set of results. (You received this marker from a previous call.)
The maximum number of items to return.
A comma-separated list of values. Specify "STORAGE_METADATA" to include the user storage quota and utilization information.