Request Syntax Request Parameters Response Elements Errors See Also

UpdateImpersonationRole

Updates an impersonation role for the given WorkMail organization.

Request Syntax


{
   "Description": "string",
   "ImpersonationRoleId": "string",
   "Name": "string",
   "OrganizationId": "string",
   "Rules": [ 
      { 
         "Description": "string",
         "Effect": "string",
         "ImpersonationRuleId": "string",
         "Name": "string",
         "NotTargetUsers": [ "string" ],
         "TargetUsers": [ "string" ]
      }
   ],
   "Type": "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.

Description

The updated impersonation role description.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [^\x00-\x09\x0B\x0C\x0E-\x1F\x7F\x3C\x3E\x5C]+

Required: No

ImpersonationRoleId

The ID of the impersonation role to update.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [a-zA-Z0-9_-]+

Required: Yes

Name

The updated impersonation role name.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [^\x00-\x1F\x7F\x3C\x3E\x5C]+

Required: Yes

OrganizationId

The WorkMail organization that contains the impersonation role to update.

Type: String

Length Constraints: Fixed length of 34.

Pattern: ^m-[0-9a-f]{32}$

Required: Yes

Rules

The updated list of rules.

Type: Array of ImpersonationRule objects

Array Members: Minimum number of 0 items. Maximum number of 10 items.

Required: Yes

Type

The updated impersonation role type.

Type: String

Valid Values: FULL_ACCESS | READ_ONLY

Required: 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

LimitExceededException

The request exceeds the limit of the resource.

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

ResourceNotFoundException

The resource cannot be found.

HTTP Status Code: 400