PutMailboxPermissions
Sets permissions for a user, group, or resource. This replaces any pre-existing permissions.
Request Syntax
{
"EntityId": "string",
"GranteeId": "string",
"OrganizationId": "string",
"PermissionValues": [ "string" ]
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- EntityId
-
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
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[a-zA-Z0-9._%+@-]+Required: Yes
-
- GranteeId
-
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
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[a-zA-Z0-9._%+@-]+Required: Yes
-
- OrganizationId
-
The identifier of the organization under which the user, group, or resource exists.
Type: String
Length Constraints: Fixed length of 34.
Pattern:
^m-[0-9a-f]{32}$Required: Yes
- PermissionValues
-
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.
Type: Array of strings
Valid Values:
FULL_ACCESS | SEND_AS | SEND_ON_BEHALFRequired: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors.
- EntityNotFoundException
-
The identifier supplied for the user, group, or resource does not exist in your organization.
HTTP Status Code: 400
- EntityStateException
-
You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
HTTP Status Code: 400
- InvalidParameterException
-
One or more of the input parameters don't match the service's restrictions.
HTTP Status Code: 400
- OrganizationNotFoundException
-
An operation received a valid organization identifier that either doesn't belong or exist in the system.
HTTP Status Code: 400
- OrganizationStateException
-
The organization must have a valid state to perform certain operations on the organization or its members.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
