ListDcrProvidersResponse

object

A paginated list response for a collection of DCR providers

* Additional properties are NOT allowed.
dataOne Of
array[object]required
DCR provider - Auth0object

A DCR provider for Auth0 – only properties not included in DcrProviderBase

* Additional properties are NOT allowed.
Show Child Parameters
metaobjectrequired

returns the pagination information

Show Child Parameters
Example

VerifyDcrProviderResponse

object

A response containing the result of attempting to verify a DCR provider configuration.

* Additional properties are NOT allowed.
statusstringrequired

Allowed values:successfailed

errorsarray[string]required
Example

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

PartialAppAuthStrategyConfigKeyAuth

object

Key Auth configuration for updating an Application Auth Strategy.
The ttl field can be set to null to unset the Time-To-Live.

* 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. Set to null to unset.

Show Child Parameters
Example

PartialAppAuthStrategyConfigOpenIDConnect

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)

<= 256 characters

credential_claimarray[string]

<= 128 characters<= 10 items

scopesarray[string]

<= 128 characters<= 50 items

auth_methodsarray[string]

<= 64 characters<= 10 items

Example