---
title: "Internal PDP Auth Admin API v1"
url: "https://nov18-dev.movespot.fyi/apis/internal-pdp-auth-admin-api-v1-1/versions/65945f7f-ee1f-40d6-be36-704dd7f85fcb"
---

# Internal PDP Auth Admin API v1

OpenAPI specification document.

```json
{"openapi":"3.0.3","info":{"title":"Internal PDP Auth Admin API v1","description":"Admin API for Kong Auth Policy Decision Point (PDP) service","version":"1.0.0","contact":{"name":"Kong","url":"https://konghq.com"}},"servers":[{"url":"http://authorization-admin-api.kauth.svc.cluster.local:8000/v1","description":"Konnect cluster"}],"paths":{"/actions":{"get":{"operationId":"listActions","summary":"List actions","description":"Returns a paginated list of all actions","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListActionsResponsePaginated"}}}}},"tags":["Actions"]},"post":{"operationId":"createAction","summary":"Create action","description":"Creates a new action","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateActionRequest"}}}},"responses":{"201":{"description":"Action created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Action"}}}},"400":{"$ref":"#/components/responses/BadRequest"}},"tags":["Actions"]}},"/actions/{actionId}":{"parameters":[{"name":"actionId","in":"path","description":"Unique identifier of the action","required":true,"schema":{"type":"string"}}],"patch":{"operationId":"updateAction","summary":"Update action","description":"Updates an existing action","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateActionRequest"}}}},"responses":{"200":{"description":"Action updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Action"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Actions"]},"delete":{"operationId":"deleteAction","summary":"Delete action","description":"Deletes an action","responses":{"204":{"description":"Action deleted successfully"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Actions"]}},"/roles":{"get":{"operationId":"listRoles","summary":"List roles","description":"Returns a paginated list of all roles","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RolesResponse"}}}}},"tags":["Roles"]},"post":{"operationId":"createRole","summary":"Create role","description":"Creates a new role","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRoleRequest"}}}},"responses":{"201":{"description":"Role created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Role"}}}},"400":{"$ref":"#/components/responses/BadRequest"}},"tags":["Roles"]}},"/roles/{roleId}":{"parameters":[{"name":"roleId","in":"path","description":"Unique identifier of the role","required":true,"schema":{"type":"string"}}],"patch":{"operationId":"updateRole","summary":"Update role","description":"Updates an existing role","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateRoleRequest"}}}},"responses":{"200":{"description":"Role updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Role"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Roles"]},"delete":{"operationId":"deleteRole","summary":"Delete role","description":"Deletes a role","responses":{"204":{"description":"Role deleted successfully"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Roles"]}},"/teams":{"get":{"operationId":"listTeams","summary":"List teams","description":"Returns a paginated list of all teams","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamsResponse"}}}}},"tags":["Teams"]},"post":{"operationId":"createTeam","summary":"Create team","description":"Creates a new team","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTeamRequest"}}}},"responses":{"201":{"description":"Team created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Team"}}}},"400":{"$ref":"#/components/responses/BadRequest"}},"tags":["Teams"]}},"/teams/{teamId}":{"parameters":[{"name":"teamId","in":"path","description":"Unique identifier of the team","required":true,"schema":{"type":"string"}}],"patch":{"operationId":"updateTeam","summary":"Update team","description":"Updates an existing team","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTeamRequest"}}}},"responses":{"200":{"description":"Team updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Team"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Teams"]},"delete":{"operationId":"deleteTeam","summary":"Delete team","description":"Deletes a team","responses":{"204":{"description":"Team deleted successfully"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Teams"]}},"/perm-sync/start":{"post":{"operationId":"startPermSync","summary":"Start permission synchronization","description":"Initiates permission synchronization process","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartPermSyncRequest"}}}},"responses":{"204":{"description":"Permission sync started successfully (no content)"},"400":{"$ref":"#/components/responses/BadRequest"}},"tags":["Permission Sync"]}}},"components":{"schemas":{"Action":{"description":"An action that can be performed on a resource","type":"object","properties":{"id":{"description":"Unique identifier of the action in format $domain:$name","type":"string"},"domain":{"description":"Domain the action is associated with","type":"string"},"name":{"description":"Name of the action","type":"string"},"description":{"description":"Description of the action","type":"string"},"resource":{"description":"Resource the action is associated with","type":"string"},"global":{"description":"Flag to indicate if the action is global","type":"boolean"},"action":{"description":"Legacy format of the action","type":"string"}},"required":["id","domain","name","description","resource","global","action"]},"CreateActionRequest":{"description":"Request body for creating an action","type":"object","properties":{"domain":{"description":"Domain the action is associated with","type":"string"},"name":{"description":"Name of the action","type":"string"},"description":{"description":"Description of the action","type":"string"},"resource":{"description":"Resource the action is associated with","type":"string"},"global":{"description":"Flag to indicate if the action is global","type":"boolean"},"action":{"description":"Legacy format of the action","type":"string"}},"required":["domain","name","description","resource","action"]},"UpdateActionRequest":{"description":"Request body for updating an action","type":"object","properties":{"description":{"description":"Description of the action","type":"string"},"resource":{"description":"Resource the action is associated with","type":"string"},"global":{"description":"Flag to indicate if the action is global","type":"boolean"},"action":{"description":"Legacy format of the action","type":"string"}}},"Role":{"description":"A role that can be assigned to users or teams","type":"object","properties":{"id":{"description":"Unique identifier of the role","type":"string"},"domain":{"description":"Domain the role is associated with","type":"string"},"name":{"description":"Name of the role","type":"string"},"display_name":{"description":"Display name of the role","type":"string"},"description":{"description":"Description of the role","type":"string"},"feature_flag":{"description":"Optional feature flag which guards the role","type":"string","nullable":true},"actions":{"description":"List of actions granted by the role","type":"array","items":{"type":"string"}},"entity_type":{"description":"Entity type of the role","type":"string"},"internal":{"description":"Whether the role is available to Konnect users","type":"boolean"}},"required":["id","domain","name","display_name","description","actions","entity_type","internal"]},"CreateRoleRequest":{"description":"Request body for creating a role","type":"object","properties":{"domain":{"description":"Domain the role is associated with","type":"string"},"name":{"description":"Name of the role","type":"string"},"display_name":{"description":"Display name of the role","type":"string"},"description":{"description":"Description of the role","type":"string"},"feature_flag":{"description":"Optional feature flag which guards the role","type":"string","nullable":true},"actions":{"description":"List of actions granted by the role","type":"array","items":{"type":"string"}},"entity_type":{"description":"Entity type of the role","type":"string"},"internal":{"description":"Whether the role is available to Konnect users","type":"boolean"}},"required":["domain","name","display_name","description","actions","entity_type","internal"]},"UpdateRoleRequest":{"description":"Request body for updating a role","type":"object","properties":{"display_name":{"description":"Display name of the role","type":"string"},"description":{"description":"Description of the role","type":"string"},"feature_flag":{"description":"Optional feature flag which guards the role","type":"string","nullable":true},"actions":{"description":"List of actions granted by the role","type":"array","items":{"type":"string"}},"entity_type":{"description":"Entity type of the role","type":"string"},"internal":{"description":"Whether the role is available to Konnect users","type":"boolean"}}},"Team":{"description":"A team that can be assigned roles","type":"object","properties":{"id":{"description":"Unique identifier of the team","type":"string"},"domain":{"description":"Domain the team is associated with","type":"string"},"name":{"description":"Name of the team","type":"string"},"display_name":{"description":"Display name of the team","type":"string"},"description":{"description":"Description of the team","type":"string"},"feature_flag":{"description":"Optional feature flag which guards the team","type":"string","nullable":true},"roles":{"description":"List of roles assigned to the team","type":"array","items":{"type":"string"}}},"required":["id","domain","name","display_name","description","feature_flag","roles"]},"CreateTeamRequest":{"description":"Request body for creating a team","type":"object","properties":{"domain":{"description":"Domain the team is associated with","type":"string"},"name":{"description":"Name of the team","type":"string"},"display_name":{"description":"Display name of the team","type":"string"},"description":{"description":"Description of the team","type":"string"},"feature_flag":{"description":"Optional feature flag which guards the team","type":"string","nullable":true},"roles":{"description":"List of roles assigned to the team","type":"array","items":{"type":"string"}}},"required":["domain","name","display_name","description","roles"]},"UpdateTeamRequest":{"description":"Request body for updating a team","type":"object","properties":{"display_name":{"description":"Display name of the team","type":"string"},"description":{"description":"Description of the team","type":"string"},"feature_flag":{"description":"Optional feature flag which guards the team","type":"string","nullable":true},"roles":{"description":"List of roles assigned to the team","type":"array","items":{"type":"string"}}}},"StartPermSyncRequest":{"description":"Request body for starting permission synchronization","type":"object","properties":{"targeting":{"description":"Targeting configuration dictating which organizations to sync","type":"object","properties":{"organization_ids":{"description":"List of organization UUIDs to target (required when on=enumerated)","type":"array","items":{"type":"string","format":"uuid"},"example":["550e8400-e29b-41d4-a716-446655440000","6ba7b810-9dad-11d1-80b4-00c04fd430c8"]},"on":{"description":"Targeting type","type":"string","example":"enumerated","enum":["enumerated","internal","all"]}}},"roles":{"description":"List of role identifiers to sync in format domain#name","type":"array","items":{"type":"string","pattern":"^[^#]+#[^#]+$"},"example":["accounts#AppAuthStrategyCreator","accounts#PortalAdmin"]},"teams":{"description":"List of team identifiers to sync in format domain#name","type":"array","items":{"type":"string","pattern":"^[^#]+#[^#]+$"},"example":["accounts#AnalyticsAdmin","accounts#AnalyticsViewer"]}}},"ListActionsResponsePaginated":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Action"}}},"required":["meta","data"]},"RolesResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Role"}}},"required":["meta","data"]},"TeamsResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Team"}}},"required":["meta","data"]},"PageMeta":{"description":"Contains pagination query parameters and the total number of objects returned.","type":"object","properties":{"number":{"type":"number","example":1},"size":{"type":"number","example":10},"total":{"type":"number","example":100}},"required":["number","size","total"]},"PaginatedMeta":{"description":"returns the pagination information","type":"object","properties":{"page":{"$ref":"#/components/schemas/PageMeta"}},"required":["page"],"title":"PaginatedMeta"},"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"}}}]},"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":{"NotFoundExample":{"value":{"status":404,"title":"Not Found","instance":"kong:trace:6816496025408232265","detail":"Not Found"}}},"responses":{"BadRequest":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"NotFound":{"description":"Not Found","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/NotFoundError"},"examples":{"NotFoundExample":{"$ref":"#/components/examples/NotFoundExample"}}}}}}},"tags":[{"name":"Actions","description":"Operations for managing actions"},{"name":"Roles","description":"Operations for managing roles"},{"name":"Teams","description":"Operations for managing teams"},{"name":"Permission Sync","description":"Operations for permission synchronization"}]}
```
