Put Mailbox Permissions

workmail_put_mailbox_permissions

R Documentation

Sets permissions for a user, group, or resource¶

Description¶

Sets permissions for a user, group, or resource. This replaces any pre-existing permissions.

Usage¶

workmail_put_mailbox_permissions(OrganizationId, EntityId, GranteeId,
  PermissionValues)

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 update mailbox permissions.

The identifier can be UserId, ResourceID, or Group Id, Username, Resourcename, or Groupname, or email.

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

GranteeId

[required] The identifier of the user, group, or resource to which to grant the permissions.

The identifier can be UserId, ResourceID, or Group Id, Username, Resourcename, or Groupname, or email.

Grantee ID: 12345678-1234-1234-1234-123456789012, r-0123456789a0123456789b0123456789, or S-1-1-12-1234567890-123456789-123456789-1234
Email address: grantee@domain.tld
Grantee name: grantee

PermissionValues

[required] The permissions granted to the grantee. SEND_AS allows the grantee to send email as the owner of the mailbox (the grantee is not mentioned on these emails). SEND_ON_BEHALF allows the grantee to send email on behalf of the owner of the mailbox (the grantee is not mentioned as the physical sender of these emails). FULL_ACCESS allows the grantee full access to the mailbox, irrespective of other folder-level permissions set on the mailbox.

Value¶

An empty list.

Request syntax¶

svc$put_mailbox_permissions(
  OrganizationId = "string",
  EntityId = "string",
  GranteeId = "string",
  PermissionValues = list(
    "FULL_ACCESS"|"SEND_AS"|"SEND_ON_BEHALF"
  )
)