openapi: 3.0.0
info:
  version: 2015-07-09
  x-release: v4
  title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Email Security Settings API
  description: <fullname>Amazon API Gateway</fullname> <p>Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.</p>
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
    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: apigateway
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/apigateway-2015-07-09.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
      version: 1.0.0
    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://apigateway.{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 API Gateway multi-region endpoint
- url: https://apigateway.{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 API Gateway multi-region endpoint
- url: http://apigateway.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia)
- url: https://apigateway.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: Email Security Settings
paths:
  /accounts/{account_id}/email-security/settings/allow_patterns:
    delete:
      operationId: email_security_delete_allow_patterns
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/email-security_AccountId'
      requestBody:
        content:
          application/json:
            schema:
              items:
                properties:
                  id:
                    example: 2401
                    format: int32
                    title: identifier
                    type: integer
                required:
                - id
                type: object
              minItems: 1
              type: array
        required: true
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                - properties:
                    result:
                      items:
                        properties:
                          id:
                            example: 2401
                            format: int32
                            title: identifier
                            type: integer
                        required:
                        - id
                        type: object
                      minItems: 1
                      type: array
                  required:
                  - result
                  type: object
          description: ''
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Delete multiple email allow patterns
      tags:
      - Email Security Settings
    get:
      description: List, search, and sort an accounts's email allow patterns.
      operationId: email_security_list_allow_patterns
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/email-security_AccountId'
      - description: Page number of paginated results.
        in: query
        name: page
        schema:
          default: 1
          format: int32
          minimum: 1
          type: integer
      - description: Number of results to display.
        in: query
        name: per_page
        schema:
          default: 20
          format: int32
          minimum: 1
          type: integer
      - description: The field to sort by.
        in: query
        name: order
        schema:
          enum:
          - pattern
          - created_at
          type: string
      - description: The sorting direction.
        in: query
        name: direction
        schema:
          allOf:
          - $ref: '#/components/schemas/email-security_SortingDirection'
      - description: 'Allows searching in multiple properties of a record simultaneously.

          This parameter is intended for human users, not automation. Its exact

          behavior is intentionally left unspecified and is subject to change

          in the future.'
        in: query
        name: search
        schema:
          type: string
      - in: query
        name: is_sender
        schema:
          type: boolean
      - in: query
        name: is_recipient
        schema:
          type: boolean
      - in: query
        name: is_spoof
        schema:
          type: boolean
      - in: query
        name: verify_sender
        schema:
          type: boolean
      - in: query
        name: pattern_type
        schema:
          allOf:
          - $ref: '#/components/schemas/email-security_PatternType'
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                - properties:
                    result:
                      items:
                        $ref: '#/components/schemas/email-security_AllowPattern'
                      type: array
                    result_info:
                      $ref: '#/components/schemas/email-security_ResultInfo'
                  required:
                  - result
                  - result_info
                  type: object
          description: List of allow-patterns for the provided account
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform List email allow patterns
      tags:
      - Email Security Settings
    post:
      operationId: email_security_create_allow_pattern
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/email-security_AccountId'
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
              - $ref: '#/components/schemas/email-security_CreateAllowPattern'
              - items:
                  $ref: '#/components/schemas/email-security_CreateAllowPattern'
                type: array
        required: true
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        '201':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                - properties:
                    result:
                      oneOf:
                      - $ref: '#/components/schemas/email-security_AllowPattern'
                      - items:
                          $ref: '#/components/schemas/email-security_AllowPattern'
                        type: array
                  required:
                  - result
                  type: object
          description: Returns the newly created patterns in the same shape as the request body
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Create an email allow pattern
      tags:
      - Email Security Settings
  /accounts/{account_id}/email-security/settings/allow_patterns/{pattern_id}:
    delete:
      operationId: email_security_delete_allow_pattern
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/email-security_AccountId'
      - in: path
        name: pattern_id
        required: true
        schema:
          example: 2401
          format: int32
          title: identifier
          type: integer
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                - properties:
                    result:
                      properties:
                        id:
                          example: 2401
                          format: int32
                          title: identifier
                          type: integer
                      required:
                      - id
                      type: object
                  required:
                  - result
                  type: object
          description: ''
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Delete an email allow pattern
      tags:
      - Email Security Settings
    get:
      operationId: email_security_get_allow_pattern
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/email-security_AccountId'
      - in: path
        name: pattern_id
        required: true
        schema:
          example: 2401
          format: int32
          title: identifier
          type: integer
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                - properties:
                    result:
                      allOf:
                      - additionalProperties: false
                        example:
                          comments: Trust all messages send from test@example.com
                          is_recipient: false
                          is_regex: false
                          is_sender: true
                          is_spoof: false
                          pattern: test@example.com
                          pattern_type: EMAIL
                          verify_sender: true
                        properties:
                          comments:
                            nullable: true
                            type: string
                          is_recipient:
                            type: boolean
                          is_regex:
                            type: boolean
                          is_sender:
                            type: boolean
                          is_spoof:
                            type: boolean
                          pattern:
                            minLength: 1
                            type: string
                          pattern_type:
                            $ref: '#/components/schemas/email-security_PatternType'
                          verify_sender:
                            type: boolean
                        required:
                        - is_recipient
                        - is_sender
                        - is_spoof
                        - pattern
                        - is_regex
                        - verify_sender
                        - pattern_type
                        type: object
                      - properties:
                          created_at:
                            format: date-time
                            type: string
                          id:
                            example: 2401
                            format: int32
                            title: identifier
                            type: integer
                          last_modified:
                            format: date-time
                            type: string
                        required:
                        - id
                        - created_at
                        - last_modified
                        type: object
                      example:
                        comments: Trust all messages send from test@example.com
                        created_at: '2023-11-14T22:13:20Z'
                        id: 2401
                        is_recipient: false
                        is_regex: false
                        is_sender: true
                        is_spoof: false
                        last_modified: '2023-11-14T22:13:20Z'
                        pattern: test@example.com
                        pattern_type: EMAIL
                        verify_sender: true
                  required:
                  - result
                  type: object
          description: ''
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Get an email allow pattern
      tags:
      - Email Security Settings
    patch:
      operationId: email_security_update_allow_pattern
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/email-security_AccountId'
      - in: path
        name: pattern_id
        required: true
        schema:
          example: 2401
          format: int32
          title: identifier
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                comments:
                  nullable: true
                  type: string
                is_recipient:
                  nullable: true
                  type: boolean
                is_regex:
                  nullable: true
                  type: boolean
                is_sender:
                  nullable: true
                  type: boolean
                is_spoof:
                  nullable: true
                  type: boolean
                pattern:
                  minLength: 1
                  nullable: true
                  type: string
                pattern_type:
                  allOf:
                  - $ref: '#/components/schemas/email-security_PatternType'
                  - nullable: true
                    type: string
                verify_sender:
                  nullable: true
                  type: boolean
              type: object
        required: true
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                - properties:
                    result:
                      allOf:
                      - additionalProperties: false
                        example:
                          comments: Trust all messages send from test@example.com
                          is_recipient: false
                          is_regex: false
                          is_sender: true
                          is_spoof: false
                          pattern: test@example.com
                          pattern_type: EMAIL
                          verify_sender: true
                        properties:
                          comments:
                            nullable: true
                            type: string
                          is_recipient:
                            type: boolean
                          is_regex:
                            type: boolean
                          is_sender:
                            type: boolean
                          is_spoof:
                            type: boolean
                          pattern:
                            minLength: 1
                            type: string
                          pattern_type:
                            $ref: '#/components/schemas/email-security_PatternType'
                          verify_sender:
                            type: boolean
                        required:
                        - is_recipient
                        - is_sender
                        - is_spoof
                        - pattern
                        - is_regex
                        - verify_sender
                        - pattern_type
                        type: object
                      - properties:
                          created_at:
                            format: date-time
                            type: string
                          id:
                            example: 2401
                            format: int32
                            title: identifier
                            type: integer
                          last_modified:
                            format: date-time
                            type: string
                        required:
                        - id
                        - created_at
                        - last_modified
                        type: object
                      example:
                        comments: Trust all messages send from test@example.com
                        created_at: '2023-11-14T22:13:20Z'
                        id: 2401
                        is_recipient: false
                        is_regex: false
                        is_sender: true
                        is_spoof: false
                        last_modified: '2023-11-14T22:13:20Z'
                        pattern: test@example.com
                        pattern_type: EMAIL
                        verify_sender: true
                  required:
                  - result
                  type: object
          description: ''
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Update an email allow pattern
      tags:
      - Email Security Settings
  /accounts/{account_id}/email-security/settings/block_senders:
    delete:
      operationId: email_security_delete_blocked_senders
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/email-security_AccountId'
      requestBody:
        content:
          application/json:
            schema:
              items:
                properties:
                  id:
                    example: 2402
                    format: int32
                    title: identifier
                    type: integer
                required:
                - id
                type: object
              minItems: 1
              type: array
        required: true
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                - properties:
                    result:
                      items:
                        properties:
                          id:
                            example: 2402
                            format: int32
                            title: identifier
                            type: integer
                        required:
                        - id
                        type: object
                      minItems: 1
                      type: array
                  required:
                  - result
                  type: object
          description: ''
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Delete multiple blocked email senders
      tags:
      - Email Security Settings
    get:
      operationId: email_security_list_blocked_senders
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/email-security_AccountId'
      - description: Page number of paginated results.
        in: query
        name: page
        schema:
          default: 1
          format: int32
          minimum: 1
          type: integer
      - description: Number of results to display.
        in: query
        name: per_page
        schema:
          default: 20
          format: int32
          minimum: 1
          type: integer
      - description: The field to sort by.
        in: query
        name: order
        schema:
          enum:
          - pattern
          - created_at
          type: string
      - description: The sorting direction.
        in: query
        name: direction
        schema:
          allOf:
          - $ref: '#/components/schemas/email-security_SortingDirection'
      - description: 'Allows searching in multiple properties of a record simultaneously.

          This parameter is intended for human users, not automation. Its exact

          behavior is intentionally left unspecified and is subject to change

          in the future.'
        in: query
        name: search
        schema:
          type: string
      - in: query
        name: pattern_type
        schema:
          allOf:
          - $ref: '#/components/schemas/email-security_PatternType'
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                - properties:
                    result:
                      items:
                        $ref: '#/components/schemas/email-security_BlockedSender'
                      type: array
                    result_info:
                      $ref: '#/components/schemas/email-security_ResultInfo'
                  required:
                  - result
                  - result_info
                  type: object
          description: List of blocked senders for the provided account
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform List blocked email senders
      tags:
      - Email Security Settings
    post:
      operationId: email_security_create_blocked_sender
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/email-security_AccountId'
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
              - $ref: '#/components/schemas/email-security_CreateBlockedSender'
              - items:
                  $ref: '#/components/schemas/email-security_CreateBlockedSender'
                type: array
        required: true
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        '201':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                - properties:
                    result:
                      oneOf:
                      - $ref: '#/components/schemas/email-security_BlockedSender'
                      - items:
                          $ref: '#/components/schemas/email-security_BlockedSender'
                        type: array
                  required:
                  - result
                  type: object
          description: Returns the newly created patterns in the same shape as the request body
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Create a blocked email sender
      tags:
      - Email Security Settings
  /accounts/{account_id}/email-security/settings/block_senders/{pattern_id}:
    delete:
      operationId: email_security_delete_blocked_sender
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/email-security_AccountId'
      - in: path
        name: pattern_id
        required: true
        schema:
          example: 2402
          format: int32
          title: identifier
          type: integer
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                - properties:
                    result:
                      properties:
                        id:
                          example: 2402
                          format: int32
                          title: identifier
                          type: integer
                      required:
                      - id
                      type: object
                  required:
                  - result
                  type: object
          description: ''
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Delete a blocked email sender
      tags:
      - Email Security Settings
    get:
      operationId: email_security_get_blocked_sender
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/email-security_AccountId'
      - in: path
        name: pattern_id
        required: true
        schema:
          example: 2402
          format: int32
          title: identifier
          type: integer
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                - properties:
                    result:
                      allOf:
                      - additionalProperties: false
                        example:
                          comments: block sender with email test@example.com
                          is_regex: false
                          pattern: test@example.com
                          pattern_type: EMAIL
                        properties:
                          comments:
                            nullable: true
                            type: string
                          is_regex:
                            type: boolean
                          pattern:
                            minLength: 1
                            type: string
                          pattern_type:
                            $ref: '#/components/schemas/email-security_PatternType'
                        required:
                        - pattern
                        - is_regex
                        - pattern_type
                        type: object
                      - properties:
                          created_at:
                            format: date-time
                            type: string
                          id:
                            example: 2402
                            format: int32
                            title: identifier
                            type: integer
                          last_modified:
                            format: date-time
                            type: string
                        required:
                        - id
                        - created_at
                        - last_modified
                        type: object
                      example:
                        comments: block sender with email test@example.com
                        created_at: '2023-11-14T22:13:20Z'
                        id: 2402
                        is_regex: false
                        last_modified: '2023-11-14T22:13:20Z'
                        pattern: test@example.com
                        pattern_type: EMAIL
                  required:
                  - result
                  type: object
          description: ''
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Get a blocked email sender
      tags:
      - Email Security Settings
    patch:
      operationId: email_security_update_blocked_sender
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/email-security_AccountId'
      - in: path
        name: pattern_id
        required: true
        schema:
          example: 2402
          format: int32
          title: identifier
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                comments:
                  nullable: true
                  type: string
                is_regex:
                  nullable: true
                  type: boolean
                pattern:
                  minLength: 1
                  nullable: true
                  type: string
                pattern_type:
                  allOf:
                  - $ref: '#/components/schemas/email-security_PatternType'
                  - nullable: true
                    type: string
              type: object
        required: true
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                - properties:
                    result:
                      allOf:
                      - additionalProperties: false
                        example:
                          comments: block sender with email test@example.com
                          is_regex: false
                          pattern: test@example.com
                          pattern_type: EMAIL
                        properties:
                          comments:
                            nullable: true
                            type: string
                          is_regex:
                            type: boolean
                          pattern:
                            minLength: 1
                            type: string
                          pattern_type:
                            $ref: '#/components/schemas/email-security_PatternType'
                        required:
                        - pattern
                        - is_regex
                        - pattern_type
                        type: object
                      - properties:
                          created_at:
                            format: date-time
                            type: string
                          id:
                            example: 2402
                            format: int32
                            title: identifier
                            type: integer
                          last_modified:
                            format: date-time
                            type: string
                        required:
                        - id
                        - created_at
                        - last_modified
                        type: object
                      example:
                        comments: block sender with email test@example.com
                        created_at: '2023-11-14T22:13:20Z'
                        id: 2402
                        is_regex: false
                        last_modified: '2023-11-14T22:13:20Z'
                        pattern: test@example.com
                        pattern_type: EMAIL
                  required:
                  - result
                  type: object
          description: ''
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Update a blocked email sender
      tags:
      - Email Security Settings
  /accounts/{account_id}/email-security/settings/domains:
    delete:
      operationId: email_security_delete_domains
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/email-security_AccountId'
      requestBody:
        content:
          application/json:
            schema:
              items:
                properties:
                  id:
                    description: Unique domain identifier
                    example: 2400
                    format: int32
                    type: integer
                required:
                - id
                type: object
              minItems: 1
              type: array
        required: true
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                - properties:
                    result:
                      items:
                        properties:
                          id:
                            description: Unique domain identifier
                            example: 2400
                            format: int32
                            type: integer
                        required:
                        - id
                        type: object
                      minItems: 1
                      type: array
                  required:
                  - result
                  type: object
          description: ''
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Unprotect multiple email domains
      tags:
      - Email Security Settings
    get:
      description: List, search, and sort an account's email domains.
      operationId: email_security_list_domains
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/email-security_AccountId'
      - description: Page number of paginated results.
        in: query
        name: page
        schema:
          default: 1
          format: int32
          minimum: 1
          type: integer
      - description: Number of results to display.
        in: query
        name: per_page
        schema:
          default: 20
          format: int32
          minimum: 1
          type: integer
      - description: The field to sort by.
        in: query
        name: order
        schema:
          enum:
          - domain
          - created_at
          type: string
      - description: The sorting direction.
        in: query
        name: direction
        schema:
          allOf:
          - $ref: '#/components/schemas/email-security_SortingDirection'
      - description: 'Allows searching in multiple properties of a record simultaneously.

          This parameter is intended for human users, not automation. Its exact

          behavior is intentionally left unspecified and is subject to change

          in the future.'
        in: query
        name: search
        schema:
          type: string
      - description: If present, the response contains only domains with the provided delivery mode.
        in: query
        name: allowed_delivery_mode
        schema:
          allOf:
          - $ref: '#/components/schemas/email-security_DeliveryMode'
      - description: 'Filter result by the provided domains.

          Allows for multiple occurrences, e.g., `domain=example.com&domain=example.xyz`.'
        in: query
        name: domain
        schema:
          items:
            type: string
          type: array
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                - properties:
                    result:
                      items:
                        $ref: '#/components/schemas/email-security_Domain'
                      type: array
                    result_info:
                      $ref: '#/components/schemas/email-security_ResultInfo'
                  required:
                  - result
                  - result_info
                  type: object
          description: List of domains for the provided account
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform List protected email domains
      tags:
      - Email Security Settings
  /accounts/{account_id}/email-security/settings/domains/{domain_id}:
    delete:
      operationId: email_security_delete_domain
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/email-security_AccountId'
      - in: path
        name: domain_id
        required: true
        schema:
          description: Unique domain identifier
          example: 2400
          format: int32
          type: integer
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                - properties:
                    result:
                      properties:
                        id:
                          description: Unique domain identifier
                          example: 2400
                          format: int32
                          type: integer
                      required:
                      - id
                      type: object
                  required:
                  - result
                  type: object
          description: Delete the domain with the provided id
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Unprotect an email domain
      tags:
      - Email Security Settings
    patch:
      operationId: email_security_update_domain
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/email-security_AccountId'
      - in: path
        name: domain_id
        required: true
        schema:
          description: Unique domain identifier
          example: 2400
          format: int32
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                domain:
                  nullable: true
                  type: string
                lookback_hops:
                  format: int32
                  maximum: 20
                  minimum: 1
                  nullable: true
                  type: integer
              type: object
        required: true
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                - properties:
                    result:
                      example:
                        allowed_delivery_modes:
                        - API
                        created_at: '2023-11-14T22:13:20Z'
                        domain: example.com
                        id: 2400
                        integration_id: a5dbb180-60ea-4578-84bb-d01a5d4e50c3
                        last_modified: '2023-11-14T22:13:20Z'
                        lookback_hops: 2
                        o365_tenant_id: c3c3239d-8858-47df-9618-0e2d9bdf6aa8
                      properties:
                        allowed_delivery_modes:
                          items:
                            $ref: '#/components/schemas/email-security_DeliveryMode'
                          type: array
                        created_at:
                          format: date-time
                          type: string
                        domain:
                          type: string
                        id:
                          description: Unique domain identifier
                          example: 2400
                          format: int32
                          type: integer
                        integration_id:
                          format: uuid
                          nullable: true
                          type: string
                        last_modified:
                          format: date-time
                          type: string
                        lookback_hops:
                          format: int32
                          type: integer
                        o365_tenant_id:
                          nullable: true
                          type: string
                      required:
                      - id
                      - created_at
                      - last_modified
                      - domain
                      - allowed_delivery_modes
                      - lookback_hops
                      type: object
                  required:
                  - result
                  type: object
          description: ''
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Update an email domain
      tags:
      - Email Security Settings
  /accounts/{account_id}/email-security/settings/impersonation_registry:
    delete:
      operationId: email_security_delete_display_names
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/email-security_AccountId'
      requestBody:
        content:
          application/json:
            schema:
              items:
                properties:
                  id:
                    example: 2403
                    format: int32
                    title: identifier
                    type: integer
                required:
                - id
                type: object
              minItems: 1
              type: array
        required: true
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                - properties:
                    result:
                      items:
                        properties:
                          id:
                            example: 2403
                            format: int32
                            title: identifier
                            type: integer
                        required:
                        - id
                        type: object
                      minItems: 1
                      type: array
                  required:
                  - result
                  type: object
          description: ''
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Delete multiple entries from impersonation registry
      tags:
      - Email Security Settings
    get:
      description: List, search, and sort entries in impersonation registry.
      operationId: email_security_list_display_names
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/email-security_AccountId'
      - description: Page number of paginated results.
        in: query
        name: page
        schema:
          default: 1
          format: int32
          minimum: 1
          type: integer
      - description: Number of results to display.
        in: query
        name: per_page
        schema:
          default: 20
          format: int32
          minimum: 1
          type: integer
      - description: The field to sort by.
        in: query
        name: order
        schema:
          enum:
          - name
          - email
          - created_at
          type: string
      - description: The sorting direction.
        in: query
        name: direction
        schema:
          allOf:
          - $ref: '#/components/schemas/email-security_SortingDirection'
      - description: 'Allows searching in multiple properties of a record simultaneously.

          This parameter is intended for human users, not automation. Its exact

          behavior is intentionally left unspecified and is subject to change

          in the future.'
        in: query
        name: search
        schema:
          type: string
      - in: query
        name: provenance
        schema:
          allOf:
          - enum:
            - A1S_INTERNAL
            - SNOOPY-CASB_OFFICE_365
            - SNOOPY-OFFICE_365
            - SNOOPY-GOOGLE_DIRECTORY
            type: string
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                - properties:
                    result:
                      items:
                        $ref: '#/components/schemas/email-security_DisplayName'
                      type: array
                    result_info:
                      $ref: '#/components/schemas/email-security_ResultInfo'
                  required:
                  - result
                  - result_info
                  type: object
          description: List of impersonation registry entries for the provided account
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform List entries in impersonation registry
      tags:
      - Email Security Settings
    post:
      operationId: email_security_create_display_name
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/email-security_AccountId'
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
              - $ref: '#/components/schemas/email-security_CreateDisplayName'
              - items:
                  $ref: '#/components/schemas/email-security_CreateDisplayName'
                type: array
        required: true
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        '201':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                - properties:
                    result:
                      oneOf:
                      - $ref: '#/components/schemas/email-security_DisplayName'
                      - items:
                          $ref: '#/components/schemas/email-security_DisplayName'
                        type: array
                  required:
                  - result
                  type: object
          description: Returns the newly created entry in the same shape as the request body
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Create an entry in impersonation registry
      tags:
      - Email Security Settings
  /accounts/{account_id}/email-security/settings/impersonation_registry/{display_name_id}:
    delete:
      operationId: email_security_delete_display_name
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/email-security_AccountId'
      - in: path
        name: display_name_id
        required: true
        schema:
          example: 2403
          format: int32
          title: identifier
          type: integer
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                - properties:
                    result:
                      properties:
                        id:
                          example: 2403
                          format: int32
                          title: identifier
                          type: integer
                      required:
                      - id
                      type: object
                  required:
                  - result
                  type: object
          description: ''
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Delete an entry from impersonation registry
      tags:
      - Email Security Settings
    get:
      operationId: email_security_get_display_name
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/email-security_AccountId'
      - in: path
        name: display_name_id
        required: true
        schema:
          example: 2403
          format: int32
          title: identifier
          type: integer
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                - properties:
                    result:
                      properties:
                        comments:
                          nullable: true
                          type: string
                        created_at:
                          format: date-time
                          type: string
                        directory_id:
                          allOf:
                          - format: int64
                            type: integer
                          - nullable: true
                            type: integer
                        directory_node_id:
                          nullable: true
                          type: string
                        email:
                          nullable: true
                          type: string
                        id:
                          example: 2403
                          format: int32
                          title: identifier
                          type: integer
                        is_email_regex:
                          type: boolean
                        last_modified:
                          format: date-time
                          type: string
                        name:
                          type: string
                        provenance:
                          nullable: true
                          type: string
                      required:
                      - id
                      - created_at
                      - last_modified
                      - name
                      - is_email_regex
                      type: object
                  required:
                  - result
                  type: object
          description: ''
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Get an entry in impersonation registry
      tags:
      - Email Security Settings
    patch:
      operationId: email_security_update_display_name
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/email-security_AccountId'
      - in: path
        name: display_name_id
        required: true
        schema:
          example: 2403
          format: int32
          title: identifier
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                email:
                  nullable: true
                  type: string
                is_email_regex:
                  nullable: true
                  type: boolean
                name:
                  nullable: true
                  type: string
              type: object
        required: true
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                - properties:
                    result:
                      properties:
                        comments:
                          nullable: true
                          type: string
                        created_at:
                          format: date-time
                          type: string
                        directory_id:
                          allOf:
                          - format: int64
                            type: integer
                          - nullable: true
                            type: integer
                        directory_node_id:
                          nullable: true
                          type: string
                        email:
                          nullable: true
                          type: string
                        id:
                          example: 2403
                          format: int32
                          title: identifier
                          type: integer
                        is_email_regex:
                          type: boolean
                        last_modified:
                          format: date-time
                          type: string
                        name:
                          type: string
                        provenance:
                          nullable: true
                          type: string
                      required:
                      - id
                      - created_at
                      - last_modified
                      - name
                      - is_email_regex
                      type: object
                  required:
                  - result
                  type: object
          description: ''
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Update an entry in impersonation registry
      tags:
      - Email Security Settings
  /accounts/{account_id}/email-security/settings/trusted_domains:
    delete:
      operationId: email_security_delete_trusted_domains
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/email-security_AccountId'
      requestBody:
        content:
          application/json:
            schema:
              items:
                properties:
                  id:
                    example: 2401
                    format: int32
                    title: identifier
                    type: integer
                required:
                - id
                type: object
              minItems: 1
              type: array
        required: true
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                - properties:
                    result:
                      items:
                        properties:
                          id:
                            example: 2401
                            format: int32
                            title: identifier
                            type: integer
                        required:
                        - id
                        type: object
                      minItems: 1
                      type: array
                  required:
                  - result
                  type: object
          description: ''
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Delete multiple trusted email domains
      tags:
      - Email Security Settings
    get:
      description: List, search, and sort an account's trusted email domains.
      operationId: email_security_list_trusted_domains
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/email-security_AccountId'
      - description: Page number of paginated results.
        in: query
        name: page
        schema:
          default: 1
          format: int32
          minimum: 1
          type: integer
      - description: Number of results to display.
        in: query
        name: per_page
        schema:
          default: 20
          format: int32
          minimum: 1
          type: integer
      - description: The field to sort by.
        in: query
        name: order
        schema:
          enum:
          - pattern
          - created_at
          type: string
      - description: The sorting direction.
        in: query
        name: direction
        schema:
          allOf:
          - $ref: '#/components/schemas/email-security_SortingDirection'
      - description: 'Allows searching in multiple properties of a record simultaneously.

          This parameter is intended for human users, not automation. Its exact

          behavior is intentionally left unspecified and is subject to change

          in the future.'
        in: query
        name: search
        schema:
          type: string
      - in: query
        name: is_recent
        schema:
          type: boolean
      - in: query
        name: is_similarity
        schema:
          type: boolean
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                - properties:
                    result:
                      items:
                        $ref: '#/components/schemas/email-security_TrustedDomain'
                      type: array
                    result_info:
                      $ref: '#/components/schemas/email-security_ResultInfo'
                  required:
                  - result
                  - result_info
                  type: object
          description: List of trusted domains for the provided account
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform List trusted email domains
      tags:
      - Email Security Settings
    post:
      operationId: email_security_create_trusted_domain
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/email-security_AccountId'
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
              - $ref: '#/components/schemas/email-security_CreateTrustedDomain'
              - items:
                  $ref: '#/components/schemas/email-security_CreateTrustedDomain'
                type: array
        required: true
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        '201':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                - properties:
                    result:
                      oneOf:
                      - $ref: '#/components/schemas/email-security_TrustedDomain'
                      - items:
                          $ref: '#/components/schemas/email-security_TrustedDomain'
                        type: array
                  required:
                  - result
                  type: object
          description: Returns the newly created trusted domains in the same shape as the request body
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Create a trusted email domain
      tags:
      - Email Security Settings
  /accounts/{account_id}/email-security/settings/trusted_domains/{pattern_id}:
    delete:
      operationId: email_security_delete_trusted_domain
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/email-security_AccountId'
      - in: path
        name: pattern_id
        required: true
        schema:
          example: 2401
          format: int32
          title: identifier
          type: integer
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                - properties:
                    result:
                      properties:
                        id:
                          example: 2401
                          format: int32
                          title: identifier
                          type: integer
                      required:
                      - id
                      type: object
                  required:
                  - result
                  type: object
          description: ''
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Delete a trusted email domain
      tags:
      - Email Security Settings
    get:
      operationId: email_security_get_trusted_domain
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/email-security_AccountId'
      - in: path
        name: pattern_id
        required: true
        schema:
          example: 2401
          format: int32
          title: identifier
          type: integer
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                - properties:
                    result:
                      allOf:
                      - additionalProperties: false
                        example:
                          comments: null
                          is_recent: true
                          is_regex: false
                          is_similarity: false
                          pattern: example.com
                        properties:
                          comments:
                            nullable: true
                            type: string
                          is_recent:
                            type: boolean
                          is_regex:
                            type: boolean
                          is_similarity:
                            type: boolean
                          pattern:
                            minLength: 1
                            type: string
                        required:
                        - is_recent
                        - is_similarity
                        - is_regex
                        - pattern
                        type: object
                      - properties:
                          created_at:
                            format: date-time
                            type: string
                          id:
                            example: 2401
                            format: int32
                            title: identifier
                            type: integer
                          last_modified:
                            format: date-time
                            type: string
                        required:
                        - id
                        - created_at
                        - last_modified
                        type: object
                      example:
                        comments: null
                        created_at: '2023-11-14T22:13:20Z'
                        id: 2401
                        is_recent: true
                        is_regex: false
                        is_similarity: false
                        last_modified: '2023-11-14T22:13:20Z'
                        pattern: example.com
                  required:
                  - result
                  type: object
          description: ''
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Get a trusted email domain
      tags:
      - Email Security Settings
    patch:
      operationId: email_security_update_trusted_domain
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/email-security_AccountId'
      - in: path
        name: pattern_id
        required: true
        schema:
          example: 2401
          format: int32
          title: identifier
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                comments:
                  nullable: true
                  type: string
                is_recent:
                  nullable: true
                  type: boolean
                is_regex:
                  nullable: true
                  type: boolean
                is_similarity:
                  nullable: true
                  type: boolean
                pattern:
                  minLength: 1
                  nullable: true
                  type: string
              type: object
        required: true
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                - properties:
                    result:
                      allOf:
                      - additionalProperties: false
                        example:
                          comments: null
                          is_recent: true
                          is_regex: false
                          is_similarity: false
                          pattern: example.com
                        properties:
                          comments:
                            nullable: true
                            type: string
                          is_recent:
                            type: boolean
                          is_regex:
                            type: boolean
                          is_similarity:
                            type: boolean
                          pattern:
                            minLength: 1
                            type: string
                        required:
                        - is_recent
                        - is_similarity
                        - is_regex
                        - pattern
                        type: object
                      - properties:
                          created_at:
                            format: date-time
                            type: string
                          id:
                            example: 2401
                            format: int32
                            title: identifier
                            type: integer
                          last_modified:
                            format: date-time
                            type: string
                        required:
                        - id
                        - created_at
                        - last_modified
                        type: object
                      example:
                        comments: null
                        created_at: '2023-11-14T22:13:20Z'
                        id: 2401
                        is_recent: true
                        is_regex: false
                        is_similarity: false
                        last_modified: '2023-11-14T22:13:20Z'
                        pattern: example.com
                  required:
                  - result
                  type: object
          description: ''
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Update a trusted email domain
      tags:
      - Email Security Settings
