openapi: 3.2.0
info:
  title: Organizations, Roles, Users, Permissions IP Allowlist API
  version: 0.1.0
  description: API for managing users, roles, and permissions within the Moment platform.
  contact:
    name: Moment Support
    email: support@withmoment.com
    url: https://withmoment.com/support
servers:
- url: https://live.moment-api.com
  description: Production server
- url: https://paper.moment-api.com
  description: UAT server
security:
- BearerAuth: []
tags:
- name: IP Allowlist
paths:
  /v1/org/ip/:
    post:
      tags:
      - IP Allowlist
      summary: Add IP to FIX IP Allowlist
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddFIXIPAllowlistRequest'
      description: Add a new IP address to the IPs that are allowed to connect to Moment's FIX sessions for a given organization.
      operationId: AddFIXIPAllowlist
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IPAllowlistResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                description: Standard error response format returned by all API endpoints.
                properties:
                  error:
                    type: string
                    description: Human-readable error message describing what went wrong.
                  error_details:
                    description: Additional structured information about the error.
                    x-go-type: any
                    x-go-type-skip-optional-pointer: true
                    x-oapi-codegen-extra-tags:
                      exhaustruct: optional
                  error_type:
                    type: string
                    description: High-level error category for programmatic error handling.
                    enum:
                    - invalid_request
                    - not_found
                    - server_error
                    - unauthorized
                    - rate_limited
                    - forbidden
                    - closed
                    - not_implemented
                    x-enum-varnames:
                    - ErrorTypeInvalidRequest
                    - ErrorTypeNotFound
                    - ErrorTypeServerError
                    - ErrorTypeUnauthorized
                    - ErrorTypeRateLimited
                    - ErrorTypeForbidden
                    - ErrorTypeNeedsMarketState
                    - ErrorTypeNotImplemented
                required:
                - error
                - error_type
    get:
      tags:
      - IP Allowlist
      summary: Get FIX IP Allowlist
      description: Retrieve the IPs that are allowed to connect to Moment's FIX sessions for a given organization.
      operationId: GetFIXIPAllowlist
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IPAllowlistResponse'
  /v1/org/ip/{ip_address}/:
    delete:
      tags:
      - IP Allowlist
      summary: Remove IP from FIX IP Allowlist
      parameters:
      - name: ip_address
        in: path
        description: The IP address to remove from the allowed IP addresses for the organization.
        required: true
        schema:
          type: string
      description: Remove an IP address from the IPs that are allowed to connect to Moment's FIX sessions for a given organization.
      operationId: RemoveFIXIPAllowlist
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IPAllowlistResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/paths/~1v1~1org~1ip~1/post/responses/400/content/application~1json/schema'
  /v1/org/{org_id}/ip-allowlist/:
    put:
      summary: Update organization IP allowlist
      description: Update the list of IP addresses that are allowed to connect for the organization
      operationId: updateOrganizationIPAllowlist
      tags:
      - IP Allowlist
      parameters:
      - name: org_id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                ip_addresses:
                  type: array
                  description: Array of IP addresses to set as allowed IPs for the organization
                  items:
                    type: string
              required:
              - ip_addresses
      responses:
        '200':
          description: IP allowlist updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Organization'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/paths/~1v1~1org~1ip~1/post/responses/400/content/application~1json/schema'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/paths/~1v1~1org~1ip~1/post/responses/400/content/application~1json/schema'
components:
  schemas:
    AddFIXIPAllowlistRequest:
      type: object
      properties:
        ip_address:
          type: string
          description: The IP address to add to the allowed IP addresses for the organization.
      required:
      - ip_address
    IPAllowlistResponse:
      type: object
      properties:
        ip_addresses:
          type: array
          description: A list of IP addresses that are allowed to connect to Moment's FIX sessions.
          items:
            type: string
      required:
      - ip_addresses
      example:
        ip_addresses:
        - 74.125.200.100
        - 74.125.200.113
    Organization:
      type: object
      properties:
        id:
          type: string
          description: Organization ID
        name:
          type: string
          description: Organization name
        client_id:
          type:
          - string
          - 'null'
          description: Optional client identifier
        parent_id:
          type:
          - string
          - 'null'
          description: 'Parent organization ID for introducing brokers. Note: clearer_id database field serves the same purpose (legacy naming).'
        domains:
          type: array
          items:
            $ref: '#/components/schemas/OrganizationDomain'
        allowed_ips:
          type: array
          items:
            type: string
          description: List of IP addresses that are allowed to connect to the organization's FIX sessions.
      required:
      - id
      - name
      - client_id
    OrganizationDomain:
      type: string
      description: A domain that is associated with an organization
      example: example.com
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT token for API authentication
x-provenance:
  method: searched
  source: https://docs.moment.com/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://docs.moment.com/reference/addfixipallowlist.md
  - https://docs.moment.com/reference/getfixipallowlist.md
  - https://docs.moment.com/reference/removefixipallowlist.md
  - https://docs.moment.com/reference/updateorganizationipallowlist.md
  merge:
    pages: 4
    deduped: 7
    conflicts_kept_first: 0