put_mailbox_permissions ¶

put_mailbox_permissions(
    organization_id: OrganizationId,
    entity_id: EntityIdentifier,
    grantee_id: EntityIdentifier,
    permission_values: PermissionValues,
    *,
    config_overrides: Optional[WorkMailClientConfig] = None,
) -> PutMailboxPermissionsResponse

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

Parameters:

organization_id (OrganizationId) –

The identifier of the organization under which the user, group, or resource exists.
entity_id (EntityIdentifier) –
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: [email protected]
- Entity name: entity
grantee_id (EntityIdentifier) –
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: [email protected]
- Grantee name: grantee
permission_values (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.

Raises:

EntityNotFoundException –

The identifier supplied for the user, group, or resource does not exist in your organization.
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.
InvalidParameterException –

One or more of the input parameters don't match the service's restrictions.
OrganizationNotFoundException –

An operation received a valid organization identifier that either doesn't belong or exist in the system.
OrganizationStateException –

The organization must have a valid state to perform certain operations on the organization or its members.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_workmail/_services/work_mail.py

def put_mailbox_permissions(
    self,
    organization_id: "capo_workmail.types.organization_id.OrganizationId",
    entity_id: "capo_workmail.types.entity_identifier.EntityIdentifier",
    grantee_id: "capo_workmail.types.entity_identifier.EntityIdentifier",
    permission_values: "capo_workmail.types.permission_values.PermissionValues",
    *,
    config_overrides: Optional[WorkMailClientConfig] = None,
) -> "capo_workmail.types.put_mailbox_permissions_response.PutMailboxPermissionsResponse":
    """<p>Sets permissions for a user, group, or resource. This replaces any pre-existing permissions.</p>

    Args:
        organization_id: <p>The identifier of the organization under which the user, group, or resource exists.</p>
        entity_id: <p>The identifier of the user or resource for which to update mailbox permissions.</p> <p>The identifier can be <i>UserId, ResourceID, or Group Id</i>, <i>Username, Resourcename, or Groupname</i>, or <i>email</i>.</p> <ul> <li> <p>Entity ID: 12345678-1234-1234-1234-123456789012, r-0123456789a0123456789b0123456789, or S-1-1-12-1234567890-123456789-123456789-1234</p> </li> <li> <p>Email address: [email protected]</p> </li> <li> <p>Entity name: entity</p> </li> </ul>
        grantee_id: <p>The identifier of the user, group, or resource to which to grant the permissions.</p> <p>The identifier can be <i>UserId, ResourceID, or Group Id</i>, <i>Username, Resourcename, or Groupname</i>, or <i>email</i>.</p> <ul> <li> <p>Grantee ID: 12345678-1234-1234-1234-123456789012, r-0123456789a0123456789b0123456789, or S-1-1-12-1234567890-123456789-123456789-1234</p> </li> <li> <p>Email address: [email protected]</p> </li> <li> <p>Grantee name: grantee</p> </li> </ul>
        permission_values: <p>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.</p>

    Raises:
        capo_workmail.errors.entity_not_found_exception.EntityNotFoundException: <p>The identifier supplied for the user, group, or resource does not exist in your organization.</p>
        capo_workmail.errors.entity_state_exception.EntityStateException: <p>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.</p>
        capo_workmail.errors.invalid_parameter_exception.InvalidParameterException: <p>One or more of the input parameters don't match the service's restrictions.</p>
        capo_workmail.errors.organization_not_found_exception.OrganizationNotFoundException: <p>An operation received a valid organization identifier that either doesn't belong or exist in the system.</p>
        capo_workmail.errors.organization_state_exception.OrganizationStateException: <p>The organization must have a valid state to perform certain operations on the organization or its members.</p>
        capo_workmail.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_workmail.types.put_mailbox_permissions_request.PutMailboxPermissionsRequest]",
    ) -> OperationResponse[
        "capo_workmail.types.put_mailbox_permissions_response.PutMailboxPermissionsResponse"
    ]:
        import capo_workmail._operations.work_mail_service.put_mailbox_permissions

        output, http_response = (
            capo_workmail._operations.work_mail_service.put_mailbox_permissions.put_mailbox_permissions(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("PutMailboxPermissions")
    )
    input_: capo_workmail.types.put_mailbox_permissions_request.PutMailboxPermissionsRequest = {
        "organization_id": organization_id,
        "entity_id": entity_id,
        "grantee_id": grantee_id,
        "permission_values": permission_values,
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output