components:
  schemas:
    email-security_DisplayName:
      properties:
        comments:
          nullable: true
          type: string
        created_at:
          format: date-time
          type: string
        directory_id:
          allOf:
          - format: int64
            type: integer
          - nullable: true
            type: integer
        directory_node_id:
          nullable: true
          type: string
        email:
          nullable: true
          type: string
        id:
          example: 2403
          format: int32
          title: identifier
          type: integer
        is_email_regex:
          type: boolean
        last_modified:
          format: date-time
          type: string
        name:
          type: string
        provenance:
          nullable: true
          type: string
      required:
      - id
      - created_at
      - last_modified
      - name
      - is_email_regex
      type: object
    email-security_CreateAllowPattern:
      additionalProperties: false
      example:
        comments: Trust all messages send from test@example.com
        is_recipient: false
        is_regex: false
        is_sender: true
        is_spoof: false
        pattern: test@example.com
        pattern_type: EMAIL
        verify_sender: true
      properties:
        comments:
          nullable: true
          type: string
        is_recipient:
          type: boolean
        is_regex:
          type: boolean
        is_sender:
          type: boolean
        is_spoof:
          type: boolean
        pattern:
          minLength: 1
          type: string
        pattern_type:
          $ref: '#/components/schemas/email-security_PatternType'
        verify_sender:
          type: boolean
      required:
      - is_recipient
      - is_sender
      - is_spoof
      - pattern
      - is_regex
      - verify_sender
      - pattern_type
      type: object
    email-security_Message:
      properties:
        code:
          format: int32
          minimum: 1000
          type: integer
        message:
          type: string
      required:
      - code
      - message
      type: object
    email-security_AccountId:
      description: Account Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      minLength: 32
      readOnly: true
      title: account_id
      type: string
    email-security_CreateDisplayName:
      properties:
        email:
          type: string
        is_email_regex:
          type: boolean
        name:
          type: string
      required:
      - name
      - email
      - is_email_regex
      type: object
    email-security_CreateTrustedDomain:
      additionalProperties: false
      example:
        comments: null
        is_recent: true
        is_regex: false
        is_similarity: false
        pattern: example.com
      properties:
        comments:
          nullable: true
          type: string
        is_recent:
          type: boolean
        is_regex:
          type: boolean
        is_similarity:
          type: boolean
        pattern:
          minLength: 1
          type: string
      required:
      - is_recent
      - is_similarity
      - is_regex
      - pattern
      type: object
    email-security_CreateBlockedSender:
      additionalProperties: false
      example:
        comments: block sender with email test@example.com
        is_regex: false
        pattern: test@example.com
        pattern_type: EMAIL
      properties:
        comments:
          nullable: true
          type: string
        is_regex:
          type: boolean
        pattern:
          minLength: 1
          type: string
        pattern_type:
          $ref: '#/components/schemas/email-security_PatternType'
      required:
      - pattern
      - is_regex
      - pattern_type
      type: object
    email-security_PatternType:
      enum:
      - EMAIL
      - DOMAIN
      - IP
      - UNKNOWN
      type: string
    email-security_ResultInfo:
      properties:
        count:
          description: Total number of results for the requested service
          example: 1
          format: int32
          type: integer
        page:
          description: Current page within paginated list of results
          example: 1
          format: int32
          type: integer
        per_page:
          description: Number of results per page of results
          example: 20
          format: int32
          type: integer
        total_count:
          description: Total results available without any search parameters
          example: 2000
          format: int32
          type: integer
      required:
      - count
      - page
      - per_page
      - total_count
      type: object
    email-security_SortingDirection:
      enum:
      - asc
      - desc
      type: string
    email-security_DeliveryMode:
      enum:
      - DIRECT
      - BCC
      - JOURNAL
      - API
      - RETRO_SCAN
      type: string
    email-security_ApiResponseCommon:
      properties:
        errors:
          example: []
          items:
            $ref: '#/components/schemas/email-security_Message'
          type: array
        messages:
          example: []
          items:
            $ref: '#/components/schemas/email-security_Message'
          type: array
        success:
          example: true
          type: boolean
      required:
      - success
      - errors
      - messages
      type: object
    email-security_TrustedDomain:
      allOf:
      - additionalProperties: false
        example:
          comments: null
          is_recent: true
          is_regex: false
          is_similarity: false
          pattern: example.com
        properties:
          comments:
            nullable: true
            type: string
          is_recent:
            type: boolean
          is_regex:
            type: boolean
          is_similarity:
            type: boolean
          pattern:
            minLength: 1
            type: string
        required:
        - is_recent
        - is_similarity
        - is_regex
        - pattern
        type: object
      - properties:
          created_at:
            format: date-time
            type: string
          id:
            example: 2401
            format: int32
            title: identifier
            type: integer
          last_modified:
            format: date-time
            type: string
        required:
        - id
        - created_at
        - last_modified
        type: object
      example:
        comments: null
        created_at: '2023-11-14T22:13:20Z'
        id: 2401
        is_recent: true
        is_regex: false
        is_similarity: false
        last_modified: '2023-11-14T22:13:20Z'
        pattern: example.com
    email-security_AllowPattern:
      allOf:
      - additionalProperties: false
        example:
          comments: Trust all messages send from test@example.com
          is_recipient: false
          is_regex: false
          is_sender: true
          is_spoof: false
          pattern: test@example.com
          pattern_type: EMAIL
          verify_sender: true
        properties:
          comments:
            nullable: true
            type: string
          is_recipient:
            type: boolean
          is_regex:
            type: boolean
          is_sender:
            type: boolean
          is_spoof:
            type: boolean
          pattern:
            minLength: 1
            type: string
          pattern_type:
            $ref: '#/components/schemas/email-security_PatternType'
          verify_sender:
            type: boolean
        required:
        - is_recipient
        - is_sender
        - is_spoof
        - pattern
        - is_regex
        - verify_sender
        - pattern_type
        type: object
      - properties:
          created_at:
            format: date-time
            type: string
          id:
            example: 2401
            format: int32
            title: identifier
            type: integer
          last_modified:
            format: date-time
            type: string
        required:
        - id
        - created_at
        - last_modified
        type: object
      example:
        comments: Trust all messages send from test@example.com
        created_at: '2023-11-14T22:13:20Z'
        id: 2401
        is_recipient: false
        is_regex: false
        is_sender: true
        is_spoof: false
        last_modified: '2023-11-14T22:13:20Z'
        pattern: test@example.com
        pattern_type: EMAIL
        verify_sender: true
    email-security_BlockedSender:
      allOf:
      - additionalProperties: false
        example:
          comments: block sender with email test@example.com
          is_regex: false
          pattern: test@example.com
          pattern_type: EMAIL
        properties:
          comments:
            nullable: true
            type: string
          is_regex:
            type: boolean
          pattern:
            minLength: 1
            type: string
          pattern_type:
            $ref: '#/components/schemas/email-security_PatternType'
        required:
        - pattern
        - is_regex
        - pattern_type
        type: object
      - properties:
          created_at:
            format: date-time
            type: string
          id:
            example: 2402
            format: int32
            title: identifier
            type: integer
          last_modified:
            format: date-time
            type: string
        required:
        - id
        - created_at
        - last_modified
        type: object
      example:
        comments: block sender with email test@example.com
        created_at: '2023-11-14T22:13:20Z'
        id: 2402
        is_regex: false
        last_modified: '2023-11-14T22:13:20Z'
        pattern: test@example.com
        pattern_type: EMAIL
    email-security_Domain:
      example:
        allowed_delivery_modes:
        - API
        created_at: '2023-11-14T22:13:20Z'
        domain: example.com
        id: 2400
        integration_id: a5dbb180-60ea-4578-84bb-d01a5d4e50c3
        last_modified: '2023-11-14T22:13:20Z'
        lookback_hops: 2
        o365_tenant_id: c3c3239d-8858-47df-9618-0e2d9bdf6aa8
      properties:
        allowed_delivery_modes:
          items:
            $ref: '#/components/schemas/email-security_DeliveryMode'
          type: array
        created_at:
          format: date-time
          type: string
        domain:
          type: string
        id:
          description: Unique domain identifier
          example: 2400
          format: int32
          type: integer
        integration_id:
          format: uuid
          nullable: true
          type: string
        last_modified:
          format: date-time
          type: string
        lookback_hops:
          format: int32
          type: integer
        o365_tenant_id:
          nullable: true
          type: string
      required:
      - id
      - created_at
      - last_modified
      - domain
      - allowed_delivery_modes
      - lookback_hops
      type: object
  responses:
    email-security_ClientError:
      content:
        application/json:
          schema:
            properties:
              errors:
                example:
                - code: 7003
                  message: No route for the URI
                items:
                  $ref: '#/components/schemas/email-security_Message'
                type: array
              messages:
                example: []
                items:
                  $ref: '#/components/schemas/email-security_Message'
                type: array
              result:
                nullable: true
                type: object
              success:
                example: false
                type: boolean
            required:
            - result
            - success
            - errors
            - messages
            type: object
      description: Client Error
  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/apigateway/
x-hasEquivalentPaths: true