---
title: "Konnect Entitlements"
url: "https://nov18-dev.movespot.fyi/apis/konnect-entitlements-internal-1/versions/c0909a65-f006-4b8b-acde-baa60d7b0faf"
---

# Konnect Entitlements

OpenAPI specification document.

```json
{"openapi":"3.0.3","info":{"title":"Konnect Entitlements","description":"API for managing entitlements for an organization.","version":"1.0.1","contact":{"name":"Kong","url":"https://konghq.com"}},"servers":[{"url":"https://global.api.konghq.com/v1","description":"Global Base URL"}],"paths":{"/entitlements":{"get":{"operationId":"get-entitlements-v1","summary":"Get all entitlements for an organization","description":"Get all entitlements for an organization","responses":{"200":{"$ref":"#/components/responses/EntitlementsResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Entitlements"]},"patch":{"operationId":"update-entitlements-v1","summary":"Update entitlements for an organization","description":"Update entitlements for an organization","requestBody":{"$ref":"#/components/requestBodies/UpdateEntitlementsRequest"},"responses":{"200":{"$ref":"#/components/responses/EntitlementsResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Entitlements"]}}},"components":{"schemas":{"DefaultRegion":{"description":"A region that is always enabled","type":"string","enum":["us","eu","au","me","in"]},"OptInRegion":{"description":"A region that can be optionally enabled","type":"string","enum":["sg"]},"OptedInRegions":{"description":"List of optional regions","type":"array","items":{"$ref":"#/components/schemas/OptInRegion"},"minItems":1,"uniqueItems":true},"FeatureToggleRequest":{"type":"object","properties":{"value":{"type":"boolean"}},"required":["value"]},"FeatureToggleResponse":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"value":{"type":"boolean"}},"required":["name","description","value"]},"FeatureSettingsRequest":{"type":"object","properties":{"editable":{"$ref":"#/components/schemas/FeatureToggleRequest"},"enabled":{"$ref":"#/components/schemas/FeatureToggleRequest"}},"required":["enabled"]},"FeatureSettingsResponse":{"type":"object","properties":{"editable":{"$ref":"#/components/schemas/FeatureToggleResponse"},"enabled":{"$ref":"#/components/schemas/FeatureToggleResponse"}},"required":["enabled"]},"MCPFeatureSettingsRequest":{"type":"object","properties":{"enabled":{"$ref":"#/components/schemas/FeatureToggleRequest"}}},"MCPFeatureSettingsResponse":{"type":"object","properties":{"enabled":{"$ref":"#/components/schemas/FeatureToggleResponse"}}},"FeaturesRequest":{"description":"Feature request body for updating user features","type":"object","properties":{"ai":{"$ref":"#/components/schemas/FeatureSettingsRequest"},"mcp":{"$ref":"#/components/schemas/MCPFeatureSettingsRequest"}}},"FeaturesResponse":{"description":"Map of feature names to their settings","type":"object","properties":{"ai":{"$ref":"#/components/schemas/FeatureSettingsResponse"},"mcp":{"$ref":"#/components/schemas/MCPFeatureSettingsResponse"}}},"OrganizationEntitlements":{"type":"object","properties":{"default_regions":{"description":"List of required regions","type":"array","items":{"$ref":"#/components/schemas/DefaultRegion"},"readOnly":true,"uniqueItems":true},"opted_in_regions":{"$ref":"#/components/schemas/OptedInRegions"},"features":{"$ref":"#/components/schemas/FeaturesResponse"}},"required":["default_regions","opted_in_regions","features"]},"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"}}}]},"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"}}}]}},"examples":{"DefaultEntitlementsRequest":{"summary":"Default entitlements request body","value":{"opted_in_regions":["sg"],"features":{"ai":{"enabled":{"value":false}},"mcp":{"enabled":{"value":false}}}}},"DefaultEntitlements":{"summary":"Default entitlements for an organization","value":{"default_regions":["us","eu","au","me","in"],"opted_in_regions":["sg"],"features":{"ai":{"editable":{"name":"editable","description":"makes the field available to the end user","value":false},"enabled":{"name":"enabled","description":"enables or disables the AI feature","value":false}},"mcp":{"enabled":{"name":"enabled","description":"enables or disables the MCP feature","value":false}}}}},"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"}}},"requestBodies":{"UpdateEntitlementsRequest":{"description":"Request body for updating entitlements","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"opted_in_regions":{"$ref":"#/components/schemas/OptedInRegions"},"features":{"$ref":"#/components/schemas/FeaturesRequest"}},"minProperties":1},"examples":{"DefaultEntitlementsRequest":{"$ref":"#/components/examples/DefaultEntitlementsRequest"}}}}}},"responses":{"EntitlementsResponse":{"description":"A list of entitlements for the organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationEntitlements"},"examples":{"DefaultEntitlements":{"$ref":"#/components/examples/DefaultEntitlements"}}}}},"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"}}}}},"BadRequest":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}}},"securitySchemes":{"konnectAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The Konnect access token is meant to be used by the Konnect dashboard and the decK CLI authenticate with.\n"}}},"tags":[{"name":"Entitlements","description":"Manage entitlements for an organization"}],"security":[{"konnectAccessToken":[]}]}
```
