---
title: "Konnect Organizations"
url: "https://nov18-dev.movespot.fyi/apis/konnect-organizations-private-0/versions/2c1df84a-8357-4f43-b5f9-8619b5a33f38"
---

# Konnect Organizations

OpenAPI specification document.

```json
{"openapi":"3.0.3","info":{"title":"Konnect Organizations","version":"0.0.0","description":"Konnect Organizations API.","contact":{"name":"Kong","url":"https://konghq.com"}},"servers":[{"url":"https://us.api.konghq.com/v0","description":"United-States Production region"},{"url":"https://eu.api.konghq.com/v0","description":"Europe Production region"},{"url":"https://au.api.konghq.com/v0","description":"Australia Production region"},{"url":"https://me.api.konghq.com/v0","description":"Middle-East Production region"},{"url":"https://in.api.konghq.com/v0","description":"India Production region"},{"url":"https://sg.api.konghq.com/v0","description":"Singapore Production region"}],"paths":{"/organizations/{organizationId}/entitlements":{"parameters":[{"$ref":"#/components/parameters/OrganizationId"}],"get":{"operationId":"get-entitlements","summary":"Get entitlements","description":"Returns the entitlements for a given organization. Internal endpoint for kadmin.","responses":{"200":{"$ref":"#/components/responses/GetEntitlements"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Organizations"]},"patch":{"operationId":"update-entitlements","summary":"Update entitlements","description":"Update the entitlements for a given organization. Internal endpoint for kadmin.","requestBody":{"$ref":"#/components/requestBodies/UpdateEntitlements"},"responses":{"200":{"$ref":"#/components/responses/GetEntitlements"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Organizations"]}}},"components":{"parameters":{"OrganizationId":{"name":"organizationId","description":"organization identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}},"schemas":{"GetEntitlementsResponse":{"$ref":"#/components/schemas/Entitlements"},"Entitlements":{"type":"object","properties":{"portals_limit":{"type":"number","example":4}},"additionalProperties":false,"required":["portals_limit"],"title":"Entitlements"},"UUID":{"description":"Contains a unique identifier used for this resource.","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"},"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"}}}]}},"examples":{"GetEntitlementsExample1":{"value":{"portals_limit":4}},"UpdateEntitlementsExample1":{"value":{"portals_limit":3}},"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":{"UpdateEntitlements":{"description":"Update an organization's entitlements.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Entitlements"},"examples":{"Example 1":{"$ref":"#/components/examples/UpdateEntitlementsExample1"}}}}}},"responses":{"GetEntitlements":{"description":"Entitlements for this organization.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEntitlementsResponse"},"examples":{"Example 1":{"$ref":"#/components/examples/GetEntitlementsExample1"}}}}},"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"}}}}},"NotFound":{"description":"Not Found","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/NotFoundError"},"examples":{"NotFoundExample":{"$ref":"#/components/examples/NotFoundExample"}}}}}},"securitySchemes":{"serviceAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The Service access token is meant to be used between internal services.\n"}}},"tags":[{"name":"Organizations","description":"API related to the management of Konnect Organizations"}],"security":[{"serviceAccessToken":[]}]}
```
