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.1.0, at version 3.14.0.
Requests are made against a single base URL, {protocol}://{hostname}:{port}{path}.
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
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 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), IdentityProvider (7 properties), PortalAuthenticationSettingsResponse (7 properties), SAMLIdentityProviderConfig (6 properties). Each schema is shown below with its type and property counts.
IdentityProvider
object
The identity provider that contains configuration data for authentication integration.
7 properties
InvalidParameterMinimumLength
object
5 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.
PortalTeamGroupMappingResponse
object
A paginated list of portal team group mappings.
2 properties
PortalIdpTeamGroupMapping
object
5 properties5 required
UpdatedAt
string
An ISO-8601 timestamp representation of entity update date.
InvalidParameterChoiceItem
object
5 properties4 required
ConflictError
InvalidParameterMaximumLength
object
5 properties4 required
OIDCIdentityProviderClaimMappings
object
Defines the mappings between OpenID Connect (OIDC) claims and local claims used by your application for authentication.
3 properties
OIDCIdentityProviderScopes
array
The scopes requested by your application when authenticating with the identity provider.
PortalTeamGroupMappingsUpdateRequest
object
A set of mappings to update from a team to their groups.
1 property
PortalTeamGroupMapping
object
A map of portal teams to Identity Provider groups.
2 properties
IdentityProviderLoginPath
string
The path used for initiating login requests with the identity provider.
UpdateIdentityProvider
object
The identity provider that contains configuration data for updating an authentication integration.
3 properties
PortalClaimMappings
object
Mappings from a portal developer atribute to an Identity Provider claim.
3 properties
CreateIdentityProvider
object
The identity provider that contains configuration data for creating an authentication integration.
4 properties
UUID
string
Contains a unique identifier used for this resource.
SAMLAuthEnabled
boolean
A Konnect Identity Admin assigns teams to a developer.
ForbiddenError
UnauthorizedError
CursorMetaPage
object
5 properties3 required
CreatePortalIdpTeamGroupMappingRequest
object
2 properties2 required
SAMLIdentityProviderMetadataURL
string
The identity provider's metadata URL where the identity provider's metadata can be obtained.
CursorMeta
object
Pagination metadata.
1 property1 required
OIDCIdentityProviderClientSecret
string
The Client Secret assigned to your application by the identity provider.
PortalAuthenticationSettingsResponse
object
The developer authentication settings for a portal.
7 properties4 required
StringFieldEqualsFilter
object
Filters on the given string field value by exact match.
1 property
PaginatedMeta
object
returns the pagination information
1 property1 required
PortalAuthenticationSettingsUpdateRequest
object
Properties to update a portal's developer auth settings.
11 properties
OIDCIdpMappingEnabled
boolean
IdP groups determine the Portal Teams a developer has. Replaced by idpmappingenabled.
CreatedAt
string
An ISO-8601 timestamp representation of entity creation date.
BaseError
object
standard error
5 properties4 required
InvalidParameterDependentItem
object
5 properties4 required
InvalidRules
string
invalid parameters rules
InvalidParameters
array
invalid parameters
BadRequestError
IdentityProviderEnabled
boolean
Indicates whether the identity provider is enabled. Only one identity provider can be active at a time, such as SAML or OIDC.
IdentityProviderType
string
Specifies the type of identity provider.
IDPMappingEnabled
boolean
Whether IdP groups determine the Konnect Portal teams a developer has.
InvalidParameterStandard
object
4 properties2 required
OIDCAuthEnabled
boolean
The portal has OIDC enabled or disabled.
SAMLIdentityProviderConfig
object
The identity provider that contains configuration data for the SAML authentication integration.
6 properties
OIDCIdentityProviderConfig
object
The identity provider that contains configuration data for the OIDC authentication integration.
5 properties2 required
OIDCIdentityProviderClientId
string
The client ID assigned to your application by the identity provider.
PortalIdpTeamGroupMappingCollectionResponse
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.
NotFoundError
PageMeta
object
Contains pagination query parameters and the total number of objects returned.
3 properties3 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
