Amazon WorkMail · Schema

GetAccessControlEffectRequest

GetAccessControlEffectRequest schema from Amazon WorkMail API

Business CommunicationCalendarEmailExchangeEnterprise

Properties

Name Type Description
OrganizationId object
IpAddress object
Action object
UserId object
ImpersonationRoleId object
View JSON Schema on GitHub

JSON Schema

workmail-get-access-control-effect-request-schema.json Raw ↑
{
  "type": "object",
  "required": [
    "OrganizationId",
    "IpAddress",
    "Action"
  ],
  "title": "GetAccessControlEffectRequest",
  "properties": {
    "OrganizationId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/OrganizationId"
        },
        {
          "description": "The identifier for the organization."
        }
      ]
    },
    "IpAddress": {
      "allOf": [
        {
          "$ref": "#/components/schemas/IpAddress"
        },
        {
          "description": "The IPv4 address."
        }
      ]
    },
    "Action": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AccessControlRuleAction"
        },
        {
          "description": "The access protocol action. Valid values include <code>ActiveSync</code>, <code>AutoDiscover</code>, <code>EWS</code>, <code>IMAP</code>, <code>SMTP</code>, <code>WindowsOutlook</code>, and <code>WebMail</code>."
        }
      ]
    },
    "UserId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WorkMailIdentifier"
        },
        {
          "description": "The user ID."
        }
      ]
    },
    "ImpersonationRoleId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ImpersonationRoleId"
        },
        {
          "description": "The impersonation role ID."
        }
      ]
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-workmail/refs/heads/main/json-schema/workmail-get-access-control-effect-request-schema.json",
  "description": "GetAccessControlEffectRequest schema from Amazon WorkMail API"
}