List Users

workmail_list_users

R Documentation

Returns summaries of the organization's users

Description

Returns summaries of the organization's users.

Usage

workmail_list_users(OrganizationId, NextToken, MaxResults, Filters)

Arguments

OrganizationId	[required] The identifier for the organization under which the users exist.
NextToken	The token to use to retrieve the next page of results. The first call does not contain any tokens.
MaxResults	The maximum number of results to return in a single call.
Filters	Limit the user search results based on the filter criteria. You can only use one filter per request.

Value

A list with the following syntax:

list(
  Users = list(
    list(
      Id = "string",
      Email = "string",
      Name = "string",
      DisplayName = "string",
      State = "ENABLED"|"DISABLED"|"DELETED",
      UserRole = "USER"|"RESOURCE"|"SYSTEM_USER"|"REMOTE_USER",
      EnabledDate = as.POSIXct(
        "2015-01-01"
      ),
      DisabledDate = as.POSIXct(
        "2015-01-01"
      ),
      IdentityProviderUserId = "string",
      IdentityProviderIdentityStoreId = "string"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_users(
  OrganizationId = "string",
  NextToken = "string",
  MaxResults = 123,
  Filters = list(
    UsernamePrefix = "string",
    DisplayNamePrefix = "string",
    PrimaryEmailPrefix = "string",
    State = "ENABLED"|"DISABLED"|"DELETED",
    IdentityProviderUserIdPrefix = "string"
  )
)