Skip to content

List Group Members

workmail_list_group_members R Documentation

Returns an overview of the members of a group

Description

Returns an overview of the members of a group. Users and groups can be members of a group.

Usage

workmail_list_group_members(OrganizationId, GroupId, NextToken,
  MaxResults)

Arguments

OrganizationId

[required] The identifier for the organization under which the group exists.

GroupId

[required] The identifier for the group to which the members (users or groups) are associated.

The identifier can accept GroupId, Groupname, or email. The following identity formats are available:

  • Group ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234

  • Email address: group@domain.tld

  • Group name: group

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.

Value

A list with the following syntax: 

list(
  Members = list(
    list(
      Id = "string",
      Name = "string",
      Type = "GROUP"|"USER",
      State = "ENABLED"|"DISABLED"|"DELETED",
      EnabledDate = as.POSIXct(
        "2015-01-01"
      ),
      DisabledDate = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_group_members(
  OrganizationId = "string",
  GroupId = "string",
  NextToken = "string",
  MaxResults = 123
)