konnect.ApplicationAuthStrategy

Example coming soon!

name string

The unique name of the resource.

args ApplicationAuthStrategyArgs

The arguments to resource properties.

opts CustomResourceOptions

Bag of options to control resource's behavior.

resource_name str

The unique name of the resource.

args ApplicationAuthStrategyArgs

The arguments to resource properties.

opts ResourceOptions

Bag of options to control resource's behavior.

ctx Context

Context object for the current deployment.

name string

The unique name of the resource.

args ApplicationAuthStrategyArgs

The arguments to resource properties.

opts ResourceOption

Bag of options to control resource's behavior.

name string

The unique name of the resource.

args ApplicationAuthStrategyArgs

The arguments to resource properties.

opts CustomResourceOptions

Bag of options to control resource's behavior.

name String

The unique name of the resource.

args ApplicationAuthStrategyArgs

The arguments to resource properties.

options CustomResourceOptions

Bag of options to control resource's behavior.

KeyAuth ApplicationAuthStrategyKeyAuth

Request for creating a Key Auth Application Auth Strategy

OpenidConnect ApplicationAuthStrategyOpenidConnect

Payload for creating an OIDC Application Auth Strategy

KeyAuth ApplicationAuthStrategyKeyAuthArgs

Request for creating a Key Auth Application Auth Strategy

OpenidConnect ApplicationAuthStrategyOpenidConnectArgs

Payload for creating an OIDC Application Auth Strategy

key_auth object

Request for creating a Key Auth Application Auth Strategy

openid_connect object

Payload for creating an OIDC Application Auth Strategy

keyAuth ApplicationAuthStrategyKeyAuth

Request for creating a Key Auth Application Auth Strategy

openidConnect ApplicationAuthStrategyOpenidConnect

Payload for creating an OIDC Application Auth Strategy

keyAuth ApplicationAuthStrategyKeyAuth

Request for creating a Key Auth Application Auth Strategy

openidConnect ApplicationAuthStrategyOpenidConnect

Payload for creating an OIDC Application Auth Strategy

key_auth ApplicationAuthStrategyKeyAuthArgs

Request for creating a Key Auth Application Auth Strategy

openid_connect ApplicationAuthStrategyOpenidConnectArgs

Payload for creating an OIDC Application Auth Strategy

keyAuth Property Map

Request for creating a Key Auth Application Auth Strategy

openidConnect Property Map

Payload for creating an OIDC Application Auth Strategy

Active bool

At least one published entity is using this auth strategy.

CreatedAt string

An ISO-8601 timestamp representation of entity creation date.

DisplayName string

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

Id string

The provider-assigned unique ID for this managed resource.

Name string

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

StrategyType string

SupportsMultipleCredentials bool

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

UpdatedAt string

An ISO-8601 timestamp representation of entity update date.

Active bool

At least one published entity is using this auth strategy.

CreatedAt string

An ISO-8601 timestamp representation of entity creation date.

DisplayName string

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

Id string

The provider-assigned unique ID for this managed resource.

Name string

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

StrategyType string

SupportsMultipleCredentials bool

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

UpdatedAt string

An ISO-8601 timestamp representation of entity update date.

active bool

At least one published entity is using this auth strategy.

created_at string

An ISO-8601 timestamp representation of entity creation date.

display_name string

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

id string

The provider-assigned unique ID for this managed resource.

name string

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

strategy_type string

supports_multiple_credentials bool

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

updated_at string

An ISO-8601 timestamp representation of entity update date.

active Boolean

At least one published entity is using this auth strategy.

createdAt String

An ISO-8601 timestamp representation of entity creation date.

displayName String

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

id String

The provider-assigned unique ID for this managed resource.

name String

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

strategyType String

supportsMultipleCredentials Boolean

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

updatedAt String

An ISO-8601 timestamp representation of entity update date.

active boolean

At least one published entity is using this auth strategy.

createdAt string

An ISO-8601 timestamp representation of entity creation date.

