Skip to content

Describe Group

workmail_describe_group R Documentation

Returns the data available for the group

Description

Returns the data available for the group.

Usage

workmail_describe_group(OrganizationId, GroupId)

Arguments

OrganizationId

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

GroupId

[required] The identifier for the group to be described.

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

Value

A list with the following syntax: 

list(
  GroupId = "string",
  Name = "string",
  Email = "string",
  State = "ENABLED"|"DISABLED"|"DELETED",
  EnabledDate = as.POSIXct(
    "2015-01-01"
  ),
  DisabledDate = as.POSIXct(
    "2015-01-01"
  ),
  HiddenFromGlobalAddressList = TRUE|FALSE
)

Request syntax

svc$describe_group(
  OrganizationId = "string",
  GroupId = "string"
)