AppAuthStrategyOpenIDConnectRequest

object

Payload for creating an OIDC Application Auth Strategy

* Additional properties are NOT allowed.
namestringrequired

The name of the auth strategy. This is used to identify the auth strategy in the Konnect UI.

>= 1 characters<= 256 characters

display_namestringrequired

The display name of the Auth strategy. This is used to identify the Auth strategy in the Portal UI.

<= 256 characters

strategy_typestringrequired

Allowed values:openid_connect

configsobjectrequired

JSON-B object containing the configuration for the OIDC strategy

* Additional properties are NOT allowed.
Show Child Parameters
dcr_provider_idstring(uuid)
labelsobject

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, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"env":"test"}

Example

AppAuthStrategyOpenIDConnectResponse

object

Response payload from creating an OIDC Application Auth Strategy

* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

namestringrequired

The name of the auth strategy. This is used to identify the auth strategy in the Konnect UI.

>= 1 characters<= 256 characters

display_namestringrequired

The display name of the Auth strategy. This is used to identify the Auth strategy in the Portal UI.

<= 256 characters

strategy_typestringrequired

Allowed values:openid_connect

configsobjectrequired

JSON-B object containing the configuration for the OIDC strategy

* Additional properties are NOT allowed.
Show Child Parameters
activebooleanrequired

At least one published entity is using this auth strategy.

dcr_providerobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
labelsobjectrequired

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, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"env":"test"}

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

supports_multiple_credentialsbooleanread-only

Indicates whether this auth strategy supports multiple credentials.

  • true for Key Auth strategies and when supported for Client Credentials strategies
  • false when not supported for Client Credentials strategies
Example

CreateAppAuthStrategyRequest

object

Request body for creating an Application Auth Strategy

One Of
namestringrequired

The name of the auth strategy. This is used to identify the auth strategy in the Konnect UI.

>= 1 characters<= 256 characters

display_namestringrequired

The display name of the Auth strategy. This is used to identify the Auth strategy in the Portal UI.

<= 256 characters

strategy_typestringrequired

Allowed values:key_auth

configsobjectrequired

JSON-B object containing the configuration for the Key Auth strategy

* Additional properties are NOT allowed.
Show Child Parameters
labelsobject

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, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"env":"test"}

Example

AppAuthStrategy

object

A set of plugin configurations that represent how the gateway will perform authentication and authorization for a Product Version. Called “Auth Strategy” for short in the context of portals/applications. The plugins are synced to any Gateway Service that is currently linked or becomes linked to the Product Version.

One Of
idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

namestringrequired

The name of the auth strategy. This is used to identify the auth strategy in the Konnect UI.

>= 1 characters<= 256 characters

display_namestringrequired

The display name of the Auth strategy. This is used to identify the Auth strategy in the Portal UI.

<= 256 characters

strategy_typestringrequired

Allowed values:key_auth

configsobjectrequired

JSON-B object containing the configuration for the Key Auth strategy

* Additional properties are NOT allowed.
Show Child Parameters
activebooleanrequired

At least one published entity is using this auth strategy.

dcr_providerobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
labelsobjectrequired

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, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"env":"test"}

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

supports_multiple_credentialsbooleanread-only

Indicates whether this auth strategy supports multiple credentials.
Always true for KEY_AUTH.

Default:true

Example

UpdateAppAuthStrategyRequest

object

Request body for updating an Application Auth Strategy

* Additional properties are NOT allowed.
namestring

The name of the auth strategy. This is used to identify the auth strategy in the Konnect UI.

>= 1 characters<= 256 characters

display_namestring

The display name of the Auth strategy. This is used to identify the Auth strategy in the Portal UI.

<= 256 characters

labelsobject

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Labels are intended to store INTERNAL metadata.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"env":"test"}

dcr_provider_idstring(uuid)
configsOne Of
object

JSON-B object containing the configuration for the OIDC strategy under the key ‘openid-connect’ or the configuration for the Key Auth strategy under the key ‘key-auth’

UpdateAppAuthStrategyRequestOpenIdConnectobject
* Additional properties are NOT allowed.
Show Child Parameters
Example