/AWS1/CL_WDX=>DESCRIBEUSERS()
¶
About 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.
Method Signature¶
IMPORTING¶
Optional arguments:¶
IV_AUTHENTICATIONTOKEN
TYPE /AWS1/WDXAUTHNTCTNHEADERTYPE
/AWS1/WDXAUTHNTCTNHEADERTYPE
¶
Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
IV_ORGANIZATIONID
TYPE /AWS1/WDXIDTYPE
/AWS1/WDXIDTYPE
¶
The ID of the organization.
IV_USERIDS
TYPE /AWS1/WDXUSERIDSTYPE
/AWS1/WDXUSERIDSTYPE
¶
The IDs of the users.
IV_QUERY
TYPE /AWS1/WDXSEARCHQUERYTYPE
/AWS1/WDXSEARCHQUERYTYPE
¶
A query to filter users by user name. Remember the following about the
Userids
andQuery
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 theGivenName
,SurName
, orUserName
fields included in a CreateUser API call. For example, querying onMa
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 onMa J
only returns Mateo Jackson.
IV_INCLUDE
TYPE /AWS1/WDXUSERFILTERTYPE
/AWS1/WDXUSERFILTERTYPE
¶
The state of the users. Specify "ALL" to include inactive users.
IV_ORDER
TYPE /AWS1/WDXORDERTYPE
/AWS1/WDXORDERTYPE
¶
The order for the results.
IV_SORT
TYPE /AWS1/WDXUSERSORTTYPE
/AWS1/WDXUSERSORTTYPE
¶
The sorting criteria.
IV_MARKER
TYPE /AWS1/WDXPAGEMARKERTYPE
/AWS1/WDXPAGEMARKERTYPE
¶
The marker for the next set of results. (You received this marker from a previous call.)
IV_LIMIT
TYPE /AWS1/WDXLIMITTYPE
/AWS1/WDXLIMITTYPE
¶
The maximum number of items to return.
IV_FIELDS
TYPE /AWS1/WDXFIELDNAMESTYPE
/AWS1/WDXFIELDNAMESTYPE
¶
A comma-separated list of values. Specify "STORAGE_METADATA" to include the user storage quota and utilization information.