AppAuthStrategyConfigKeyAuth

object

The most basic mode to configure an Application Auth Strategy for an API Product Version.
Using this mode will allow developers to generate API keys that will authenticate their application requests.
Once authenticated, an application will be granted access to any Product Version it is registered for that is configured for Key Auth.

* Additional properties are NOT allowed.
key_namesarray[string]

The names of the headers containing the API key. You can specify multiple header names.

<= 256 characters>= 1 items<= 10 items

ttlobject

Default maximum Time-To-Live for keys created under this strategy.

Show Child Parameters
Example

AppAuthStrategyConfigOpenIDConnect

object

A more advanced mode to configure an API Product Version’s Application Auth Strategy.
Using this mode will allow developers to use API credentials issued from an external IdP that will authenticate their application requests.
Once authenticated, an application will be granted access to any Product Version it is registered for that is configured for the same Auth Strategy.
An OIDC strategy may be used in conjunction with a DCR provider to automatically create the IdP application.

* Additional properties are allowed.
issuerstring(url)required

<= 256 characters

credential_claimarray[string]required

<= 128 characters<= 10 items

scopesarray[string]required

<= 128 characters<= 50 items

auth_methodsarray[string]required

<= 64 characters<= 10 items

Example

ApiIds

object
api_idsarray[string](uuid)required
Example

ApisDetailsById

object
apisarray[object]required
Show Child Parameters
Example

ApiDetails

object
idstring(uuid)required
namestringrequired
versionstringrequired
slugstringrequired
Example