---
title: "Update ip allow list for organization"
url: "https://nov18-dev.movespot.fyi/apis/internal-kauth-admin-api-v1-1/versions/bb58fcea-1135-45ba-880d-56a1563e8969/operations/patch-ip-allow-list"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/internal-kauth-admin-api-v1-1/versions/bb58fcea-1135-45ba-880d-56a1563e8969.md

# Update ip allow list for organization

`PATCH` `/internal/organizations/{organizationId}/ip-allow-list`

Operation ID: `patch-ip-allow-list`

Updates the ip allow list configuration for an organization.

## Path parameters

- `organizationId` (string, uuid, required) - UUID representing an organization.

## Request body

Content types: `application/json`

## Responses

- `200` - The organization's ip allow list configuration.
- `400` - Bad Request
- `401` - Unauthorized
- `403` - Forbidden

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Internal KAuth Admin API v1
  version: 1.0.8
servers:
  - url: http://admin-api.kauth.svc.cluster.local:8000/v1
    description: KAuth Admin API Internal url
  - url: http://kauth-source-ip-api.kauth.svc.cluster.local:8080/v1
    description: Source IP API Internal url
paths:
  /internal/organizations/{organizationId}/ip-allow-list:
    parameters:
      - $ref: "#/components/parameters/OrganizationIdParameter"
    patch:
      operationId: patch-ip-allow-list
      summary: Update ip allow list for organization
      description: |
        Updates the ip allow list configuration for an organization.
      requestBody:
        $ref: "#/components/requestBodies/PatchOrganizationSourceIPRestriction"
      responses:
        "200":
          $ref: "#/components/responses/OrganizationSourceIPRestriction"
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "403":
          $ref: "#/components/responses/Forbidden"
      tags:
        - Organizations
