Describe Entity

workmail_describe_entity

R Documentation

Returns basic details about an entity in WorkMail

Description

Returns basic details about an entity in WorkMail.

Usage

workmail_describe_entity(OrganizationId, Email)

Arguments

OrganizationId

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

Email

[required] The email under which the entity exists.

Value

A list with the following syntax:

list(
  EntityId = "string",
  Name = "string",
  Type = "GROUP"|"USER"|"RESOURCE"
)

Request syntax

svc$describe_entity(
  OrganizationId = "string",
  Email = "string"
)