Amazon WorkMail

Amazon WorkMail #X Amz Target=WorkMailService.ListAccessControlRules API

The #X Amz Target=WorkMailService.ListAccessControlRules API from Amazon WorkMail — 1 operation(s) for #x amz target=workmailservice.listaccesscontrolrules.

Documentation GitHub OpenAPI

Operations 1

POST /#X-Amz-Target=WorkMailService.ListAccessControlRules Amazon WorkMail List Access Control Rules #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/amazon-workmail-x-amz-target-workmailservice-listaccesscontrolrules-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  version: 1.0.0
  x-release: v4
  title: 'Amazon WorkMail #X Amz Target=WorkMailService.AssociateDelegateToResource #X Amz Target=WorkMailService.AssociateDelegateToResource #X Amz Target=WorkMailService.ListAccessControlRules #X Amz Target=WorkMailService.ListAccessControlRules API'
  description: <p>WorkMail is a secure, managed business email and calendaring service with support for existing desktop and mobile email clients. You can access your email, contacts, and calendars using Microsoft Outlook, your browser, or other native iOS and Android email applications. You can integrate WorkMail with your existing corporate directory and control both the keys that encrypt your data and the location in which your data is stored.</p> <p>The WorkMail API is designed for the following scenarios:</p> <ul> <li> <p>Listing and describing organizations</p> </li> </ul> <ul> <li> <p>Managing users</p> </li> </ul> <ul> <li> <p>Managing groups</p> </li> </ul> <ul> <li> <p>Managing resources</p> </li> </ul> <p>All WorkMail API operations are Amazon-authenticated and certificate-signed. They not only require the use of the AWS SDK, but also allow for the exclusive use of AWS Identity and Access Management users and roles to help facilitate access, trust, and permission policies. By creating a role and allowing an IAM user to access the WorkMail site, the IAM user gains full administrative visibility into the entire WorkMail organization (or as set in the IAM policy). This includes, but is not limited to, the ability to create, update, and delete users, groups, and resources. This allows developers to perform the scenarios listed above, as well as give users the ability to grant access on a selective basis using the IAM model.</p>
  x-logo:
    url: https://twitter.com/awscloud/profile_image?size=original
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: workmail
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/workmail-2017-10-01.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://workmail.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon WorkMail multi-region endpoint
- url: https://workmail.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon WorkMail multi-region endpoint
- url: http://workmail.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon WorkMail endpoint for China (Beijing) and China (Ningxia)
- url: https://workmail.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon WorkMail endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=WorkMailService.ListAccessControlRules'
paths:
  /#X-Amz-Target=WorkMailService.ListAccessControlRules:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    post:
      operationId: ListAccessControlRules
      description: Lists the access control rules for the specified organization.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListAccessControlRulesResponse'
        '480':
          description: OrganizationNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationNotFoundException'
        '481':
          description: OrganizationStateException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationStateException'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListAccessControlRulesRequest'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - WorkMailService.ListAccessControlRules
      summary: Amazon WorkMail List Access Control Rules
      tags:
      - '#X Amz Target=WorkMailService.ListAccessControlRules'
components:
  schemas:
    ImpersonationRoleIdList:
      type: array
      items:
        $ref: '#/components/schemas/ImpersonationRoleId'
      minItems: 0
      maxItems: 10
    AccessControlRule:
      type: object
      properties:
        Name:
          allOf:
          - $ref: '#/components/schemas/AccessControlRuleName'
          - description: The rule name.
        Effect:
          allOf:
          - $ref: '#/components/schemas/AccessControlRuleEffect'
          - description: The rule effect.
        Description:
          allOf:
          - $ref: '#/components/schemas/AccessControlRuleDescription'
          - description: The rule description.
        IpRanges:
          allOf:
          - $ref: '#/components/schemas/IpRangeList'
          - description: IPv4 CIDR ranges to include in the rule.
        NotIpRanges:
          allOf:
          - $ref: '#/components/schemas/IpRangeList'
          - description: IPv4 CIDR ranges to exclude from the rule.
        Actions:
          allOf:
          - $ref: '#/components/schemas/ActionsList'
          - description: Access protocol actions to include in the rule. 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>.
        NotActions:
          allOf:
          - $ref: '#/components/schemas/ActionsList'
          - description: Access protocol actions to exclude from the rule. 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>.
        UserIds:
          allOf:
          - $ref: '#/components/schemas/UserIdList'
          - description: User IDs to include in the rule.
        NotUserIds:
          allOf:
          - $ref: '#/components/schemas/UserIdList'
          - description: User IDs to exclude from the rule.
        DateCreated:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The date that the rule was created.
        DateModified:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The date that the rule was modified.
        ImpersonationRoleIds:
          allOf:
          - $ref: '#/components/schemas/ImpersonationRoleIdList'
          - description: Impersonation role IDs to include in the rule.
        NotImpersonationRoleIds:
          allOf:
          - $ref: '#/components/schemas/ImpersonationRoleIdList'
          - description: Impersonation role IDs to exclude from the rule.
      description: A rule that controls access to an WorkMail organization.
    Timestamp:
      type: string
      format: date-time
    ListAccessControlRulesResponse:
      type: object
      properties:
        Rules:
          allOf:
          - $ref: '#/components/schemas/AccessControlRulesList'
          - description: The access control rules.
    OrganizationId:
      type: string
      pattern: ^m-[0-9a-f]{32}$
      minLength: 34
      maxLength: 34
    AccessControlRuleAction:
      type: string
      pattern: '[a-zA-Z]+'
      minLength: 1
      maxLength: 64
    WorkMailIdentifier:
      type: string
      minLength: 12
      maxLength: 256
    ImpersonationRoleId:
      type: string
      pattern: '[a-zA-Z0-9_-]+'
      minLength: 1
      maxLength: 64
    UserIdList:
      type: array
      items:
        $ref: '#/components/schemas/WorkMailIdentifier'
      minItems: 0
      maxItems: 10
    OrganizationNotFoundException: {}
    IpRangeList:
      type: array
      items:
        $ref: '#/components/schemas/IpRange'
      minItems: 0
      maxItems: 1024
    ActionsList:
      type: array
      items:
        $ref: '#/components/schemas/AccessControlRuleAction'
      minItems: 0
      maxItems: 10
    AccessControlRulesList:
      type: array
      items:
        $ref: '#/components/schemas/AccessControlRule'
      minItems: 0
      maxItems: 10
    IpRange:
      type: string
      pattern: ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])/([0-9]|[12][0-9]|3[0-2])$
      minLength: 1
      maxLength: 18
    ListAccessControlRulesRequest:
      type: object
      required:
      - OrganizationId
      title: ListAccessControlRulesRequest
      properties:
        OrganizationId:
          allOf:
          - $ref: '#/components/schemas/OrganizationId'
          - description: The identifier for the organization.
    AccessControlRuleName:
      type: string
      pattern: '[a-zA-Z0-9_-]+'
      minLength: 1
      maxLength: 64
    AccessControlRuleEffect:
      type: string
      enum:
      - ALLOW
      - DENY
    AccessControlRuleDescription:
      type: string
      pattern: '[\u0020-\u00FF]+'
      minLength: 0
      maxLength: 255
    OrganizationStateException: {}
  parameters:
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/workmail/
x-hasEquivalentPaths: true