Skip to content

Describe Users

workdocs_describe_users R Documentation

Describes the specified users

Description

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.

Usage

workdocs_describe_users(AuthenticationToken, OrganizationId, UserIds,
  Query, Include, Order, Sort, Marker, Limit, Fields)

Arguments

AuthenticationToken

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

OrganizationId

The ID of the organization.

UserIds

The IDs of the users.

Query

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.

Include

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

Order

The order for the results.

Sort

The sorting criteria.

Marker

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

Limit

The maximum number of items to return.

Fields

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

Value

A list with the following syntax: 

list(
  Users = list(
    list(
      Id = "string",
      Username = "string",
      EmailAddress = "string",
      GivenName = "string",
      Surname = "string",
      OrganizationId = "string",
      RootFolderId = "string",
      RecycleBinFolderId = "string",
      Status = "ACTIVE"|"INACTIVE"|"PENDING",
      Type = "USER"|"ADMIN"|"POWERUSER"|"MINIMALUSER"|"WORKSPACESUSER",
      CreatedTimestamp = as.POSIXct(
        "2015-01-01"
      ),
      ModifiedTimestamp = as.POSIXct(
        "2015-01-01"
      ),
      TimeZoneId = "string",
      Locale = "en"|"fr"|"ko"|"de"|"es"|"ja"|"ru"|"zh_CN"|"zh_TW"|"pt_BR"|"default",
      Storage = list(
        StorageUtilizedInBytes = 123,
        StorageRule = list(
          StorageAllocatedInBytes = 123,
          StorageType = "UNLIMITED"|"QUOTA"
        )
      )
    )
  ),
  TotalNumberOfUsers = 123,
  Marker = "string"
)

Request syntax

svc$describe_users(
  AuthenticationToken = "string",
  OrganizationId = "string",
  UserIds = "string",
  Query = "string",
  Include = "ALL"|"ACTIVE_PENDING",
  Order = "ASCENDING"|"DESCENDING",
  Sort = "USER_NAME"|"FULL_NAME"|"STORAGE_LIMIT"|"USER_STATUS"|"STORAGE_USED",
  Marker = "string",
  Limit = 123,
  Fields = "string"
)