displayName string

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

id string

The provider-assigned unique ID for this managed resource.

name string

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

strategyType string

supportsMultipleCredentials boolean

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

updatedAt string

An ISO-8601 timestamp representation of entity update date.

active bool

At least one published entity is using this auth strategy.

created_at str

An ISO-8601 timestamp representation of entity creation date.

display_name str

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

id str

The provider-assigned unique ID for this managed resource.

name str

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

strategy_type str

supports_multiple_credentials bool

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

updated_at str

An ISO-8601 timestamp representation of entity update date.

active Boolean

At least one published entity is using this auth strategy.

createdAt String

An ISO-8601 timestamp representation of entity creation date.

displayName String

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

id String

The provider-assigned unique ID for this managed resource.

name String

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

strategyType String

supportsMultipleCredentials Boolean

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

updatedAt String

An ISO-8601 timestamp representation of entity update date.

name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

state

Any extra arguments used during the lookup.

opts

A bag of options that control this resource's behavior.

resource_name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

state

Any extra arguments used during the lookup.

opts

A bag of options that control this resource's behavior.

name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

state

Any extra arguments used during the lookup.

opts

A bag of options that control this resource's behavior.

name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

state

Any extra arguments used during the lookup.

opts

A bag of options that control this resource's behavior.

Active bool

At least one published entity is using this auth strategy.

Configs ApplicationAuthStrategyKeyAuthConfigs

JSON-B object containing the configuration for the Key Auth strategy. Not Null

CreatedAt string

An ISO-8601 timestamp representation of entity creation date.

DisplayName string

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

Id string

Contains a unique identifier used for this resource.

Labels Dictionary<string, string>

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

Name string

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

Principals ApplicationAuthStrategyKeyAuthPrincipals

Application principal settings for this auth strategy. Runtime effect applies to V3 API Catalog (ACE) portals and applications; stored values may be set for any auth strategy in the organization.

StrategyType string

Not Null; must be "key_auth"

SupportsMultipleCredentials bool

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

UpdatedAt string

An ISO-8601 timestamp representation of entity update date.

Active bool

At least one published entity is using this auth strategy.

Configs ApplicationAuthStrategyKeyAuthConfigs

JSON-B object containing the configuration for the Key Auth strategy. Not Null

CreatedAt string

An ISO-8601 timestamp representation of entity creation date.

DisplayName string

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

Id string

Contains a unique identifier used for this resource.

Labels map[string]string

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

Name string

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

Principals ApplicationAuthStrategyKeyAuthPrincipals

Application principal settings for this auth strategy. Runtime effect applies to V3 API Catalog (ACE) portals and applications; stored values may be set for any auth strategy in the organization.

StrategyType string

Not Null; must be "key_auth"

SupportsMultipleCredentials bool

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

UpdatedAt string

An ISO-8601 timestamp representation of entity update date.

active bool

At least one published entity is using this auth strategy.

configs object

JSON-B object containing the configuration for the Key Auth strategy. Not Null

created_at string

An ISO-8601 timestamp representation of entity creation date.

display_name string

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

id string

Contains a unique identifier used for this resource.

labels map(string)

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

name string

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

principals object

Application principal settings for this auth strategy. Runtime effect applies to V3 API Catalog (ACE) portals and applications; stored values may be set for any auth strategy in the organization.

strategy_type string

Not Null; must be "key_auth"

supports_multiple_credentials bool

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

updated_at string

An ISO-8601 timestamp representation of entity update date.

active Boolean

At least one published entity is using this auth strategy.

configs ApplicationAuthStrategyKeyAuthConfigs

JSON-B object containing the configuration for the Key Auth strategy. Not Null

createdAt String

An ISO-8601 timestamp representation of entity creation date.

displayName String

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

id String

Contains a unique identifier used for this resource.

labels Map<String,String>

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

name String

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

principals ApplicationAuthStrategyKeyAuthPrincipals

