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 Team Membership API

The Team Membership API from Kong — 3 operation(s) for team membership.

Kong Team Membership 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 Team Membership. 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 Team Membership 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.

Team Membership 4
GET
/v3/teams/{teamId}/users
List Team Users
list-team-users 4 params → 200400404
POST
/v3/teams/{teamId}/users
Add User
add-user-to-team 1 param body → 201400404409
DELETE
/v3/teams/{teamId}/users/{userId}
Remove User
remove-user-from-team 2 params → 204400404
GET
/v3/users/{userId}/teams
List User Teams
list-user-teams 4 params → 200404

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are User (8 properties), Team (7 properties), InvalidParameterDependentItem (5 properties), InvalidParameterMinimumLength (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
LegacyStringFieldFilter
object
Filter using one of the following operators: eq, contains
2 properties
Labels
object
Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types. Keys must be of length 1-63 characters,…
Team
object
The team object contains information about a group of users.
7 properties
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
User
object
The user object contains information about an individual user who can use the Konnect application and API.
8 properties
InvalidParameterStandard
object
4 properties 2 required
PageMeta
object
Contains pagination query parameters and the total number of objects returned.
3 properties 3 required
NotFoundError
BooleanFieldFilter
boolean
Filter by a boolean value (true/false).

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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