AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the DescribeUsers operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.WorkDocs.AmazonWorkDocsRequest
      Amazon.WorkDocs.Model.DescribeUsersRequest

Namespace: Amazon.WorkDocs.Model
Assembly: AWSSDK.WorkDocs.dll
Version: 3.x.y.z

Syntax

C# 
public class DescribeUsersRequest : AmazonWorkDocsRequest
         IAmazonWebServiceRequest

The DescribeUsersRequest type exposes the following members

Constructors

NameDescription
Public Method DescribeUsersRequest()

Properties

NameTypeDescription
Public Property AuthenticationToken System.String

Gets and sets the property AuthenticationToken.

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

Public Property Fields System.String

Gets and sets the property Fields.

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

Public Property Include Amazon.WorkDocs.UserFilterType

Gets and sets the property Include.

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

Public Property Limit System.Int32

Gets and sets the property Limit.

The maximum number of items to return.

Public Property Marker System.String

Gets and sets the property Marker.

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

Public Property Order Amazon.WorkDocs.OrderType

Gets and sets the property Order.

The order for the results.

Public Property OrganizationId System.String

Gets and sets the property OrganizationId.

The ID of the organization.

Public Property Query System.String

Gets and sets the property 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 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.

Public Property Sort Amazon.WorkDocs.UserSortType

Gets and sets the property Sort.

The sorting criteria.

Public Property UserIds System.String

Gets and sets the property UserIds.

The IDs of the users.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5