Skip to content

List Mailbox Permissions

workmail_list_mailbox_permissions R Documentation

Lists the mailbox permissions associated with a user, group, or resource mailbox

Description

Lists the mailbox permissions associated with a user, group, or resource mailbox.

Usage

workmail_list_mailbox_permissions(OrganizationId, EntityId, NextToken,
  MaxResults)

Arguments

OrganizationId

[required] The identifier of the organization under which the user, group, or resource exists.

EntityId

[required] The identifier of the user, or resource for which to list mailbox permissions.

The entity ID can accept UserId or ResourceId, Username or Resourcename, or email.

  • Entity ID: 12345678-1234-1234-1234-123456789012, or r-0123456789a0123456789b0123456789

  • Email address: entity@domain.tld

  • Entity name: entity

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(
  Permissions = list(
    list(
      GranteeId = "string",
      GranteeType = "GROUP"|"USER",
      PermissionValues = list(
        "FULL_ACCESS"|"SEND_AS"|"SEND_ON_BEHALF"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_mailbox_permissions(
  OrganizationId = "string",
  EntityId = "string",
  NextToken = "string",
  MaxResults = 123
)