Application principal settings for this auth strategy. Runtime effect applies to V3 API Catalog (ACE) portals and applications; stored values may be set for any auth strategy in the organization.

strategyType String

Not Null; must be "key_auth"

supportsMultipleCredentials Boolean

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

updatedAt String

An ISO-8601 timestamp representation of entity update date.

active boolean

At least one published entity is using this auth strategy.

configs ApplicationAuthStrategyKeyAuthConfigs

JSON-B object containing the configuration for the Key Auth strategy. Not Null

createdAt string

An ISO-8601 timestamp representation of entity creation date.

displayName string

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

id string

Contains a unique identifier used for this resource.

labels {[key: string]: string}

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

name string

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

principals ApplicationAuthStrategyKeyAuthPrincipals

Application principal settings for this auth strategy. Runtime effect applies to V3 API Catalog (ACE) portals and applications; stored values may be set for any auth strategy in the organization.

strategyType string

Not Null; must be "key_auth"

supportsMultipleCredentials boolean

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

updatedAt string

An ISO-8601 timestamp representation of entity update date.

active bool

At least one published entity is using this auth strategy.

configs ApplicationAuthStrategyKeyAuthConfigs

JSON-B object containing the configuration for the Key Auth strategy. Not Null

created_at str

An ISO-8601 timestamp representation of entity creation date.

display_name str

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

id str

Contains a unique identifier used for this resource.

labels Mapping[str, str]

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

name str

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

principals ApplicationAuthStrategyKeyAuthPrincipals

Application principal settings for this auth strategy. Runtime effect applies to V3 API Catalog (ACE) portals and applications; stored values may be set for any auth strategy in the organization.

strategy_type str

Not Null; must be "key_auth"

supports_multiple_credentials bool

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

updated_at str

An ISO-8601 timestamp representation of entity update date.

active Boolean

At least one published entity is using this auth strategy.

configs Property Map

JSON-B object containing the configuration for the Key Auth strategy. Not Null

createdAt String

An ISO-8601 timestamp representation of entity creation date.

displayName String

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

id String

Contains a unique identifier used for this resource.

labels Map<String>

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

name String

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

principals Property Map

Application principal settings for this auth strategy. Runtime effect applies to V3 API Catalog (ACE) portals and applications; stored values may be set for any auth strategy in the organization.

strategyType String

Not Null; must be "key_auth"

supportsMultipleCredentials Boolean

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

updatedAt String

An ISO-8601 timestamp representation of entity update date.

KeyAuth ApplicationAuthStrategyKeyAuthConfigsKeyAuth

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. Not Null

KeyAuth ApplicationAuthStrategyKeyAuthConfigsKeyAuth

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. Not Null

key_auth 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. Not Null

keyAuth ApplicationAuthStrategyKeyAuthConfigsKeyAuth

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. Not Null

keyAuth ApplicationAuthStrategyKeyAuthConfigsKeyAuth

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. Not Null

key_auth ApplicationAuthStrategyKeyAuthConfigsKeyAuth

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. Not Null

keyAuth Property Map

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. Not Null

KeyNames List<string>

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

Ttl ApplicationAuthStrategyKeyAuthConfigsKeyAuthTtl

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

KeyNames []string

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

Ttl ApplicationAuthStrategyKeyAuthConfigsKeyAuthTtl

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

key_names list(string)

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

ttl object

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

keyNames List<String>

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

ttl ApplicationAuthStrategyKeyAuthConfigsKeyAuthTtl

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

keyNames string[]

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

ttl ApplicationAuthStrategyKeyAuthConfigsKeyAuthTtl

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

key_names Sequence[str]

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

ttl ApplicationAuthStrategyKeyAuthConfigsKeyAuthTtl

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

keyNames List<String>

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

ttl Property Map

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

Unit string

possible known values include one of ["days", "weeks", "years"]; Not Null

Value double

Not Null

Unit string

possible known values include one of ["days", "weeks", "years"]; Not Null