components:
  parameters:
    OrganizationIdParameter:
      name: organizationId
      in: path
      description: UUID representing an organization.
      required: true
      schema:
        $ref: "#/components/schemas/OrganizationId"
  requestBodies:
    PatchOrganizationSourceIPRestriction:
      description: The request schema to update an organization's ip allow list
        configuration.
      content:
        application/json:
          schema:
            type: object
            properties:
              enabled:
                $ref: "#/components/schemas/SourceIPEnabled"
              allowed_ips:
                $ref: "#/components/schemas/AllowedIPs"
            additionalProperties: false
            minProperties: 1
          examples:
            Example Request Body:
              value:
                enabled: true
                allowed_ips:
                  - 192.168.1.1
                  - 192.168.1.0/22
  responses:
    OrganizationSourceIPRestriction:
      description: The organization's ip allow list configuration.
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/OrganizationSourceIPRestriction"
          examples:
            Example:
              value:
                enabled: true
                allowed_ips:
                  - 192.168.1.1
                  - 192.168.1.0/22
    BadRequest:
      description: Bad Request
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/BadRequestError"
    Unauthorized:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/UnauthorizedError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/UnauthorizedExample"
    Forbidden:
      description: Forbidden
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/ForbiddenError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/ForbiddenExample"
  schemas:
    OrganizationId:
      description: UUID representing an organization.
      type: string
      format: uuid
      example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
      readOnly: true
    SourceIPEnabled:
      description: Whether ip allow list is enabled for the organization.
      type: boolean
      example: true
      default: false
    AllowedIPs:
      description: The list of allowed ips for the organization.
      type: array
      items:
        type: string
      example:
        - 192.168.1.1
        - 192.168.1.0/22
      maxItems: 1000
      minItems: 1
      uniqueItems: true
    OrganizationSourceIPRestriction:
      type: object
      properties:
        enabled:
          $ref: "#/components/schemas/SourceIPEnabled"
        allowed_ips:
          $ref: "#/components/schemas/AllowedIPs"
      additionalProperties: false
      required:
        - enabled
        - allowed_ips
      title: Organization Source IP Restriction
    BadRequestError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          required:
            - invalid_parameters
          properties:
            invalid_parameters:
              $ref: "#/components/schemas/InvalidParameters"
    UnauthorizedError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 401
            title:
              example: Unauthorized
            type:
              example: https://httpstatuses.com/401
            instance:
              example: kong:trace:1234567890
            detail:
              example: Invalid credentials
    ForbiddenError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 403
            title:
              example: Forbidden
            type:
              example: https://httpstatuses.com/403
            instance:
              example: kong:trace:1234567890
            detail:
              example: Forbidden
    BaseError:
      description: standard error
      type: object
      properties:
        status:
          description: >
            The HTTP status code of the error. Useful when passing the response

            body to child properties in a frontend UI. Must be returned as an
            integer.
          type: integer
          readOnly: true
        title:
          description: |
            A short, human-readable summary of the problem. It should not
            change between occurences of a problem, except for localization.
            Should be provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
        type:
          description: The error type.
          type: string
          readOnly: true
        instance:
          description: |
            Used to return the correlation ID back to the user, in the format
            kong:trace:<correlation_id>. This helps us find the relevant logs
            when a customer reports an issue.
          type: string
          readOnly: true
        detail:
          description: >
            A human readable explanation specific to this occurence of the
            problem.

            This field may contain request/entity data to help the user
            understand

            what went wrong. Enclose variable values in square brackets. Should
            be

            provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
      required:
        - status
        - title
        - instance
        - detail
      title: Error
    InvalidParameters:
      description: invalid parameters
      type: array
      items:
        oneOf:
          - $ref: "#/components/schemas/InvalidParameterStandard"
          - $ref: "#/components/schemas/InvalidParameterMinimumLength"
          - $ref: "#/components/schemas/InvalidParameterMaximumLength"
          - $ref: "#/components/schemas/InvalidParameterChoiceItem"
          - $ref: "#/components/schemas/InvalidParameterDependentItem"
      minItems: 1
      nullable: false
      uniqueItems: true
    InvalidParameterStandard:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          $ref: "#/components/schemas/InvalidRules"
        source:
          type: string
          example: body
        reason:
          type: string
          example: is a required field
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
    InvalidParameterMinimumLength:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - min_length
            - min_digits
            - min_lowercase
            - min_uppercase
            - min_symbols
            - min_items
            - min
          nullable: false
          readOnly: true
        minimum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must have at least 8 characters
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - minimum
    InvalidParameterMaximumLength:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - max_length
            - max_items
            - max
          nullable: false
          readOnly: true
        maximum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must not have more than 8 characters
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - maximum
    InvalidParameterChoiceItem:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - enum
          nullable: false
          readOnly: true
        reason:
          type: string
          example: is a required field
          readOnly: true
        choices:
          type: array
          items: {}
          minItems: 1
          nullable: false
          readOnly: true
          uniqueItems: true
        source:
          type: string
          example: body
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - choices
    InvalidParameterDependentItem:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - dependent_fields
          nullable: true
          readOnly: true
        reason:
          type: string
          example: is a required field
          readOnly: true
        dependents:
          type: array
          items: {}
          nullable: true
          readOnly: true
          uniqueItems: true
        source:
          type: string
          example: body
      additionalProperties: false
      required:
        - field
        - rule
        - reason
        - dependents
    InvalidRules:
      description: invalid parameters rules
      type: string
      enum:
        - required
        - is_array
        - is_base64
        - is_boolean
        - is_date_time
        - is_integer
        - is_null
        - is_number
        - is_object
        - is_string
        - is_uuid
        - is_fqdn
        - is_arn
        - unknown_property
        - missing_reference
        - is_label
        - matches_regex
        - invalid
        - is_supported_network_availability_zone_list
        - is_supported_network_cidr_block
        - is_supported_provider_region
        - type
      nullable: true
      readOnly: true
  examples:
    UnauthorizedExample:
      value:
        status: 401
        title: Unauthorized
        instance: kong:trace:8347343766220159418
        detail: Unauthorized
    ForbiddenExample:
      value:
        status: 403
        title: Forbidden
        instance: kong:trace:2723154947768991354
        detail: You do not have permission to perform this action
```
