Amazon WorkMail · JSON Structure

Workmail Get Impersonation Role Effect Request Structure

GetImpersonationRoleEffectRequest schema from Amazon WorkMail API

Type: object Properties: 3 Required: 3
Business CommunicationCalendarEmailExchangeEnterprise

GetImpersonationRoleEffectRequest is a JSON Structure definition published by Amazon WorkMail, describing 3 properties, of which 3 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

OrganizationId ImpersonationRoleId TargetUser

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "type": "object",
  "required": [
    "OrganizationId",
    "ImpersonationRoleId",
    "TargetUser"
  ],
  "name": "GetImpersonationRoleEffectRequest",
  "properties": {
    "OrganizationId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/OrganizationId"
        },
        {
          "description": "The WorkMail organization where the impersonation role is defined."
        }
      ]
    },
    "ImpersonationRoleId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ImpersonationRoleId"
        },
        {
          "description": "The impersonation role ID to test."
        }
      ]
    },
    "TargetUser": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EntityIdentifier"
        },
        {
          "description": "<p>The WorkMail organization user chosen to test the impersonation role. The following identity formats are available:</p> <ul> <li> <p>User ID: <code>12345678-1234-1234-1234-123456789012</code> or <code>S-1-1-12-1234567890-123456789-123456789-1234</code> </p> </li> <li> <p>Email address: <code>user@domain.tld</code> </p> </li> <li> <p>User name: <code>user</code> </p> </li> </ul>"
        }
      ]
    }
  },
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-workmail/refs/heads/main/json-structure/workmail-get-impersonation-role-effect-request-structure.json",
  "description": "GetImpersonationRoleEffectRequest schema from Amazon WorkMail API"
}