Amazon WorkMail · Schema

PutMailboxPermissionsRequest

PutMailboxPermissionsRequest schema from Amazon WorkMail API

Business CommunicationCalendarEmailExchangeEnterprise

Properties

Name Type Description
OrganizationId object
EntityId object
GranteeId object
PermissionValues object
View JSON Schema on GitHub

JSON Schema

workmail-put-mailbox-permissions-request-schema.json Raw ↑
{
  "type": "object",
  "required": [
    "OrganizationId",
    "EntityId",
    "GranteeId",
    "PermissionValues"
  ],
  "title": "PutMailboxPermissionsRequest",
  "properties": {
    "OrganizationId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/OrganizationId"
        },
        {
          "description": "The identifier of the organization under which the user, group, or resource exists."
        }
      ]
    },
    "EntityId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WorkMailIdentifier"
        },
        {
          "description": "The identifier of the user, group, or resource for which to update mailbox permissions."
        }
      ]
    },
    "GranteeId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WorkMailIdentifier"
        },
        {
          "description": "The identifier of the user, group, or resource to which to grant the permissions."
        }
      ]
    },
    "PermissionValues": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PermissionValues"
        },
        {
          "description": "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."
        }
      ]
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-workmail/refs/heads/main/json-schema/workmail-put-mailbox-permissions-request-schema.json",
  "description": "PutMailboxPermissionsRequest schema from Amazon WorkMail API"
}