AddSystemAccountToTeam - The request schema for adding a system account to a team.

AddUserToTeam - The request schema for adding a user to a team.

AssignedRole - An assigned role is a role that has been assigned to a user or team.

AssignedRoleCollection - A paginated list response for a collection of assigned roles.

AssignRole - An assigned role is a role that has been assigned to a user or team.

AuthenticationSettings - Response for authentication settings endpoint.

CACertificate - A CA certificate object represents a trusted CA.

CACertificateInput - A CA certificate object represents a trusted CA.

Certificate - A certificate object represents a public certificate, and can be optionally paired with the corresponding private key.

CertificateInput - A certificate object represents a public certificate, and can be optionally paired with the corresponding private key.

ClientCertificate - Certificate to be used as client certificate while TLS handshaking to the upstream server.

Config - CP configuration object for related access endpoints.

The Consumer object represents a consumer - or a user - of a Service.

ConsumerInput - The Consumer object represents a consumer - or a user - of a Service.

ControlPlane - The control plane object contains information about a Kong control plane.

CreateControlPlaneRequest - The request schema for the create control plane request.

CreateSystemAccount - The request schema to create a system account.

CreateSystemAccountAccessToken - The request body to create a system account access token.

CreateTeam - The request schema for the create team request.

CursorPaginatedMetaWithSizeAndTotal - returns the pagination information.

DataPlaneClientCertificateRequest - Request body for creating a dp-client-certificate.

GetExpectedConfigHashResponse - Response body for retrieving the expected config hash of the control plane.

GetGroupStatus - Status of a control plane group, including existing conflicts.

GetImpersonationSettingsResponse - Response for Get Impersonation Settings endpoint.

GetNode - Example response.

GroupConflict - The Group Conflict object contains information about a conflict in a control plane group.

GroupConflictResource - A resource causing a conflict in a control plane group.

GroupMembership - Request body for upserting a list of child control planes to a control plane group membership.

GroupMemberStatus - Object with information determining the group membership status of a control plane.

GroupStatus - The Group Status object contains information about the status of a control plane group.

IDP - The IdP object contains the configuration data for the OIDC authentication integration.

InviteUser - The request schema for the invite user request.

A Key object holds a representation of asymmetric keys in various formats.

KeyInput - A Key object holds a representation of asymmetric keys in various formats.

KeyWithoutParents - A Key object holds a representation of asymmetric keys in various formats.

KeyWithoutParentsPem - A keypair in PEM format.

KeyWithoutParentsSet - The id (an UUID) of the key-set with which to associate the key.

ListControlPlanesResponse - A paginated list response for a collection of control planes.

ListDataPlaneCertificatesResponse - Example response.

ListGroupMemberships - A paginated list response for a collection of control plane group memberships.

ListNodes - Example response.

ListNodesEol - Example response.

ListPluginSchemas - A paginated list response for a collection of custom plugin schemas.

MeOrganization - Me Organization.

Meta - Contains pagination data.

PageMeta - Contains pagination query parameters and the total number of objects returned.

PaginatedMeta - returns the pagination information.

PatchTeamGroupMappings - The request schema for a partial update of mappings from Konnect Teams to IdP Groups.

Pem - A keypair in PEM format.

A Plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle.

PluginConsumer - If set, the plugin will activate only for requests where the specified has been authenticated.

PluginInput - A Plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle.

PluginRoute - If set, the plugin will only activate when receiving requests via the specified route.

PluginSchemas - A response for a single custom plugin schema.

PluginService - If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service.

PluginWithoutParents - A Plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle.

ProxyURL - Proxy URL associated with reaching the data-planes connected to a control-plane.

Roles - The predefined, or system managed, roles.

Route entities define rules to match client requests.

RouteInput - Route entities define rules to match client requests.

RouteService - The Service this Route is associated to.

RouteWithoutParents - Route entities define rules to match client requests.

Service entities, as the name implies, are abstractions of each of your own upstream services.

ServiceInput - Service entities, as the name implies, are abstractions of each of your own upstream services.

Set - The id (an UUID) of the key-set with which to associate the key.

Sni - An SNI object represents a many-to-one mapping of hostnames to a certificate.

SNICertificate - The id (a UUID) of the certificate with which to associate the SNI hostname.

SNIInput - An SNI object represents a many-to-one mapping of hostnames to a certificate.

