Kong Portal Auth Settings 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 Auth Settings. 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
13 operations
across 6 paths,
and defines 49 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.
13 operations6 paths49 schemas2 DELETE6 GET3 PATCH2 POST
Metadata
The identity and technical contract details declared by the specification.
Kong Portal Auth Settings 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 13
Across 6 paths, the API surfaces 13 operations — 2 DELETE, 6 GET, 3 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.
Portal Auth Settings 13
APIs related to configuration of Konnect Developer Portal auth settings.
The contract defines 49 schemas that model the data the API accepts and returns. The most detailed are PortalAuthenticationSettingsUpdateRequest (11 properties), PortalAuthenticationSettingsResponse (7 properties), IdentityProvider (7 properties), SAMLIdentityProviderConfig (6 properties). Each schema is shown below with its type and property counts.
CreatePortalIdpTeamGroupMappingRequest
object
2 properties2 required
OIDCIdentityProviderIssuer
string
The issuer URI of the identity provider. This is the URL where the provider's metadata can be obtained.
UpdatedAt
string
An ISO-8601 timestamp representation of entity update date.
CreateIdentityProvider
object
The identity provider that contains configuration data for creating an authentication integration.
4 properties
InvalidParameterChoiceItem
object
5 properties4 required
PortalAuthenticationSettingsUpdateRequest
object
Properties to update a portal's developer auth settings.
11 properties
PortalIdpTeamGroupMapping
object
5 properties5 required
OIDCIdpMappingEnabled
boolean
IdP groups determine the Portal Teams a developer has. Replaced by idpmappingenabled.
OIDCIdentityProviderClientSecret
string
The Client Secret assigned to your application by the identity provider.
CursorMetaPage
object
5 properties3 required
CreatedAt
string
An ISO-8601 timestamp representation of entity creation date.
BaseError
object
standard error
5 properties4 required
PortalAuthenticationSettingsResponse
object
The developer authentication settings for a portal.
7 properties4 required
SAMLIdentityProviderMetadata
string
The identity provider's SAML metadata. If the identity provider supports a metadata URL, you can use the idpmetadataurl field instead.
OIDCIdentityProviderClientId
string
The client ID assigned to your application by the identity provider.
IdentityProviderLoginPath
string
The path used for initiating login requests with the identity provider.
OIDCIdentityProviderConfig
object
The identity provider that contains configuration data for the OIDC authentication integration.
5 properties2 required
InvalidParameters
array
invalid parameters
OIDCIdentityProviderClaimMappings
object
Defines the mappings between OpenID Connect (OIDC) claims and local claims used by your application for authentication.
3 properties
PortalClaimMappings
object
Mappings from a portal developer atribute to an Identity Provider claim.
3 properties
PaginatedMeta
object
returns the pagination information
1 property1 required
BadRequestError
IDPMappingEnabled
boolean
Whether IdP groups determine the Konnect Portal teams a developer has.
OIDCAuthEnabled
boolean
The portal has OIDC enabled or disabled.
PortalIdpTeamGroupMappingCollectionResponse
object
2 properties2 required
InvalidParameterMinimumLength
object
5 properties4 required
OIDCIdentityProviderScopes
array
The scopes requested by your application when authenticating with the identity provider.
ForbiddenError
UnauthorizedError
SAMLAuthEnabled
boolean
A Konnect Identity Admin assigns teams to a developer.
StringFieldEqualsFilter
object
Filters on the given string field value by exact match.
1 property
NotFoundError
InvalidParameterDependentItem
object
5 properties4 required
SAMLIdentityProviderConfig
object
The identity provider that contains configuration data for the SAML authentication integration.
6 properties
InvalidRules
string
invalid parameters rules
InvalidParameterMaximumLength
object
5 properties4 required
CursorMeta
object
Pagination metadata.
1 property1 required
IdentityProvider
object
The identity provider that contains configuration data for authentication integration.
7 properties
IdentityProviderEnabled
boolean
Indicates whether the identity provider is enabled. Only one identity provider can be active at a time, such as SAML or OIDC.
UUID
string
Contains a unique identifier used for this resource.
ConflictError
PageMeta
object
Contains pagination query parameters and the total number of objects returned.
3 properties3 required
IdentityProviderType
string
Specifies the type of identity provider.
SAMLIdentityProviderMetadataURL
string
The identity provider's metadata URL where the identity provider's metadata can be obtained.
PortalTeamGroupMappingsUpdateRequest
object
A set of mappings to update from a team to their groups.
1 property
PortalTeamGroupMappingResponse
object
A paginated list of portal team group mappings.
2 properties
InvalidParameterStandard
object
4 properties2 required
PortalTeamGroupMapping
object
A map of portal teams to Identity Provider groups.
2 properties
UpdateIdentityProvider
object
The identity provider that contains configuration data for updating an authentication integration.
3 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘWhere this information came from
This is an independent, third-party profile of Kong Portal Auth Settings 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.
