Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kong Roles API

The Roles API from Kong — 5 operation(s) for roles.

Kong Roles API is one of 139 APIs that Kong publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Roles. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, a GitHub repository, an API reference, authentication docs, and 1 JSON Schema.

This API exposes 9 operations across 5 paths, and defines 17 schemas. It is described by OpenAPI 3.1.0, at version 3.14.0.

Requests are made against a single base URL, {protocol}://{hostname}:{port}{path}.

9 operations 5 paths 17 schemas 2 DELETE5 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
3.14.0
Base URL
https://konghq.com/
Authentication
API Key
Contact
License
Resource Areas
1

Authentication & Security 1

Kong Roles API declares 1 security scheme for authenticating requests. An API key is passed in the header as Kong-Admin-Token (adminToken). By default, every request must be authenticated.

Paths & Operations 9

Across 5 paths, the API surfaces 9 operations — 2 DELETE, 5 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Roles 9
GET
/v3/roles
Get Predefined Roles
get-predefined-roles → 200400401
GET
/v3/teams/{teamId}/assigned-roles
List Team Roles
list-team-roles 2 params → 200400401403404
POST
/v3/teams/{teamId}/assigned-roles
Assign Team Role
teams-assign-role 1 param body → 201400401403404409
GET
/v3/teams/{teamId}/assigned-roles/{roleId}
Get Team Role
get-team-role 2 params → 200400401403404
DELETE
/v3/teams/{teamId}/assigned-roles/{roleId}
Remove Team Role
teams-remove-role 2 params → 204400401403404
GET
/v3/users/{userId}/assigned-roles
List User Roles
list-user-roles 2 params → 200400404
POST
/v3/users/{userId}/assigned-roles
Assign Role
users-assign-role 1 param body → 201400401403404409
GET
/v3/users/{userId}/assigned-roles/{roleId}
Get User Role
get-user-role 2 params → 200400401403404
DELETE
/v3/users/{userId}/assigned-roles/{roleId}
Remove Role
users-remove-role 2 params → 204400401404

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are InvalidParameterMinimumLength (5 properties), InvalidParameterDependentItem (5 properties), BaseError (5 properties), InvalidParameterMaximumLength (5 properties). Each schema is shown below with its type and property counts.

InvalidParameterMinimumLength
object
5 properties 4 required
StringFieldEqualsFilter
object
Filters on the given string field value by exact match.
1 property
InvalidParameterChoiceItem
object
5 properties 4 required
ConflictError
InvalidParameterMaximumLength
object
5 properties 4 required
ForbiddenError
UnauthorizedError
PaginatedMeta
object
returns the pagination information
1 property 1 required
BaseError
object
standard error
5 properties 4 required
InvalidParameterDependentItem
object
5 properties 4 required
InvalidRules
string
invalid parameters rules
InvalidParameters
array
invalid parameters
BadRequestError
InvalidParameterStandard
object
4 properties 2 required
PageMeta
object
Contains pagination query parameters and the total number of objects returned.
3 properties 3 required
NotFoundError
AssignedRole
object
An assigned role is a role that has been assigned to a user or team.
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kong-roles-api-openapi.yml Raw ↑

Other APIs Kong publishes across the network.

Kong Gateway
Kong AI Gateway
Kong Agent Gateway
Kong MCP Registry
Kong Context Mesh
Kong Mesh
Kong Insomnia
Kong ACLs API
Kong Add-Ons API
Kong API API
Kong API Attributes API
Kong API Documentation API