SNIWithoutParents - An SNI object represents a many-to-one mapping of hostnames to a certificate.

StringFieldContainsFilter - Filter a string value field by partial contains.

StringFieldEqualsFilter - Filter a string value by exact match.

StringFieldFilter - Filter a string value field either by exact match or partial contains.

StringFieldNEQFilter - Filters on the given string field value by exact match inequality.

StringFieldOEQFilter - Returns entities that exact match any of the comma-delimited phrases in the filter string.

SystemAccount - Schema of the system account.

SystemAccountAccessToken - Schema of the system account access token.

SystemAccountAccessTokenCollection - A paginated list response for a collection of system accounts access tokens.

SystemAccountAccessTokenCreated - A response including a single system account access token with the token.

SystemAccountCollection - A paginated list response for a collection of system accounts.

Target - A target is an ip address/hostname with a port that identifies an instance of a backend service.

TargetWithoutParents - A target is an ip address/hostname with a port that identifies an instance of a backend service.

Team - The team object contains information about a group of users.

TeamCollection - A paginated list response for a collection of users.

TeamGroupMapping - A map of Konnect Team to IdP groups.

TeamGroupMappingCollection - A paginated collection of mappings grouped by team_id.

TeamMapping - A team assignment is a mapping of an IdP group to a Konnect Team.

TeamMappingCollection - A paginated list response for a collection of team mappings.

TeamMappingResponse - A paginated list response for a collection of team mappings.

TeamMappingResponsePage - The page object.

UpdateAuthenticationSettings - The request schema to update an organization's authentication settings.

UpdateControlPlaneRequest - The request schema for the update control plane request.

UpdateIDPConfiguration - The request schema for the update IdP configuration request.

UpdateImpersonationSettingsRequest - The request schema for adding a system account to a team.

UpdateImpersonationSettingsResponse - Response for Update Impersonation Settings endpoint.

UpdateSystemAccount - The request schema for the update system account request.

UpdateTeam - The request schema for the update team request.

UpdateTeamMappings - The request schema for updating IdP team mappings.

UpdateUser - The request schema for the update user request.

Upstream - The upstream object represents a virtual hostname and can be used to loadbalance incoming requests over multiple services (targets).

UpstreamClientCertificate - If set, the certificate to be used as client certificate while TLS handshaking to the upstream server.

UpstreamInput - The upstream object represents a virtual hostname and can be used to loadbalance incoming requests over multiple services (targets).

User - The user object contains information about an individual user who can use the Konnect application and API.

UserCollection - A paginated list response for a collection of users.

Vault entities are used to configure different Vault connectors.

VaultInput - Vault entities are used to configure different Vault connectors.

AssignRoleEntityRegion - The region of the team.

AuthType - The auth type value of the cluster associated with the Runtime Group.

ControlPlaneAuthType - The auth type value of the cluster associated with the Runtime Group.

ControlPlaneClusterType - The ClusterType value of the cluster associated with the Control Plane.

CreateControlPlaneRequestClusterType - The ClusterType value of the cluster associated with the Control Plane.

EntityRegion - Region of the entity.

EntityTypeName - The type of entity.

HashFallback - What to use as hashing input if the primary `hash_on` does not return a hash (eg.

HashOn - What to use as hashing input.

HTTPSRedirectStatusCode - The status code Kong responds with when all properties of a Route match except the protocol i.e.

InvalidParameterChoiceItemRule - invalid parameters rules.

InvalidParameterDependentItemRule - invalid parameters rules.

InvalidParameterMaximumLengthRule - invalid parameters rules.

InvalidRules - invalid parameters rules.

MeOrganizationState - State of the organization.

PathHandling - Controls how the Service path, Route path and requested path are combined when sending a request to the upstream.

Protocol - The protocol used to communicate with the upstream.

RoleName - The desired role.

RouteWithoutParentsHTTPSRedirectStatusCode - The status code Kong responds with when all properties of a Route match except the protocol i.e.

RouteWithoutParentsPathHandling - Controls how the Service path, Route path and requested path are combined when sending a request to the upstream.

Rule - invalid parameters rules.

State - The state of the control plane group.

UpdateControlPlaneRequestAuthType - The auth type value of the cluster associated with the Runtime Group.

UpstreamAlgorithm - Which load balancing algorithm to use.