---
title: "Konnect Application Auth Strategies"
url: "https://nov18-dev.movespot.fyi/apis/konnect-application-auth-strategies-2/versions/bd73d053-0812-4727-92b1-ce07bee7e3a8"
---

# Konnect Application Auth Strategies

OpenAPI specification document.

```json
{"openapi":"3.0.3","info":{"title":"Konnect Application Auth Strategies","version":"2.0.6","description":"The API for Kong Konnect Portal Application Configuration","contact":{"name":"Kong","url":"https://cloud.konghq.com"}},"servers":[{"url":"https://us.api.konghq.com/v2","description":"United-States Production region"},{"url":"https://eu.api.konghq.com/v2","description":"Europe Production region"},{"url":"https://au.api.konghq.com/v2","description":"Australia Production region"},{"url":"https://me.api.konghq.com/v2","description":"Middle-East Production region"},{"url":"https://in.api.konghq.com/v2","description":"India Production region"},{"url":"https://sg.api.konghq.com/v2","description":"Singapore Production region"}],"paths":{"/dcr-providers":{"post":{"operationId":"create-dcr-provider","summary":"Create DCR provider","description":"Creates a DCR provider.","requestBody":{"$ref":"#/components/requestBodies/CreateDcrProvider"},"responses":{"201":{"$ref":"#/components/responses/CreateDcrProvider"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["DCR Providers"]},"get":{"operationId":"list-dcr-providers","summary":"List DCR Providers","description":"Returns a paginated collection of DCR providers.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"$ref":"#/components/parameters/SortDcrProviders"},{"$ref":"#/components/parameters/FilterDcrProvidersById"},{"$ref":"#/components/parameters/FilterDcrProvidersByIdShort"},{"$ref":"#/components/parameters/FilterDcrProvidersByIdContains"},{"$ref":"#/components/parameters/FilterDcrProvidersByIssuer"},{"$ref":"#/components/parameters/FilterDcrProvidersByIssuerShort"},{"$ref":"#/components/parameters/FilterDcrProvidersByIssuerContains"},{"$ref":"#/components/parameters/FilterDcrProvidersByName"},{"$ref":"#/components/parameters/FilterDcrProvidersByNameShort"},{"$ref":"#/components/parameters/FilterDcrProvidersByNameContains"},{"$ref":"#/components/parameters/FilterDcrProvidersByProviderType"},{"$ref":"#/components/parameters/FilterDcrProvidersByProviderTypeShort"},{"$ref":"#/components/parameters/FilterDcrProvidersByInitialClientId"},{"$ref":"#/components/parameters/FilterDcrProvidersByInitialClientIdShort"},{"$ref":"#/components/parameters/FilterDcrProvidersByInitialClientIdContains"},{"$ref":"#/components/parameters/FilterDcrProvidersByInitialClientAudience"},{"$ref":"#/components/parameters/FilterDcrProvidersByInitialClientAudienceShort"},{"$ref":"#/components/parameters/FilterDcrProvidersByInitialClientAudienceContains"}],"responses":{"200":{"$ref":"#/components/responses/ListDcrProviders"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["DCR Providers"]}},"/dcr-providers/{dcrProviderId}":{"parameters":[{"$ref":"#/components/parameters/DcrProviderId"}],"get":{"operationId":"get-dcr-provider","summary":"Get a DCR provider","description":"Returns a DCR provider.","responses":{"200":{"$ref":"#/components/responses/GetDcrProvider"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["DCR Providers"]},"patch":{"operationId":"update-dcr-provider","summary":"Update DCR provider","description":"Updates a DCR provider.","requestBody":{"$ref":"#/components/requestBodies/UpdateDcrProvider"},"responses":{"200":{"$ref":"#/components/responses/GetDcrProvider"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["DCR Providers"]},"delete":{"operationId":"delete-dcr-provider","summary":"Delete DCR provider","description":"Deletes a DCR provider.","responses":{"204":{"description":"No Content."},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["DCR Providers"]}},"/dcr-providers/{dcrProviderId}/verify":{"parameters":[{"$ref":"#/components/parameters/DcrProviderId"}],"post":{"operationId":"verify-dcr-provider","summary":"Verify DCR provider configuration","description":"Verifies if a DCR provider is configured properly. Returns 200 for success, 4xx for failure.","responses":{"200":{"$ref":"#/components/responses/VerifyDcrProvider"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["DCR Providers"]}},"/application-auth-strategies":{"post":{"operationId":"create-app-auth-strategy","summary":"Create App Auth Strategy","description":"Creates an application auth strategy.","requestBody":{"$ref":"#/components/requestBodies/CreateAppAuthStrategy"},"responses":{"201":{"$ref":"#/components/responses/CreateAppAuthStrategy"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["App Auth Strategies"]},"get":{"operationId":"list-app-auth-strategies","summary":"List App Auth Strategies","description":"Returns a paginated collection of application auth strategies.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"$ref":"#/components/parameters/SortAppAuthStrategies"},{"name":"filter","in":"query","description":"Filter application auth strategies returned in the response.","required":false,"schema":{"type":"object","properties":{"strategy_type":{"$ref":"#/components/schemas/StringFieldFilter"},"name":{"$ref":"#/components/schemas/StringFieldFilter"},"display_name":{"$ref":"#/components/schemas/StringFieldFilter"},"dcr_provider_id":{"$ref":"#/components/schemas/UuidFieldFilter"},"dcr_provider_name":{"$ref":"#/components/schemas/StringFieldFilter"},"dcr_provider_type":{"$ref":"#/components/schemas/StringFieldFilter"}}},"style":"deepObject"}],"responses":{"200":{"$ref":"#/components/responses/ListAppAuthStrategies"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["App Auth Strategies"]}},"/application-auth-strategies/{authStrategyId}":{"parameters":[{"$ref":"#/components/parameters/AuthStrategyId"}],"get":{"operationId":"get-app-auth-strategy","summary":"Get App Auth Strategy","description":"Returns an application auth strategy.","responses":{"200":{"$ref":"#/components/responses/GetAppAuthStrategy"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["App Auth Strategies"]},"put":{"operationId":"replace-app-auth-strategy","summary":"Replace App Auth Strategy","description":"Replaces an application auth strategy.","requestBody":{"$ref":"#/components/requestBodies/CreateAppAuthStrategy"},"responses":{"201":{"$ref":"#/components/responses/CreateAppAuthStrategy"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["App Auth Strategies"]},"patch":{"operationId":"update-app-auth-strategy","summary":"Update App Auth Strategy","description":"Updates an application auth strategy.","requestBody":{"$ref":"#/components/requestBodies/UpdateAppAuthStrategy"},"responses":{"200":{"$ref":"#/components/responses/UpdateAppAuthStrategy"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["App Auth Strategies"]},"delete":{"operationId":"delete-app-auth-strategy","summary":"Delete App Auth Strategy","description":"Deletes an application auth strategy. An application auth strategy can be deleted ONLY if it's not used by any product version within any portal regardless of their publication statuses. If an application auth strategy is still in use the request will result in an HTTP 409 CONFLICT.","responses":{"204":{"description":"No Content."},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}},"tags":["App Auth Strategies"]}}},"components":{"parameters":{"AuthStrategyId":{"name":"authStrategyId","description":"Application auth strategy identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},"DcrProviderId":{"name":"dcrProviderId","description":"DCR provider identifier","in":"path","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},"FilterDcrProvidersById":{"name":"filter[id][eq]","description":"filters DCR Providers by their id","in":"query","required":false,"schema":{"type":"string"}},"FilterDcrProvidersByIdContains":{"name":"filter[id][contains]","description":"filters DCR Providers by their id with a supplied substring","in":"query","required":false,"schema":{"type":"string"}},"FilterDcrProvidersByIdShort":{"name":"filter[id]","description":"filters DCR Providers by their id (alias for filter[id][eq])","in":"query","required":false,"schema":{"type":"string"}},"FilterDcrProvidersByInitialClientAudience":{"name":"filter[initial_client_audience][eq]","description":"filters DCR Providers by their initial client audience","in":"query","required":false,"schema":{"type":"string"}},"FilterDcrProvidersByInitialClientAudienceContains":{"name":"filter[initial_client_audience][contains]","description":"filters DCR Providers by their initial client audience with a supplied substring","in":"query","required":false,"schema":{"type":"string"}},"FilterDcrProvidersByInitialClientAudienceShort":{"name":"filter[initial_client_audience]","description":"filters DCR Providers by their initial client audience (alias for filter[initial_client_audience][eq])","in":"query","required":false,"schema":{"type":"string"}},"FilterDcrProvidersByInitialClientId":{"name":"filter[initial_client_id][eq]","description":"filters DCR Providers by their initial client id","in":"query","required":false,"schema":{"type":"string"}},"FilterDcrProvidersByInitialClientIdContains":{"name":"filter[initial_client_id][contains]","description":"filters DCR Providers by their initial client id with a supplied substring","in":"query","required":false,"schema":{"type":"string"}},"FilterDcrProvidersByInitialClientIdShort":{"name":"filter[initial_client_id]","description":"filters DCR Providers by their initial client id (alias for filter[initial_client_id][eq])","in":"query","required":false,"schema":{"type":"string"}},"FilterDcrProvidersByIssuer":{"name":"filter[issuer][eq]","description":"filters DCR Providers by their issuer","in":"query","required":false,"schema":{"type":"string"}},"FilterDcrProvidersByIssuerContains":{"name":"filter[issuer][contains]","description":"filters DCR Providers by their issuer with a supplied substring","in":"query","required":false,"schema":{"type":"string"}},"FilterDcrProvidersByIssuerShort":{"name":"filter[issuer]","description":"filters DCR Providers by their issuer (alias for filter[issuer][eq])","in":"query","required":false,"schema":{"type":"string"}},"FilterDcrProvidersByName":{"name":"filter[name][eq]","description":"filters DCR Providers by their name","in":"query","required":false,"schema":{"type":"string"}},"FilterDcrProvidersByNameContains":{"name":"filter[name][contains]","description":"filters DCR Providers by their name with a supplied substring","in":"query","required":false,"schema":{"type":"string"}},"FilterDcrProvidersByNameShort":{"name":"filter[name]","description":"filters DCR Providers by their name (alias for filter[name][eq])","in":"query","required":false,"schema":{"type":"string"}},"FilterDcrProvidersByProviderType":{"name":"filter[provider_type][eq]","description":"filters DCR Providers by their provider type","in":"query","required":false,"schema":{"type":"string"}},"FilterDcrProvidersByProviderTypeShort":{"name":"filter[provider_type]","description":"filters DCR Providers by their provider type (alias for filter[provider_type][eq])","in":"query","required":false,"schema":{"type":"string"}},"PageNumber":{"name":"page[number]","description":"Determines which page of the entities to retrieve.","required":false,"in":"query","allowEmptyValue":true,"schema":{"type":"integer","example":1}},"PageSize":{"name":"page[size]","description":"The maximum number of items to include per page. The last page of a collection may include fewer items.","required":false,"in":"query","allowEmptyValue":true,"schema":{"type":"integer","example":10}},"SortAppAuthStrategies":{"name":"sort","description":"Sorts a collection of application auth strategies. Supported sort attributes are:\n  - created_at\n  - updated_at\n  - strategy_type\n  - name\n  - display_name\n  - dcr_provider_id\n  - dcr_provider_name\n  - dcr_provider_type\n","in":"query","required":false,"schema":{"type":"string"}},"SortDcrProviders":{"name":"sort","description":"Sorts a collection of DCR Providers. Supported sort attributes are:\n  - created_at\n  - updated_at\n  - provider_type\n  - issuer\n  - name\n","in":"query","required":false,"schema":{"type":"string"}}},"schemas":{"DcrConfigPropertyInitialClientId":{"description":"This ID should be copied from your identity provider's settings after you create a client\nand assign it as the management client for DCR for this developer portal\n","type":"string","maxLength":256,"title":"DcrConfigPropertyInitialClientId"},"DcrConfigPropertyInitialClientSecret":{"description":"This secret should be copied from your identity provider's settings after you create a client\nand assign it as the management client for DCR for this developer portal\n","type":"string","maxLength":256,"title":"DcrConfigPropertyInitialClientSecret"},"DcrConfigPropertyDcrToken":{"description":"This secret should be copied from your identity provider's settings after you create a client\nand assign it as the management client for DCR for this developer portal\n","type":"string","maxLength":256,"title":"DcrConfigPropertyInitialDcrToken"},"DcrConfigPropertyInitialClientAudience":{"description":"This is the audience value used for the initial client.\nIf using a custom domain on Auth0, this must be set as to the Auth0 Management API audience value.\nIf left blank, the issuer will be used instead.\n","type":"string","maxLength":256,"nullable":true,"title":"DcrConfigPropertyInitialClientAudience"},"DcrConfigPropertyApiKey":{"description":"This is the API Key that will be sent with each HTTP request to the custom DCR server. It can be\nverified on the server to ensure that incoming requests are coming from Konnect.\n","type":"string","maxLength":256,"minLength":12,"pattern":"^[a-zA-Z0-9_]+$","title":"DcrConfigPropertyApiKey"},"DcrConfigPropertyDisableEventHooks":{"description":"This flag disables all the event-hooks on the application flow for the DCR provider.","type":"boolean","title":"DcrConfigPropertyDisableEventHooks"},"DcrConfigPropertyDisableRefreshSecret":{"description":"This flag disable the refresh-secret endpoint on the application flow for the DCR provider.","type":"boolean","title":"DcrConfigPropertyDisableRefreshSecret"},"DcrConfigPropertyAllowMultipleCredentials":{"description":"When enabled, indicates that the DCR provider supports creating and managing multiple credentials per application.","type":"boolean","default":false,"title":"DcrConfigPropertyAllowMultipleCredentials"},"DcrConfigAuth0InResponse":{"description":"A DCR provider configuration for Auth0","type":"object","properties":{"initial_client_id":{"$ref":"#/components/schemas/DcrConfigPropertyInitialClientId"},"initial_client_audience":{"$ref":"#/components/schemas/DcrConfigPropertyInitialClientAudience"},"use_developer_managed_scopes":{"type":"boolean"}},"additionalProperties":false,"required":["initial_client_id","initial_client_audience","use_developer_managed_scopes"],"title":"DcrConfigAuth0InResponse"},"CreateDcrConfigAuth0InRequest":{"description":"Payload to create an Auth0 DCR provider.","type":"object","properties":{"initial_client_id":{"$ref":"#/components/schemas/DcrConfigPropertyInitialClientId"},"initial_client_secret":{"$ref":"#/components/schemas/DcrConfigPropertyInitialClientSecret"},"initial_client_audience":{"$ref":"#/components/schemas/DcrConfigPropertyInitialClientAudience"},"use_developer_managed_scopes":{"type":"boolean"}},"additionalProperties":false,"required":["initial_client_id","initial_client_secret"],"title":"DcrConfigAuth0InRequest"},"UpdateDcrConfigAuth0InRequest":{"description":"Payload to update an Auth0 DCR provider.","type":"object","properties":{"initial_client_id":{"$ref":"#/components/schemas/DcrConfigPropertyInitialClientId"},"initial_client_secret":{"$ref":"#/components/schemas/DcrConfigPropertyInitialClientSecret"},"initial_client_audience":{"$ref":"#/components/schemas/DcrConfigPropertyInitialClientAudience"},"use_developer_managed_scopes":{"type":"boolean"}},"additionalProperties":false,"title":"DcrConfigAuth0InRequest"},"DcrConfigAzureAdInResponse":{"description":"A DCR provider configuration for Azure AD","type":"object","properties":{"initial_client_id":{"$ref":"#/components/schemas/DcrConfigPropertyInitialClientId"}},"additionalProperties":false,"required":["initial_client_id"],"title":"DcrConfigAzureAdInResponse"},"CreateDcrConfigAzureAdInRequest":{"description":"Payload to create an Azure AD DCR provider.","type":"object","properties":{"initial_client_id":{"$ref":"#/components/schemas/DcrConfigPropertyInitialClientId"},"initial_client_secret":{"$ref":"#/components/schemas/DcrConfigPropertyInitialClientSecret"}},"additionalProperties":false,"required":["initial_client_id","initial_client_secret"],"title":"DcrConfigAzureAdInRequest"},"UpdateDcrConfigAzureAdInRequest":{"description":"Payload to update an Azure AD DCR provider.","type":"object","properties":{"initial_client_id":{"$ref":"#/components/schemas/DcrConfigPropertyInitialClientId"},"initial_client_secret":{"$ref":"#/components/schemas/DcrConfigPropertyInitialClientSecret"}},"additionalProperties":false,"title":"DcrConfigAzureAdInRequest"},"DcrConfigCurityInResponse":{"description":"A DCR provider configuration for Curity","type":"object","properties":{"initial_client_id":{"$ref":"#/components/schemas/DcrConfigPropertyInitialClientId"}},"additionalProperties":false,"required":["initial_client_id"],"title":"DcrConfigCurityInResponse"},"CreateDcrConfigCurityInRequest":{"description":"Payload to create a Curity DCR provider.","type":"object","properties":{"initial_client_id":{"$ref":"#/components/schemas/DcrConfigPropertyInitialClientId"},"initial_client_secret":{"$ref":"#/components/schemas/DcrConfigPropertyInitialClientSecret"}},"additionalProperties":false,"required":["initial_client_id","initial_client_secret"],"title":"DcrConfigCurityInRequest"},"UpdateDcrConfigCurityInRequest":{"description":"Payload to update a Curity DCR provider.","type":"object","properties":{"initial_client_id":{"$ref":"#/components/schemas/DcrConfigPropertyInitialClientId"},"initial_client_secret":{"$ref":"#/components/schemas/DcrConfigPropertyInitialClientSecret"}},"additionalProperties":false,"title":"DcrConfigCurityInRequest"},"DcrConfigOktaInResponse":{"description":"A DCR provider configuration for Okta","type":"object","properties":{},"additionalProperties":false,"title":"DcrConfigOktaInResponse"},"CreateDcrConfigOktaInRequest":{"description":"Payload to create an Okta DCR provider.","type":"object","properties":{"dcr_token":{"$ref":"#/components/schemas/DcrConfigPropertyDcrToken"}},"additionalProperties":false,"required":["dcr_token"],"title":"DcrConfigOktaInRequest"},"UpdateDcrConfigOktaInRequest":{"description":"Payload to update an Okta DCR provider.","type":"object","properties":{"dcr_token":{"$ref":"#/components/schemas/DcrConfigPropertyDcrToken"}},"additionalProperties":false,"title":"DcrConfigOktaInRequest"},"DcrConfigHttpInResponse":{"description":"A DCR provider configuration for HTTP","type":"object","properties":{"dcr_base_url":{"type":"string","format":"url"},"disable_event_hooks":{"$ref":"#/components/schemas/DcrConfigPropertyDisableEventHooks"},"disable_refresh_secret":{"$ref":"#/components/schemas/DcrConfigPropertyDisableRefreshSecret"},"allow_multiple_credentials":{"$ref":"#/components/schemas/DcrConfigPropertyAllowMultipleCredentials"}},"additionalProperties":false,"required":["dcr_base_url"],"title":"DcrConfigHttpInResponse"},"CreateDcrConfigHttpInRequest":{"description":"Payload to create an HTTP DCR provider.","type":"object","properties":{"dcr_base_url":{"$ref":"#/components/schemas/DcrBaseUrl"},"api_key":{"$ref":"#/components/schemas/DcrConfigPropertyApiKey"},"disable_event_hooks":{"$ref":"#/components/schemas/DcrConfigPropertyDisableEventHooks"},"disable_refresh_secret":{"$ref":"#/components/schemas/DcrConfigPropertyDisableRefreshSecret"},"allow_multiple_credentials":{"$ref":"#/components/schemas/DcrConfigPropertyAllowMultipleCredentials"}},"additionalProperties":false,"required":["dcr_base_url","api_key"],"title":"CreateDcrConfigHttpInRequest"},"UpdateDcrConfigHttpInRequest":{"description":"Payload to update an HTTP DCR provider.","type":"object","properties":{"dcr_base_url":{"$ref":"#/components/schemas/DcrBaseUrl"},"api_key":{"$ref":"#/components/schemas/DcrConfigPropertyApiKey"},"disable_event_hooks":{"$ref":"#/components/schemas/DcrConfigPropertyDisableEventHooks"},"disable_refresh_secret":{"$ref":"#/components/schemas/DcrConfigPropertyDisableRefreshSecret"},"allow_multiple_credentials":{"$ref":"#/components/schemas/DcrConfigPropertyAllowMultipleCredentials"}},"additionalProperties":false,"title":"CreateDcrConfigHttpInRequest"},"DcrProviderBase":{"description":"Properties common to all DCR Providers.","type":"object","properties":{"id":{"$ref":"#/components/schemas/UUID"},"name":{"$ref":"#/components/schemas/DcrProviderName"},"display_name":{"$ref":"#/components/schemas/DcrProviderDisplayName"},"provider_type":{"description":"The type of DCR provider. Can be one of the following - auth0, azureAd, curity, okta, http","type":"string"},"issuer":{"description":"The issuer of the DCR provider.","type":"string","format":"url","maxLength":256},"active":{"description":"At least one active auth strategy is using this DCR provider.","type":"boolean","readOnly":true},"dcr_config":{"description":"The DCR configuration for this DCR provider.","type":"object"},"labels":{"$ref":"#/components/schemas/Labels"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"additionalProperties":false,"required":["id","name","provider_type","issuer","active","dcr_config","created_at","updated_at"]},"DcrProviderAuth0":{"description":"A DCR provider for Auth0 -- only properties not included in DcrProviderBase","type":"object","properties":{"provider_type":{"type":"string","enum":["auth0"]},"dcr_config":{"$ref":"#/components/schemas/DcrConfigAuth0InResponse"}},"required":["provider_type","dcr_config"],"title":"DCR provider - Auth0"},"DcrProviderAzureAd":{"description":"A DCR provider for Azure AD -- only properties not included in DcrProviderBase","type":"object","properties":{"provider_type":{"type":"string","enum":["azureAd"]},"dcr_config":{"$ref":"#/components/schemas/DcrConfigAzureAdInResponse"}},"required":["provider_type","dcr_config"],"title":"DCR provider - Azure AD"},"DcrProviderCurity":{"description":"A DCR provider for Curity -- only properties not included in DcrProviderBase","type":"object","properties":{"provider_type":{"type":"string","enum":["curity"]},"dcr_config":{"$ref":"#/components/schemas/DcrConfigCurityInResponse"}},"required":["provider_type","dcr_config"],"title":"DCR provider - Curity"},"DcrProviderOkta":{"description":"A DCR provider for Okta -- only properties not included in DcrProviderBase","type":"object","properties":{"provider_type":{"type":"string","enum":["okta"]},"dcr_config":{"$ref":"#/components/schemas/DcrConfigOktaInResponse"}},"required":["provider_type","dcr_config"],"title":"DCR provider - OKTA"},"DcrProviderHttp":{"description":"A DCR provider for HTTP -- only properties not included in DcrProviderBase","type":"object","properties":{"provider_type":{"type":"string","enum":["http"]},"dcr_config":{"$ref":"#/components/schemas/DcrConfigHttpInResponse"}},"required":["provider_type","dcr_config"],"title":"DCR provider - HTTP"},"CreateDcrProviderResponse":{"description":"A response containing the newly created DCR provider object.","type":"object","allOf":[{"$ref":"#/components/schemas/DcrProviderBase"},{"discriminator":{"propertyName":"provider_type"},"type":"object","oneOf":[{"$ref":"#/components/schemas/DcrProviderAuth0"},{"$ref":"#/components/schemas/DcrProviderAzureAd"},{"$ref":"#/components/schemas/DcrProviderCurity"},{"$ref":"#/components/schemas/DcrProviderOkta"},{"$ref":"#/components/schemas/DcrProviderHttp"}]}]},"DcrProviderResponse":{"description":"A response containing a single DCR provider object. Sensitive fields will be removed from the response.","type":"object","allOf":[{"$ref":"#/components/schemas/DcrProviderBase"},{"discriminator":{"propertyName":"provider_type"},"type":"object","oneOf":[{"$ref":"#/components/schemas/DcrProviderAuth0"},{"$ref":"#/components/schemas/DcrProviderAzureAd"},{"$ref":"#/components/schemas/DcrProviderCurity"},{"$ref":"#/components/schemas/DcrProviderOkta"},{"$ref":"#/components/schemas/DcrProviderHttp"}]}]},"CreateDcrProviderRequestAuth0":{"description":"Request body for creating an Auth0 DCR provider.","type":"object","properties":{"provider_type":{"type":"string","enum":["auth0"]},"dcr_config":{"$ref":"#/components/schemas/CreateDcrConfigAuth0InRequest"},"name":{"$ref":"#/components/schemas/DcrProviderName"},"display_name":{"$ref":"#/components/schemas/DcrProviderDisplayName"},"issuer":{"type":"string","format":"url","maxLength":256},"labels":{"$ref":"#/components/schemas/Labels"}},"required":["provider_type","dcr_config","name","issuer"],"title":"CreateDcrProviderRequestAuth0"},"CreateDcrProviderRequestAzureAd":{"description":"Request body for creating an Azure AD DCR provider.","type":"object","properties":{"provider_type":{"type":"string","enum":["azureAd"]},"dcr_config":{"$ref":"#/components/schemas/CreateDcrConfigAzureAdInRequest"},"name":{"$ref":"#/components/schemas/DcrProviderName"},"display_name":{"$ref":"#/components/schemas/DcrProviderDisplayName"},"issuer":{"type":"string","format":"url","maxLength":256},"labels":{"$ref":"#/components/schemas/Labels"}},"required":["provider_type","dcr_config","name","issuer"],"title":"CreateDcrProviderRequestAzureAd"},"CreateDcrProviderRequestCurity":{"description":"Request body for creating a Curity DCR provider.","type":"object","properties":{"provider_type":{"type":"string","enum":["curity"]},"dcr_config":{"$ref":"#/components/schemas/CreateDcrConfigCurityInRequest"},"name":{"$ref":"#/components/schemas/DcrProviderName"},"display_name":{"$ref":"#/components/schemas/DcrProviderDisplayName"},"issuer":{"type":"string","format":"url","maxLength":256},"labels":{"$ref":"#/components/schemas/Labels"}},"required":["provider_type","dcr_config","name","issuer"],"title":"CreateDcrProviderRequestCurity"},"CreateDcrProviderRequestOkta":{"description":"Request body for creating an Okta DCR provider.","type":"object","properties":{"provider_type":{"type":"string","enum":["okta"]},"dcr_config":{"$ref":"#/components/schemas/CreateDcrConfigOktaInRequest"},"name":{"$ref":"#/components/schemas/DcrProviderName"},"display_name":{"$ref":"#/components/schemas/DcrProviderDisplayName"},"issuer":{"type":"string","format":"url","maxLength":256},"labels":{"$ref":"#/components/schemas/Labels"}},"required":["provider_type","dcr_config","name","issuer"],"title":"CreateDcrProviderRequestOkta"},"CreateDcrProviderRequestHttp":{"description":"Request body for creating an HTTP DCR provider.","type":"object","properties":{"provider_type":{"type":"string","enum":["http"]},"dcr_config":{"$ref":"#/components/schemas/CreateDcrConfigHttpInRequest"},"name":{"$ref":"#/components/schemas/DcrProviderName"},"display_name":{"$ref":"#/components/schemas/DcrProviderDisplayName"},"issuer":{"type":"string","format":"url","maxLength":256},"labels":{"$ref":"#/components/schemas/Labels"}},"required":["provider_type","dcr_config","name","issuer"],"title":"CreateDcrProviderRequestHttp"},"CreateDcrProviderRequest":{"description":"Request body for creating a DCR provider. The provider_type cannot be updated after creation.","type":"object","discriminator":{"propertyName":"provider_type","mapping":{"auth0":"#/components/schemas/CreateDcrProviderRequestAuth0","azureAd":"#/components/schemas/CreateDcrProviderRequestAzureAd","curity":"#/components/schemas/CreateDcrProviderRequestCurity","okta":"#/components/schemas/CreateDcrProviderRequestOkta","http":"#/components/schemas/CreateDcrProviderRequestHttp"}},"oneOf":[{"$ref":"#/components/schemas/CreateDcrProviderRequestAuth0"},{"$ref":"#/components/schemas/CreateDcrProviderRequestAzureAd"},{"$ref":"#/components/schemas/CreateDcrProviderRequestCurity"},{"$ref":"#/components/schemas/CreateDcrProviderRequestOkta"},{"$ref":"#/components/schemas/CreateDcrProviderRequestHttp"}],"title":"CreateDcrProviderRequest"},"UpdateDcrProviderRequest":{"description":"A set of updates to a DCR provider. The provider_type cannot be updated after creation.","type":"object","properties":{"name":{"$ref":"#/components/schemas/DcrProviderName"},"display_name":{"$ref":"#/components/schemas/DcrProviderDisplayName"},"issuer":{"type":"string","format":"url","maxLength":256},"labels":{"$ref":"#/components/schemas/LabelsUpdate"},"dcr_config":{"anyOf":[{"$ref":"#/components/schemas/UpdateDcrConfigAuth0InRequest"},{"$ref":"#/components/schemas/UpdateDcrConfigAzureAdInRequest"},{"$ref":"#/components/schemas/UpdateDcrConfigCurityInRequest"},{"$ref":"#/components/schemas/UpdateDcrConfigOktaInRequest"},{"$ref":"#/components/schemas/UpdateDcrConfigHttpInRequest"}]}},"additionalProperties":false,"title":"UpdateDcrProviderRequest"},"ListDcrProvidersResponse":{"description":"A paginated list response for a collection of DCR providers","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DcrProviderResponse"}},"meta":{"$ref":"#/components/schemas/PaginatedMeta"}},"additionalProperties":false,"required":["data","meta"],"title":"ListDcrProvidersResponse"},"VerifyDcrProviderResponse":{"description":"A response containing the result of attempting to verify a DCR provider configuration.","type":"object","properties":{"status":{"type":"string","enum":["success","failed"]},"errors":{"type":"array","items":{"type":"string"}}},"additionalProperties":false,"required":["status","errors"],"title":"VerifyDcrProviderResponse"},"AppAuthStrategyConfigKeyAuth":{"description":"The most basic mode to configure an Application Auth Strategy for an API Product Version. \nUsing this mode will allow developers to generate API keys that will authenticate their application requests. \nOnce authenticated, an application will be granted access to any Product Version it is registered for that is configured for Key Auth.\n","type":"object","properties":{"key_names":{"description":"The names of the headers containing the API key. You can specify multiple header names.","type":"array","items":{"type":"string","maxLength":256},"maxItems":10,"minItems":1},"ttl":{"description":"Default maximum Time-To-Live for keys created under this strategy.","type":"object","properties":{"value":{"type":"integer","minimum":1},"unit":{"type":"string","enum":["days","weeks","years"]}},"required":["value","unit"]}},"additionalProperties":false,"title":"AppAuthStrategyConfigKeyAuth"},"PartialAppAuthStrategyConfigKeyAuth":{"description":"Key Auth configuration for updating an Application Auth Strategy.\nThe ttl field can be set to null to unset the Time-To-Live.\n","type":"object","properties":{"key_names":{"description":"The names of the headers containing the API key. You can specify multiple header names.","type":"array","items":{"type":"string","maxLength":256},"maxItems":10,"minItems":1},"ttl":{"description":"Default maximum Time-To-Live for keys created under this strategy. Set to null to unset.","type":"object","nullable":true,"properties":{"value":{"type":"integer","minimum":1},"unit":{"type":"string","enum":["days","weeks","years"]}},"required":["value","unit"]}},"additionalProperties":false,"title":"PartialAppAuthStrategyConfigKeyAuth"},"PartialAppAuthStrategyConfigOpenIDConnect":{"description":"A more advanced mode to configure an API Product Version’s Application Auth Strategy. \nUsing this mode will allow developers to use API credentials issued from an external IdP that will authenticate their application requests. \nOnce authenticated, an application will be granted access to any Product Version it is registered for that is configured for the same Auth Strategy. \nAn OIDC strategy may be used in conjunction with a DCR provider to automatically create the IdP application.\n","type":"object","properties":{"issuer":{"type":"string","format":"url","maxLength":256},"credential_claim":{"type":"array","items":{"type":"string","maxLength":128},"maxItems":10},"scopes":{"type":"array","items":{"type":"string","maxLength":128},"maxItems":50},"auth_methods":{"type":"array","items":{"type":"string","maxLength":64},"maxItems":10}},"additionalProperties":true,"title":"PartialAppAuthStrategyConfigOpenIDConnect"},"AppAuthStrategyConfigOpenIDConnect":{"description":"A more advanced mode to configure an API Product Version’s Application Auth Strategy. \nUsing this mode will allow developers to use API credentials issued from an external IdP that will authenticate their application requests. \nOnce authenticated, an application will be granted access to any Product Version it is registered for that is configured for the same Auth Strategy. \nAn OIDC strategy may be used in conjunction with a DCR provider to automatically create the IdP application.\n","type":"object","properties":{"issuer":{"type":"string","format":"url","maxLength":256},"credential_claim":{"type":"array","items":{"type":"string","maxLength":128},"maxItems":10},"scopes":{"type":"array","items":{"type":"string","maxLength":128},"maxItems":50},"auth_methods":{"type":"array","items":{"type":"string","maxLength":64},"maxItems":10}},"additionalProperties":true,"required":["issuer","credential_claim","scopes","auth_methods"],"title":"AppAuthStrategyConfigOpenIDConnect"},"AppAuthStrategyKeyAuthRequest":{"description":"Request for creating a Key Auth Application Auth Strategy","type":"object","properties":{"name":{"$ref":"#/components/schemas/AuthStrategyName"},"display_name":{"$ref":"#/components/schemas/AuthStrategyDisplayName"},"strategy_type":{"type":"string","enum":["key_auth"]},"configs":{"description":"JSON-B object containing the configuration for the Key Auth strategy","type":"object","additionalProperties":false,"properties":{"key-auth":{"$ref":"#/components/schemas/AppAuthStrategyConfigKeyAuth"}},"required":["key-auth"]},"labels":{"$ref":"#/components/schemas/Labels"}},"additionalProperties":false,"required":["name","display_name","strategy_type","configs"],"title":"AppAuthStrategyKeyAuthRequest"},"AppAuthStrategyKeyAuthResponse":{"description":"Response payload from creating or updating a Key Auth Application Auth Strategy","type":"object","properties":{"id":{"$ref":"#/components/schemas/UUID"},"name":{"$ref":"#/components/schemas/AuthStrategyName"},"display_name":{"$ref":"#/components/schemas/AuthStrategyDisplayName"},"strategy_type":{"type":"string","enum":["key_auth"]},"configs":{"description":"JSON-B object containing the configuration for the Key Auth strategy","type":"object","additionalProperties":false,"properties":{"key-auth":{"$ref":"#/components/schemas/AppAuthStrategyConfigKeyAuth"}},"required":["key-auth"]},"active":{"description":"At least one published entity is using this auth strategy.","type":"boolean"},"dcr_provider":{"type":"object","additionalProperties":false,"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/UUID"},"name":{"type":"string"},"display_name":{"$ref":"#/components/schemas/DcrProviderDisplayName"},"provider_type":{"description":"The type of DCR provider.","type":"string","enum":["auth0","azureAd","curity","okta","http"]}},"required":["id","name","provider_type"]},"labels":{"$ref":"#/components/schemas/Labels"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"},"supports_multiple_credentials":{"description":"Indicates whether this auth strategy supports multiple credentials.\nAlways `true` for KEY_AUTH.\n","type":"boolean","default":true,"readOnly":true}},"additionalProperties":false,"required":["id","name","display_name","strategy_type","configs","active","dcr_provider","labels","created_at","updated_at"],"title":"AppAuthStrategyKeyAuthResponse"},"AppAuthStrategyOpenIDConnectRequest":{"description":"Payload for creating an OIDC Application Auth Strategy","type":"object","properties":{"name":{"$ref":"#/components/schemas/AuthStrategyName"},"display_name":{"$ref":"#/components/schemas/AuthStrategyDisplayName"},"strategy_type":{"type":"string","enum":["openid_connect"]},"configs":{"description":"JSON-B object containing the configuration for the OIDC strategy","type":"object","additionalProperties":false,"properties":{"openid-connect":{"$ref":"#/components/schemas/AppAuthStrategyConfigOpenIDConnect"}},"required":["openid-connect"]},"dcr_provider_id":{"type":"string","format":"uuid","nullable":true},"labels":{"$ref":"#/components/schemas/Labels"}},"additionalProperties":false,"required":["name","display_name","strategy_type","configs"],"title":"AppAuthStrategyOpenIDConnectRequest"},"AppAuthStrategyOpenIDConnectResponse":{"description":"Response payload from creating an OIDC Application Auth Strategy","type":"object","properties":{"id":{"$ref":"#/components/schemas/UUID"},"name":{"$ref":"#/components/schemas/AuthStrategyName"},"display_name":{"$ref":"#/components/schemas/AuthStrategyDisplayName"},"strategy_type":{"type":"string","enum":["openid_connect"]},"configs":{"description":"JSON-B object containing the configuration for the OIDC strategy","type":"object","additionalProperties":false,"properties":{"openid-connect":{"$ref":"#/components/schemas/AppAuthStrategyConfigOpenIDConnect"}},"required":["openid-connect"]},"active":{"description":"At least one published entity is using this auth strategy.","type":"boolean"},"dcr_provider":{"type":"object","additionalProperties":false,"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/UUID"},"name":{"type":"string"},"display_name":{"$ref":"#/components/schemas/DcrProviderDisplayName"},"provider_type":{"description":"The type of DCR provider.","type":"string","enum":["auth0","azureAd","curity","okta","http"]}},"required":["id","name","provider_type"]},"labels":{"$ref":"#/components/schemas/Labels"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"},"supports_multiple_credentials":{"description":"Indicates whether this auth strategy supports multiple credentials.\n- `true` for Key Auth strategies and when supported for Client Credentials strategies\n- `false` when not supported for Client Credentials strategies\n","type":"boolean","readOnly":true}},"additionalProperties":false,"required":["id","name","display_name","strategy_type","configs","active","dcr_provider","labels","created_at","updated_at"],"title":"AppAuthStrategyOpenIDConnectResponse"},"CreateAppAuthStrategyRequest":{"description":"Request body for creating an Application Auth Strategy","type":"object","discriminator":{"propertyName":"strategy_type","mapping":{"key_auth":"#/components/schemas/AppAuthStrategyKeyAuthRequest","openid_connect":"#/components/schemas/AppAuthStrategyOpenIDConnectRequest"}},"oneOf":[{"$ref":"#/components/schemas/AppAuthStrategyKeyAuthRequest"},{"$ref":"#/components/schemas/AppAuthStrategyOpenIDConnectRequest"}],"required":["strategy_type"],"title":"CreateAppAuthStrategyRequest"},"AppAuthStrategy":{"description":"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.","type":"object","discriminator":{"propertyName":"strategy_type","mapping":{"key_auth":"#/components/schemas/AppAuthStrategyKeyAuthResponse","openid_connect":"#/components/schemas/AppAuthStrategyOpenIDConnectResponse"}},"oneOf":[{"$ref":"#/components/schemas/AppAuthStrategyKeyAuthResponse"},{"$ref":"#/components/schemas/AppAuthStrategyOpenIDConnectResponse"}],"required":["strategy_type"],"title":"AppAuthStrategy"},"UpdateAppAuthStrategyRequest":{"description":"Request body for updating an Application Auth Strategy","type":"object","properties":{"name":{"$ref":"#/components/schemas/AuthStrategyName"},"display_name":{"$ref":"#/components/schemas/AuthStrategyDisplayName"},"labels":{"$ref":"#/components/schemas/LabelsUpdate"},"dcr_provider_id":{"type":"string","format":"uuid","nullable":true},"configs":{"description":"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'","type":"object","oneOf":[{"$ref":"#/components/schemas/UpdateAppAuthStrategyRequestOpenIdConnect"},{"$ref":"#/components/schemas/UpdateAppAuthStrategyRequestKeyAuth"}]}},"additionalProperties":false,"title":"UpdateAppAuthStrategyRequest"},"UpdateAppAuthStrategyRequestOpenIdConnect":{"type":"object","properties":{"openid-connect":{"$ref":"#/components/schemas/PartialAppAuthStrategyConfigOpenIDConnect"}},"additionalProperties":false,"required":["openid-connect"]},"UpdateAppAuthStrategyRequestKeyAuth":{"type":"object","properties":{"key-auth":{"$ref":"#/components/schemas/PartialAppAuthStrategyConfigKeyAuth"}},"additionalProperties":false,"required":["key-auth"]},"CreateAppAuthStrategyResponse":{"$ref":"#/components/schemas/AppAuthStrategy"},"UpdateAppAuthStrategyResponse":{"$ref":"#/components/schemas/AppAuthStrategy"},"GetAppAuthStrategyResponse":{"$ref":"#/components/schemas/AppAuthStrategy"},"ListAppAuthStrategiesResponse":{"description":"A paginated list response for a collection of Application Auth Strategies","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AppAuthStrategy"}},"meta":{"$ref":"#/components/schemas/PaginatedMeta"}},"additionalProperties":false,"required":["data","meta"],"title":"ListAppAuthStrategiesResponse"},"DcrBaseUrl":{"description":"The base URL of the DCR server. This is the URL that will be used to make the HTTP requests from Konnect to the DCR provider.\nThis URL must be accessible from the Konnect service.\n","type":"string","format":"url","maxLength":256},"DcrProviderDisplayName":{"description":"The display name of the DCR provider. This is used to identify the DCR provider in the Portal UI.\n","type":"string","maxLength":256,"minLength":1},"DcrProviderName":{"description":"The name of the DCR provider. This is used to identify the DCR provider in the Konnect UI.\n","type":"string","maxLength":256,"minLength":1},"AuthStrategyName":{"description":"The name of the auth strategy. This is used to identify the auth strategy in the Konnect UI.\n","type":"string","maxLength":256,"minLength":1},"AuthStrategyDisplayName":{"description":"The display name of the Auth strategy. This is used to identify the Auth strategy in the Portal UI.\n","type":"string","maxLength":256},"UUID":{"description":"Contains a unique identifier used for this resource.","type":"string","format":"uuid","example":"5f9fd312-a987-4628-b4c5-bb4f4fddd5f7","readOnly":true},"Labels":{"description":"Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types. \n\nKeys must be of length 1-63 characters, and cannot start with \"kong\", \"konnect\", \"mesh\", \"kic\", or \"_\".\n","type":"object","example":{"env":"test"},"additionalProperties":{"type":"string","pattern":"^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$","minLength":1,"maxLength":63},"maxProperties":50,"title":"Labels"},"CreatedAt":{"description":"An ISO-8601 timestamp representation of entity creation date.","type":"string","format":"date-time","example":"2022-11-04T20:10:06.927Z","readOnly":true},"UpdatedAt":{"description":"An ISO-8601 timestamp representation of entity update date.","type":"string","format":"date-time","example":"2022-11-04T20:10:06.927Z","readOnly":true},"PageMeta":{"description":"Contains pagination query parameters and the total number of objects returned.","type":"object","properties":{"number":{"type":"number","example":1},"size":{"type":"number","example":10},"total":{"type":"number","example":100}},"required":["number","size","total"]},"PaginatedMeta":{"description":"returns the pagination information","type":"object","properties":{"page":{"$ref":"#/components/schemas/PageMeta"}},"required":["page"],"title":"PaginatedMeta"},"BaseError":{"description":"standard error","type":"object","properties":{"status":{"description":"The HTTP status code of the error. Useful when passing the response\nbody to child properties in a frontend UI. Must be returned as an integer.\n","type":"integer","readOnly":true},"title":{"description":"A short, human-readable summary of the problem. It should not\nchange between occurences of a problem, except for localization.\nShould be provided as \"Sentence case\" for direct use in the UI.\n","type":"string","readOnly":true},"type":{"description":"The error type.","type":"string","readOnly":true},"instance":{"description":"Used to return the correlation ID back to the user, in the format\nkong:trace:<correlation_id>. This helps us find the relevant logs\nwhen a customer reports an issue.\n","type":"string","readOnly":true},"detail":{"description":"A human readable explanation specific to this occurence of the problem.\nThis field may contain request/entity data to help the user understand\nwhat went wrong. Enclose variable values in square brackets. Should be\nprovided as \"Sentence case\" for direct use in the UI.\n","type":"string","readOnly":true}},"required":["status","title","instance","detail"],"title":"Error"},"InvalidRules":{"description":"invalid parameters rules","type":"string","enum":["required","is_array","is_base64","is_boolean","is_date_time","is_integer","is_null","is_number","is_object","is_string","is_uuid","is_fqdn","is_arn","unknown_property","missing_reference","is_label","matches_regex","invalid","is_supported_network_availability_zone_list","is_supported_network_cidr_block","is_supported_provider_region","type"],"nullable":true,"readOnly":true},"InvalidParameterStandard":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"$ref":"#/components/schemas/InvalidRules"},"source":{"type":"string","example":"body"},"reason":{"type":"string","example":"is a required field","readOnly":true}},"additionalProperties":false,"required":["field","reason"]},"InvalidParameterMinimumLength":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","enum":["min_length","min_digits","min_lowercase","min_uppercase","min_symbols","min_items","min"],"nullable":false,"readOnly":true},"minimum":{"type":"integer","example":8},"source":{"type":"string","example":"body"},"reason":{"type":"string","example":"must have at least 8 characters","readOnly":true}},"additionalProperties":false,"required":["field","reason","rule","minimum"]},"InvalidParameterMaximumLength":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","enum":["max_length","max_items","max"],"nullable":false,"readOnly":true},"maximum":{"type":"integer","example":8},"source":{"type":"string","example":"body"},"reason":{"type":"string","example":"must not have more than 8 characters","readOnly":true}},"additionalProperties":false,"required":["field","reason","rule","maximum"]},"InvalidParameterChoiceItem":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","enum":["enum"],"nullable":false,"readOnly":true},"reason":{"type":"string","example":"is a required field","readOnly":true},"choices":{"type":"array","items":{},"minItems":1,"nullable":false,"readOnly":true,"uniqueItems":true},"source":{"type":"string","example":"body"}},"additionalProperties":false,"required":["field","reason","rule","choices"]},"InvalidParameterDependentItem":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","enum":["dependent_fields"],"nullable":true,"readOnly":true},"reason":{"type":"string","example":"is a required field","readOnly":true},"dependents":{"type":"array","items":{},"nullable":true,"readOnly":true,"uniqueItems":true},"source":{"type":"string","example":"body"}},"additionalProperties":false,"required":["field","rule","reason","dependents"]},"InvalidParameters":{"description":"invalid parameters","type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/InvalidParameterStandard"},{"$ref":"#/components/schemas/InvalidParameterMinimumLength"},{"$ref":"#/components/schemas/InvalidParameterMaximumLength"},{"$ref":"#/components/schemas/InvalidParameterChoiceItem"},{"$ref":"#/components/schemas/InvalidParameterDependentItem"}]},"minItems":1,"nullable":false,"uniqueItems":true},"BadRequestError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","required":["invalid_parameters"],"properties":{"invalid_parameters":{"$ref":"#/components/schemas/InvalidParameters"}}}]},"UnauthorizedError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":401},"title":{"example":"Unauthorized"},"type":{"example":"https://httpstatuses.com/401"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Invalid credentials"}}}]},"ForbiddenError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":403},"title":{"example":"Forbidden"},"type":{"example":"https://httpstatuses.com/403"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Forbidden"}}}]},"NotFoundError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":404},"title":{"example":"Not Found"},"type":{"example":"https://httpstatuses.com/404"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Not found"}}}]},"LabelsUpdate":{"description":"Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types. \n\nLabels are intended to store **INTERNAL** metadata.\n\nKeys must be of length 1-63 characters, and cannot start with \"kong\", \"konnect\", \"mesh\", \"kic\", or \"_\".\n","type":"object","example":{"env":"test"},"additionalProperties":{"type":"string","pattern":"^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$","minLength":1,"maxLength":63,"nullable":true},"maxProperties":50,"nullable":true,"writeOnly":true},"StringFieldFilter":{"oneOf":[{"title":"Filter by operator","description":"Filter using **one** of the following operators: `eq`, `oeq`, `neq`, `contains`, `ocontains`","x-examples":{"example-1":{"contains":"some-value","ocontains":"this-value,or-that-value","oeq":"some-value,some-other-value","neq":"not-this-value"},"example-2":{"eq":"some-value"}},"properties":{"eq":{"description":"The field exactly matches the provided value.","type":"string","example":"?filter[field_name_here][eq]=foo"},"contains":{"description":"The field contains the provided value.","type":"string","example":"?filter[field_name_here][contains]=foo"},"ocontains":{"description":"The field contains any of the provided values.","type":"string","example":"?filter[field_name_here][ocontains]=foo,bar"},"oeq":{"description":"The field matches any of the provided values.","type":"string","example":"?filter[field_name_here][oeq]=foo,bar"},"neq":{"description":"The field does not match the provided value.","type":"string","example":"?filter[field_name_here][neq]=bar"}},"type":"object","additionalProperties":false},{"title":"Filter by exact string match","type":"string","description":"The field exactly matches the provided value.","example":"?filter[title]=foo"}]},"UuidFieldFilter":{"description":"Filter using **one** of the following operators: `eq`, `oeq`, `neq`","type":"object","properties":{"eq":{"description":"The field exactly matches the provided value.","type":"string","example":"?filter[field_name_here][eq]=foo"},"oeq":{"description":"The field matches any of the provided values.","type":"string","example":"?filter[field_name_here][oeq]=foo,bar"},"neq":{"description":"The field does not match the provided value.","type":"string","example":"?filter[field_name_here][neq]=bar"}},"additionalProperties":false,"x-examples":{"example-1":{"oeq":"some-value,some-other-value","neq":"not-this-value"},"example-2":{"eq":"some-value"}}},"ConflictError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":409},"title":{"example":"Conflict"},"type":{"example":"https://httpstatuses.com/409"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Conflict"}}}]}},"examples":{"DcrProviderOktaCreateRequest":{"summary":"DCR provider Okta Create Request","value":{"name":"DCR Okta 1 - Segment A","provider_type":"okta","issuer":"https://my-issuer.okta.com/default","dcr_config":{"dcr_token":"abc123xyz098!"}}},"DcrProviderAuth0CreateRequest":{"summary":"DCR provider Auth0 Create Request","value":{"name":"DCR Auth0 1 - Segment A","provider_type":"auth0","issuer":"https://my-issuer.auth0.com/api/v2/","dcr_config":{"initial_client_id":"abc123","initial_client_secret":"abc123xyz098!","initial_client_audience":"https://my-custom-domain.com/api/v2/"}}},"DcrProviderAzureAdCreateRequest":{"summary":"DCR provider AzureAd Create Request","value":{"name":"DCR Azure 1 - Segment A","provider_type":"azureAd","issuer":"https://sts.windows.net/my-tenant","dcr_config":{"initial_client_id":"abc123","initial_client_secret":"abc123xyz098!"}}},"DcrProviderCurityCreateRequest":{"summary":"DCR provider Curity Create Request","value":{"name":"DCR Curity 1 - Segment A","provider_type":"curity","issuer":"https://my-curity-instance.com/oauth/v2/oauth-anonymous/.well-known/openid-configuration","dcr_config":{"initial_client_id":"abc123","initial_client_secret":"abc123xyz098!"}}},"DcrProviderHttpCreateRequest":{"summary":"DCR provider HTTP Create Request","value":{"name":"DCR HTTP 1 - Segment A","provider_type":"http","issuer":"https://my-issuer-server.com","dcr_config":{"dcr_base_url":"https://my-http-dcr-server.com/v1/dcr","api_key":"gYmrbDfu_7PTsZWH"}}},"DcrProviderOktaUpdateRequest":{"summary":"DCR provider Create Request","value":{"name":"DCR Okta 1 - Segment A","issuer":"https://my-issuer.okta.com/default"}},"DcrProviderAuth0Response":{"summary":"DCR provider Response for Auth0","value":{"id":"93f8380e-7798-4566-99e3-2edf2b57d289","name":"DCR Auth0 1 - Segment A","display_name":"Auth0 DCR provider","provider_type":"auth0","issuer":"https://my-issuer.auth0.com/api/v2/","active":true,"dcr_config":{"initial_client_id":"abc123","initial_client_audience":"https://my-custom-domain.com/api/v2/","use_developer_managed_scopes":false},"created_at":"2023-01-01T00:00:00.000Z","updated_at":"2023-01-01T00:00:00.000Z"}},"DcrProviderAzureAdResponse":{"summary":"DCR provider Response for AzureAd","value":{"id":"93f8380e-7798-4566-99e3-2edf2b57d289","name":"DCR AzureAd 1 - Segment A","display_name":"Client Credentials","provider_type":"azureAd","issuer":"https://sts.windows.net/my-tenant","active":true,"dcr_config":{"initial_client_id":"abc123"},"created_at":"2023-01-01T00:00:00.000Z","updated_at":"2023-01-01T00:00:00.000Z"}},"DcrProviderCurityResponse":{"summary":"DCR provider Response for Curity","value":{"id":"93f8380e-7798-4566-99e3-2edf2b57d289","name":"DCR Curity 1 - Segment A","display_name":"Client Credentials","provider_type":"curity","issuer":"https://my-curity-instance.com/oauth/v2/oauth-anonymous/.well-known/openid-configuration","active":true,"dcr_config":{"initial_client_id":"abc123"},"created_at":"2023-01-01T00:00:00.000Z","updated_at":"2023-01-01T00:00:00.000Z"}},"DcrProviderHttpResponse":{"summary":"DCR provider Response for HTTP","value":{"id":"93f8380e-7798-4566-99e3-2edf2b57d289","name":"DCR HTTP 1 - Segment A","display_name":"Client Credentials","provider_type":"http","issuer":"https://my-issuer-server.com","active":true,"dcr_config":{"dcr_base_url":"https://my-http-dcr-server.com/v1/dcr"},"created_at":"2023-01-01T00:00:00.000Z","updated_at":"2023-01-01T00:00:00.000Z"}},"DcrProviderOktaResponse":{"summary":"DCR provider Response for Okta","value":{"id":"93f8380e-7798-4566-99e3-2edf2b57d289","name":"DCR Okta 1 - Segment A","provider_type":"okta","issuer":"https://my-issuer.okta.com/default","active":true,"dcr_config":{},"created_at":"2023-01-01T00:00:00.000Z","updated_at":"2023-01-01T00:00:00.000Z"}},"ListDcrProvidersResponse":{"summary":"List DCR Providers Response","value":{"data":[{"id":"93f8380e-7798-4566-99e3-2edf2b57d289","name":"DCR Okta 1 - Segment A","provider_type":"okta","issuer":"https://my-issuer.okta.com/default","active":true,"dcr_config":{},"created_at":"2023-01-01T00:00:00.000Z","updated_at":"2023-01-01T00:00:00.000Z"},{"id":"93f8380e-7798-4566-99e3-2edf2b57d289","name":"DCR Okta 1 - Segment B","display_name":"Client Credentials","provider_type":"okta","issuer":"https://my-issuer.okta.com/e19c13a9485e","active":true,"dcr_config":{},"created_at":"2023-01-01T00:00:00.000Z","updated_at":"2023-01-01T00:00:00.000Z"},{"id":"93f8380e-7798-4566-99e3-2edf2b57d290","name":"DCR HTTP 1 - Segment A","display_name":"Client Credentials","provider_type":"http","issuer":"https://my-issuer-server.com","active":true,"dcr_config":{"dcr_base_url":"https://my-http-dcr-server.com/v1/dcr"},"created_at":"2023-01-01T00:00:00.000Z","updated_at":"2023-01-01T00:00:00.000Z"}],"meta":{"page":{"number":1,"size":2,"total":10}}}},"VerifyDcrProviderResponseSuccess":{"summary":"Verify DCR provider Success Response","value":{"status":"success","errors":[]}},"VerifyDcrProviderResponseFailed":{"summary":"Verify DCR provider Failed Response","value":{"status":"failed","errors":["Unable to create the DCR application"]}},"CreateAppAuthStrategyKeyAuthRequest":{"value":{"name":"auth strategy 1","display_name":"API Key Auth","strategy_type":"key_auth","configs":{"key-auth":{"key_names":["apikey","api-key","x-api-key"]}}}},"CreateAppAuthStrategyOpenIDConnectRequest":{"value":{"name":"auth strategy 2","display_name":"Enterprise Auth","strategy_type":"openid_connect","configs":{"openid-connect":{"issuer":"https://oidc.example.com","credential_claim":["client_id"],"scopes":["openid","email"],"auth_methods":["client_credentials","bearer"]}}}},"CreateAppAuthStrategyOpenIDConnectDCRRequest":{"value":{"name":"auth strategy 3","display_name":"Enterprise Auth with DCR","strategy_type":"openid_connect","configs":{"openid-connect":{"issuer":"https://oidc-dcr.example.com","credential_claim":["client_id"],"scopes":["openid","email"],"auth_methods":["client_credentials","bearer"]}},"dcr_provider_id":"73f8380e-7798-4566-99e3-2edf2b57d281"}},"UpdateAppAuthStrategyKeyAuthRequest":{"value":{"display_name":"API Key"}},"UpdateAppAuthStrategyOpenIDConnectRequest":{"value":{"display_name":"Client Credentials"}},"AppAuthStrategyResponseExample1":{"value":{"id":"22f8380e-7798-4566-99e3-2edf2b57d289","name":"auth strategy 1","display_name":"Client Credentials","strategy_type":"openid_connect","active":false,"configs":{"openid-connect":{"issuer":"https://my-issuer.example.com/default","auth_methods":["client_credentials"],"credential_claim":["client_id"],"scopes":["openid","email"]}},"dcr_provider":{"id":"33f8380e-7798-4566-99e3-2edf2b57d289","name":"DCR provider 1","display_name":"Credentials","provider_type":"http"},"labels":{},"created_at":"2023-01-01T00:00:00.000Z","updated_at":"2023-01-01T00:00:00.000Z"}},"ListAppAuthStrategyResponseExample1":{"value":{"data":[{"id":"22f8380e-7798-4566-99e3-2edf2b57d289","name":"auth strategy 1","display_name":"Client Credentials","strategy_type":"openid_connect","active":false,"configs":{"openid-connect":{"issuer":"https://my-issuer.example.com/default","auth_methods":["client_credentials"],"credential_claim":["client_id"],"scopes":["openid","email"]}},"dcr_provider":{"id":"33f8380e-7798-4566-99e3-2edf2b57d289","name":"DCR provider 1","display_name":"Credentials","provider_type":"http"},"labels":{},"created_at":"2023-01-01T00:00:00.000Z","updated_at":"2023-01-01T00:00:00.000Z"}],"meta":{"page":{"number":1,"size":1,"total":10}}}},"UnauthorizedExample":{"value":{"status":401,"title":"Unauthorized","instance":"kong:trace:8347343766220159418","detail":"Unauthorized"}},"ForbiddenExample":{"value":{"status":403,"title":"Forbidden","instance":"kong:trace:2723154947768991354","detail":"You do not have permission to perform this action"}},"NotFoundExample":{"value":{"status":404,"title":"Not Found","instance":"kong:trace:6816496025408232265","detail":"Not Found"}}},"requestBodies":{"CreateDcrProvider":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDcrProviderRequest"},"examples":{"DcrProviderOktaCreateRequest":{"$ref":"#/components/examples/DcrProviderOktaCreateRequest"},"DcrProviderAuth0CreateRequest":{"$ref":"#/components/examples/DcrProviderAuth0CreateRequest"},"DcrProviderAzureAdCreateRequest":{"$ref":"#/components/examples/DcrProviderAzureAdCreateRequest"},"DcrProviderCurityCreateRequest":{"$ref":"#/components/examples/DcrProviderCurityCreateRequest"},"DcrProviderHttpCreateRequest":{"$ref":"#/components/examples/DcrProviderHttpCreateRequest"}}}}},"UpdateDcrProvider":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDcrProviderRequest"},"examples":{"DcrProviderRequest":{"$ref":"#/components/examples/DcrProviderOktaUpdateRequest"}}}}},"CreateAppAuthStrategy":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAppAuthStrategyRequest"},"examples":{"CreateAppAuthStrategyKeyAuthRequest":{"$ref":"#/components/examples/CreateAppAuthStrategyKeyAuthRequest"},"CreateAppAuthStrategyOpenIDConnectRequest":{"$ref":"#/components/examples/CreateAppAuthStrategyOpenIDConnectRequest"},"CreateAppAuthStrategyOpenIDConnectDCRRequest":{"$ref":"#/components/examples/CreateAppAuthStrategyOpenIDConnectDCRRequest"}}}}},"UpdateAppAuthStrategy":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAppAuthStrategyRequest"},"examples":{"UpdateAppAuthStrategyKeyAuthRequest":{"$ref":"#/components/examples/UpdateAppAuthStrategyKeyAuthRequest"},"UpdateAppAuthStrategyOpenIDConnectRequest":{"$ref":"#/components/examples/UpdateAppAuthStrategyOpenIDConnectRequest"}}}}}},"responses":{"CreateDcrProvider":{"description":"A response containing the newly created DCR provider object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDcrProviderResponse"},"examples":{"DcrProviderOkta":{"$ref":"#/components/examples/DcrProviderOktaResponse"},"DcrProviderAuth0":{"$ref":"#/components/examples/DcrProviderAuth0Response"},"DcrProviderAzureAd":{"$ref":"#/components/examples/DcrProviderAzureAdResponse"},"DcrProviderCurity":{"$ref":"#/components/examples/DcrProviderCurityResponse"},"DcrProviderHttp":{"$ref":"#/components/examples/DcrProviderHttpResponse"}}}}},"GetDcrProvider":{"description":"A response containing a single DCR provider object. Sensitive fields will be removed from the response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DcrProviderResponse"},"examples":{"DcrProviderAuth0":{"$ref":"#/components/examples/DcrProviderAuth0Response"},"DcrProviderAzureAd":{"$ref":"#/components/examples/DcrProviderAzureAdResponse"},"DcrProviderCurity":{"$ref":"#/components/examples/DcrProviderCurityResponse"},"DcrProviderHttp":{"$ref":"#/components/examples/DcrProviderHttpResponse"},"DcrProviderOkta":{"$ref":"#/components/examples/DcrProviderOktaResponse"}}}}},"ListDcrProviders":{"description":"A paginated list response for a collection of DCR providers","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDcrProvidersResponse"},"examples":{"ListDcrProviders":{"$ref":"#/components/examples/ListDcrProvidersResponse"}}}}},"VerifyDcrProvider":{"description":"A response containing the result of attempting to verify a DCR provider configuration.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifyDcrProviderResponse"},"examples":{"VerifyDcrProviderSuccess":{"$ref":"#/components/examples/VerifyDcrProviderResponseSuccess"},"VerifyDcrProviderFailed":{"$ref":"#/components/examples/VerifyDcrProviderResponseFailed"}}}}},"CreateAppAuthStrategy":{"description":"A response containing the newly created application auth strategy object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAppAuthStrategyResponse"},"examples":{"AppAuthStrategyResponseExample1":{"$ref":"#/components/examples/AppAuthStrategyResponseExample1"}}}}},"GetAppAuthStrategy":{"description":"A response containing a single application auth strategy object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAppAuthStrategyResponse"},"examples":{"AppAuthStrategyResponseExample1":{"$ref":"#/components/examples/AppAuthStrategyResponseExample1"}}}}},"UpdateAppAuthStrategy":{"description":"A response containing a single updated application auth strategy object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAppAuthStrategyResponse"},"examples":{"AppAuthStrategyResponseExample1":{"$ref":"#/components/examples/AppAuthStrategyResponseExample1"}}}}},"ListAppAuthStrategies":{"description":"A paginated list response for a collection of application auth strategies.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAppAuthStrategiesResponse"},"examples":{"AppAuthStrategyResponseExample1":{"$ref":"#/components/examples/ListAppAuthStrategyResponseExample1"}}}}},"BadRequest":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"Unauthorized":{"description":"Unauthorized","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"},"examples":{"UnauthorizedExample":{"$ref":"#/components/examples/UnauthorizedExample"}}}}},"Forbidden":{"description":"Forbidden","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"},"examples":{"UnauthorizedExample":{"$ref":"#/components/examples/ForbiddenExample"}}}}},"NotFound":{"description":"Not Found","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/NotFoundError"},"examples":{"NotFoundExample":{"$ref":"#/components/examples/NotFoundExample"}}}}},"Conflict":{"description":"Conflict","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConflictError"}}}}}},"tags":[{"name":"DCR Providers","description":"Dynamic Client Registration Providers are configurations representing an external Identity Provider whose clients (i.e. Applications) Konnect will be authorized to manage.\nFor instance, they will be able to perform dynamic client registration (DCR) with the provider. \nThe DCR provider provides credentials to each DCR-enabled application in Konnect that can be used to access Product Versions that the app is registered for.\n"},{"name":"App Auth Strategies","description":"Application Auth Strategies are sets of plugin configurations that represent how the gateway will perform authentication and authorization for a Product Version. \nCalled “Auth Strategy” for short in the context of portals/applications. \nThe plugins are synced to any Gateway Service that is currently linked or becomes linked to the Product Version.\n"}]}
```
