Returns all the groups to which an entity belongs¶

Description¶

Returns all the groups to which an entity belongs.

Usage¶

workmail_list_groups_for_entity(OrganizationId, EntityId, Filters,
  NextToken, MaxResults)

Arguments¶

• OrganizationId

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

• EntityId

  [required] The identifier for the entity.

  The entity ID can accept UserId or GroupID, Username or Groupname, or email.

  • Entity ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234
  • Email address: entity@domain.tld
  • Entity name: entity

• Filters

  Limit the search results based on the filter criteria.

• 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(
  Groups = list(
    list(
      GroupId = "string",
      GroupName = "string"
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$list_groups_for_entity(
  OrganizationId = "string",
  EntityId = "string",
  Filters = list(
    GroupNamePrefix = "string"
  ),
  NextToken = "string",
  MaxResults = 123
)