How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
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.2.0, at version 3.14.0.

Requests are made against 4 base URLs: https://global.api.konghq.com, https://us.api.konghq.com, https://eu.api.konghq.com, https://au.api.konghq.com.

9 operations 5 paths 17 schemas 2 DELETE5 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
3.14.0
Base URL
https://konghq.com/
Authentication
HTTP Bearer, HTTP Bearer, HTTP Bearer, HTTP Bearer
Contact
License
Resource Areas
1

Authentication & Security 4

Kong Roles API declares 4 security schemes for authenticating requests. It accepts HTTP bearer tokens (Token) (personalAccessToken). It accepts HTTP bearer tokens (Token) (systemAccountAccessToken). It accepts HTTP bearer tokens (JWT) (konnectAccessToken). It accepts HTTP bearer tokens (JWT) (serviceAccessToken). By default, every request must be authenticated.

  • personalAccessToken — The personal access token is meant to be used as an alternative to basic-auth when accessing Konnect via APIs. You can generate a Personal Access Token (PAT) f…
  • systemAccountAccessToken — The system account access token is meant for automations and integrations that are not directly associated with a human identity. You can generate a system acc…
  • konnectAccessToken — The Konnect access token is meant to be used by the Konnect dashboard and the decK CLI to authenticate with.
  • serviceAccessToken — The Service access token is meant to be used between internal services.

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 BaseError (5 properties), AssignedRole (5 properties), InvalidParameterChoiceItem (5 properties), InvalidParameterMinimumLength (5 properties). Each schema is shown below with its type and property counts.

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

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
Where this information came from

This is an independent, third-party profile of Kong Roles API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.