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 Portal Team Roles API

APIs related to Konnect Developer Portal developer team roles.

Kong Portal Team 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 Portal Team 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 4 operations across 3 paths, and defines 19 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}.

4 operations 3 paths 19 schemas 1 DELETE2 GET1 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 Portal Team 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 4

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

Portal Team Roles 4

APIs related to Konnect Developer Portal developer team roles.

GET
/v3/portal-roles
List Portal Roles
list-portal-roles → 200401403
GET
/v3/portals/{portalId}/teams/{teamId}/assigned-roles
List Team Roles
list-portal-team-roles 4 params → 200401403404
POST
/v3/portals/{portalId}/teams/{teamId}/assigned-roles
Assign Role
assign-role-to-portal-teams 4 params body → 201400401403404409
DELETE
/v3/portals/{portalId}/teams/{teamId}/assigned-roles/{roleId}
Remove Role
remove-role-from-portal-team 3 params → 204401403404

Schemas 19

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

InvalidParameterMinimumLength
object
5 properties 4 required
AssignedPortalRoleCollectionResponse
object
A paginated list of roles assigned to a team.
2 properties 2 required
ListRolesResponse
object
The set of roles available to associate with resources and assign to teams.
1 property 1 required
ConflictError
InvalidParameterChoiceItem
object
5 properties 4 required
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
PortalAssignRoleRequest
object
An assigned role associates a service and an action to a team.
4 properties 4 required
InvalidRules
string
invalid parameters rules
InvalidParameters
array
invalid parameters
BadRequestError
InvalidParameterStandard
object
4 properties 2 required
PortalAssignedRoleResponse
object
An assigned role associates a service and an action to a team.
5 properties 5 required
PageMeta
object
Contains pagination query parameters and the total number of objects returned.
3 properties 3 required
NotFoundError

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kong-portal-team-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