Value float64

Not Null

unit string

possible known values include one of ["days", "weeks", "years"]; Not Null

value number

Not Null

unit String

possible known values include one of ["days", "weeks", "years"]; Not Null

value Double

Not Null

unit string

possible known values include one of ["days", "weeks", "years"]; Not Null

value number

Not Null

unit str

possible known values include one of ["days", "weeks", "years"]; Not Null

value float

Not Null

unit String

possible known values include one of ["days", "weeks", "years"]; Not Null

value Number

Not Null

Enabled bool

Whether application principals are enabled for this auth strategy. Default: false

Enabled bool

Whether application principals are enabled for this auth strategy. Default: false

enabled bool

Whether application principals are enabled for this auth strategy. Default: false

enabled Boolean

Whether application principals are enabled for this auth strategy. Default: false

enabled boolean

Whether application principals are enabled for this auth strategy. Default: false

enabled bool

Whether application principals are enabled for this auth strategy. Default: false

enabled Boolean

Whether application principals are enabled for this auth strategy. Default: false

Active bool

At least one published entity is using this auth strategy.

Configs ApplicationAuthStrategyOpenidConnectConfigs

JSON-B object containing the configuration for the OIDC strategy. Not Null

CreatedAt string

An ISO-8601 timestamp representation of entity creation date.

DcrProviderId string

DisplayName string

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

Id string

Contains a unique identifier used for this resource.

Labels Dictionary<string, string>

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

Name string

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

Principals ApplicationAuthStrategyOpenidConnectPrincipals

Application principal settings for this auth strategy. Runtime effect applies to V3 API Catalog (ACE) portals and applications; stored values may be set for any auth strategy in the organization.

StrategyType string

Not Null; must be "openid_connect"

SupportsMultipleCredentials bool

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

UpdatedAt string

An ISO-8601 timestamp representation of entity update date.

Active bool

At least one published entity is using this auth strategy.

Configs ApplicationAuthStrategyOpenidConnectConfigs

JSON-B object containing the configuration for the OIDC strategy. Not Null

CreatedAt string

An ISO-8601 timestamp representation of entity creation date.

DcrProviderId string

DisplayName string

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

Id string

Contains a unique identifier used for this resource.

Labels map[string]string

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

Name string

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

Principals ApplicationAuthStrategyOpenidConnectPrincipals

Application principal settings for this auth strategy. Runtime effect applies to V3 API Catalog (ACE) portals and applications; stored values may be set for any auth strategy in the organization.

StrategyType string

Not Null; must be "openid_connect"

SupportsMultipleCredentials bool

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

UpdatedAt string

An ISO-8601 timestamp representation of entity update date.

active bool

At least one published entity is using this auth strategy.

configs object

JSON-B object containing the configuration for the OIDC strategy. Not Null

created_at string

An ISO-8601 timestamp representation of entity creation date.

dcr_provider_id string

display_name string

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

id string

Contains a unique identifier used for this resource.

labels map(string)

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

name string

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

principals object

Application principal settings for this auth strategy. Runtime effect applies to V3 API Catalog (ACE) portals and applications; stored values may be set for any auth strategy in the organization.

strategy_type string

Not Null; must be "openid_connect"

supports_multiple_credentials bool

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

updated_at string

An ISO-8601 timestamp representation of entity update date.

active Boolean

At least one published entity is using this auth strategy.

configs ApplicationAuthStrategyOpenidConnectConfigs

JSON-B object containing the configuration for the OIDC strategy. Not Null

createdAt String

An ISO-8601 timestamp representation of entity creation date.

dcrProviderId String

displayName String

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

id String

Contains a unique identifier used for this resource.

labels Map<String,String>

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

name String

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

principals ApplicationAuthStrategyOpenidConnectPrincipals

Application principal settings for this auth strategy. Runtime effect applies to V3 API Catalog (ACE) portals and applications; stored values may be set for any auth strategy in the organization.

