---
title: "Internal KAuth Admin API v1"
url: "https://nov18-dev.movespot.fyi/apis/internal-kauth-admin-api-v1-1/versions/bb58fcea-1135-45ba-880d-56a1563e8969"
---

# Internal KAuth Admin API v1

OpenAPI specification document.

```json
{"openapi":"3.0.3","info":{"title":"Internal KAuth Admin API v1","description":"Admin API for Kong Authorization (KAuth) service","version":"1.0.8","contact":{"name":"Kong","url":"https://konghq.com"}},"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}":{"servers":[{"url":"http://admin-api.kauth.svc.cluster.local:8000/v1","description":"KAuth Admin API Internal url"}],"summary":"A unified endpoint for internal service clients to manage organization settings on users' behalf","parameters":[{"$ref":"#/components/parameters/OrganizationIdParameter"}],"patch":{"operationId":"patch-organization","summary":"Update organization settings","description":"Updates organization settings for the organization identified by the organization-scoped token. \nCurrently supports MFA settings only, but will be extended\nto support additional settings and eventually replace specialized Organization Lifecycle API patch operations \nlike /deletion-config.\n","requestBody":{"$ref":"#/components/requestBodies/UpdateOrganizationRequest"},"responses":{"200":{"$ref":"#/components/responses/UpdateOrganizationResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/OrganizationNotFound"}},"tags":["Organization"]}},"/internal/organizations/{organizationId}/ip-allow-list":{"servers":[{"url":"http://kauth-source-ip-api.kauth.svc.cluster.local:8080/v1","description":"Source IP API Internal url"}],"parameters":[{"$ref":"#/components/parameters/OrganizationIdParameter"}],"get":{"operationId":"get-ip-allow-list","summary":"Get the ip allow list for organization","description":"Gets the ip allow list configuration for an organization.\n","responses":{"200":{"$ref":"#/components/responses/OrganizationSourceIPRestriction"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Organizations"]},"patch":{"operationId":"patch-ip-allow-list","summary":"Update ip allow list for organization","description":"Updates the ip allow list configuration for an organization.\n","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"]}},"/internal/portals/{portalId}/ip-allow-list":{"servers":[{"url":"http://kauth-source-ip-api.kauth.svc.cluster.local:8080/v1","description":"Source IP API Internal url"}],"parameters":[{"$ref":"#/components/parameters/PortalId"}],"get":{"operationId":"get-all-ip-allow-list-portal","summary":"Get all ip allow lists for portal","description":"Gets all the ip allow lists for a portal.\n","responses":{"200":{"$ref":"#/components/responses/PortalIPAllowList"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Portal IP Allow List"]}}},"components":{"parameters":{"OrganizationIdParameter":{"name":"organizationId","in":"path","description":"UUID representing an organization.","required":true,"schema":{"$ref":"#/components/schemas/OrganizationId"}},"PortalId":{"schema":{"type":"string","format":"uuid"},"name":"portalId","in":"path","required":true,"description":"ID of the portal."}},"schemas":{"MFASettings":{"description":"Settings related to Multi-Factor Authentication (MFA) for the organization.","type":"object","properties":{"enabled":{"description":"Whether MFA is enabled for the user","type":"boolean","example":true}},"additionalProperties":false,"required":["enabled"],"title":"MFA Settings Request"},"OrganizationId":{"description":"UUID representing an organization.","type":"string","format":"uuid","example":"5f9fd312-a987-4628-b4c5-bb4f4fddd5f7","readOnly":true},"BaseError":{"description":"standard error","type":"object","properties":{"status":{"description":"The HTTP status code of the error. Useful when passing the response\nbody to child properties in a frontend UI. Must be returned as an integer.\n","type":"integer","readOnly":true},"title":{"description":"A short, human-readable summary of the problem. It should not\nchange between occurences of a problem, except for localization.\nShould be provided as \"Sentence case\" for direct use in the UI.\n","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\nkong:trace:<correlation_id>. This helps us find the relevant logs\nwhen a customer reports an issue.\n","type":"string","readOnly":true},"detail":{"description":"A human readable explanation specific to this occurence of the problem.\nThis field may contain request/entity data to help the user understand\nwhat went wrong. Enclose variable values in square brackets. Should be\nprovided as \"Sentence case\" for direct use in the UI.\n","type":"string","readOnly":true}},"required":["status","title","instance","detail"],"title":"Error"},"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},"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"]},"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},"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"}}}]},"NotFoundError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":404},"title":{"example":"Not Found"},"type":{"example":"https://httpstatuses.com/404"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Not found"}}}]},"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"}},"examples":{"404OrganizationNotFound":{"value":{"status":404,"title":"Not Found","instance":"konnect:trace:2287285207635123011","detail":"The requested organization was not found"}},"UpdateOrganizationRequest":{"value":{"mfa_settings":{"enabled":true}}},"UpdateOrganizationResponse":{"value":{"mfa_settings":{"enabled":true}}},"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"}},"NotFoundExample":{"value":{"status":404,"title":"Not Found","instance":"kong:trace:6816496025408232265","detail":"Not Found"}}},"requestBodies":{"UpdateOrganizationRequest":{"required":true,"description":"The request schema to update an organization.","content":{"application/json":{"schema":{"type":"object","properties":{"mfa_settings":{"$ref":"#/components/schemas/MFASettings"}},"additionalProperties":false,"minProperties":1},"examples":{"Example Request Body":{"$ref":"#/components/examples/UpdateOrganizationRequest"}}}}},"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":{"OrganizationNotFound":{"description":"Not Found","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/NotFoundError"},"examples":{"Not Found":{"$ref":"#/components/examples/404OrganizationNotFound"}}}}},"UpdateOrganizationResponse":{"description":"The response schema for updating an organization.","content":{"application/json":{"schema":{"type":"object","properties":{"mfa_settings":{"$ref":"#/components/schemas/MFASettings"}}},"examples":{"Example Request Body":{"$ref":"#/components/examples/UpdateOrganizationResponse"}}}}},"PortalIPAllowList":{"description":"The response schema for getting all ip allow lists for a portal.","content":{"application/json":{"schema":{"type":"object","properties":{"allowed_ips":{"description":"The list of allowed ips for the portal.","type":"array","items":{"type":"string"},"example":["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"}}}}},"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"]}}}}}},"NotFound":{"description":"Not Found","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/NotFoundError"},"examples":{"NotFoundExample":{"$ref":"#/components/examples/NotFoundExample"}}}}}}},"tags":[{"name":"Organization","description":"Organization management"},{"name":"Portal IP Allow List","description":"APIs related to Portal IP Allow List"}]}
```