strategyType String

Not Null; must be "openid_connect"

supportsMultipleCredentials Boolean

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

updatedAt String

An ISO-8601 timestamp representation of entity update date.

active boolean

At least one published entity is using this auth strategy.

configs ApplicationAuthStrategyOpenidConnectConfigs

JSON-B object containing the configuration for the OIDC strategy. Not Null

createdAt string

An ISO-8601 timestamp representation of entity creation date.

dcrProviderId string

displayName string

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

id string

Contains a unique identifier used for this resource.

labels {[key: string]: string}

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

name string

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

principals ApplicationAuthStrategyOpenidConnectPrincipals

Application principal settings for this auth strategy. Runtime effect applies to V3 API Catalog (ACE) portals and applications; stored values may be set for any auth strategy in the organization.

strategyType string

Not Null; must be "openid_connect"

supportsMultipleCredentials boolean

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

updatedAt string

An ISO-8601 timestamp representation of entity update date.

active bool

At least one published entity is using this auth strategy.

configs ApplicationAuthStrategyOpenidConnectConfigs

JSON-B object containing the configuration for the OIDC strategy. Not Null

created_at str

An ISO-8601 timestamp representation of entity creation date.

dcr_provider_id str

display_name str

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

id str

Contains a unique identifier used for this resource.

labels Mapping[str, str]

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

name str

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

principals ApplicationAuthStrategyOpenidConnectPrincipals

Application principal settings for this auth strategy. Runtime effect applies to V3 API Catalog (ACE) portals and applications; stored values may be set for any auth strategy in the organization.

strategy_type str

Not Null; must be "openid_connect"

supports_multiple_credentials bool

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

updated_at str

An ISO-8601 timestamp representation of entity update date.

active Boolean

At least one published entity is using this auth strategy.

configs Property Map

JSON-B object containing the configuration for the OIDC strategy. Not Null

createdAt String

An ISO-8601 timestamp representation of entity creation date.

dcrProviderId String

displayName String

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

id String

Contains a unique identifier used for this resource.

labels Map<String>

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

name String

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

principals Property Map

Application principal settings for this auth strategy. Runtime effect applies to V3 API Catalog (ACE) portals and applications; stored values may be set for any auth strategy in the organization.

strategyType String

Not Null; must be "openid_connect"

supportsMultipleCredentials Boolean

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

updatedAt String

An ISO-8601 timestamp representation of entity update date.

OpenidConnect ApplicationAuthStrategyOpenidConnectConfigsOpenidConnect

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. Not Null

OpenidConnect ApplicationAuthStrategyOpenidConnectConfigsOpenidConnect

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. Not Null

openid_connect 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. Not Null

openidConnect ApplicationAuthStrategyOpenidConnectConfigsOpenidConnect

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. Not Null

openidConnect ApplicationAuthStrategyOpenidConnectConfigsOpenidConnect

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. Not Null

openid_connect ApplicationAuthStrategyOpenidConnectConfigsOpenidConnect

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. Not Null

openidConnect Property Map

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. Not Null

AdditionalProperties string

Parsed as JSON.

AuthMethods List<string>

Not Null

CredentialClaims List<string>

Not Null

Issuer string

Not Null

Scopes List<string>

Not Null

AdditionalProperties string

Parsed as JSON.

AuthMethods []string

Not Null

CredentialClaims []string

Not Null

Issuer string

Not Null

Scopes []string

Not Null

additional_properties string

Parsed as JSON.

auth_methods list(string)

Not Null

credential_claims list(string)

Not Null

issuer string

Not Null

scopes list(string)

Not Null

additionalProperties String

Parsed as JSON.

authMethods List<String>

Not Null

credentialClaims List<String>

Not Null

issuer String

Not Null

scopes List<String>

Not Null

additionalProperties string

Parsed as JSON.

authMethods string[]

Not Null

credentialClaims string[]

Not Null

issuer string

Not Null

scopes string[]

Not Null