---
title: "Internal API-Builder v1"
url: "https://nov18-dev.movespot.fyi/apis/internal-api-builder-v1-1/versions/37dd8750-3a87-4f5b-aa5c-d7d8aa14eea8"
---

# Internal API-Builder v1

OpenAPI specification document.

```json
{"openapi":"3.0.3","info":{"title":"Internal API-Builder v1","description":"Internal api for api builder to allow updating of entities in api-builder db.","version":"1.0.13","contact":{"name":"Kong","url":"https://konghq.com"}},"servers":[{"url":"builder.apibuilder.svc.cluster.local:3000/v1","description":"Konnect cluster"}],"paths":{"/internal/portals/{portalId}":{"parameters":[{"$ref":"#/components/parameters/PortalId"}],"put":{"operationId":"put-portal","summary":"Upsert Portal","description":"Accepts a raw database representation of the Portal in the request body.\nAccepts a raw database representation of any linked default App Auth Strategy in the response body or null if there is none.\n","requestBody":{"$ref":"#/components/requestBodies/PutPortal"},"responses":{"200":{"description":"The portal has been updated"},"201":{"description":"The portal has been created"},"400":{"$ref":"#/components/responses/BadRequest"}},"tags":["portal"]},"delete":{"operationId":"delete-portal","summary":"Delete Portal","description":"Deletes portal specified in path","parameters":[{"name":"force","in":"query","description":"If true, delete also related publications entities","schema":{"type":"string","default":"false","enum":["true","false"]}}],"responses":{"204":{"description":"No Content."},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["portal"]}},"/internal/apis/details-by-id":{"post":{"operationId":"post-api-details-by-id","summary":"Fetch details for multiple APIs (internal)","description":"Accepts an array of API ids in body\nReturns a list of APIs with their details\n","requestBody":{"$ref":"#/components/requestBodies/PostApiDetailsByIds"},"responses":{"200":{"$ref":"#/components/responses/PostApiDetailsByIdsResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["apis"]}},"/internal/dcr-providers":{"get":{"operationId":"list-dcr-providers","summary":"List DCR providers","description":"Returns a list of DCR providers with their id and active status.\n","parameters":[{"$ref":"#/components/parameters/DcrProviderFilters"}],"responses":{"200":{"$ref":"#/components/responses/ListDcrProvidersResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["DCR Providers"]}},"/internal/dcr-providers/{dcrProviderId}":{"parameters":[{"$ref":"#/components/parameters/DcrProviderId"}],"put":{"operationId":"update-dcr-provider","summary":"Inserts or updates a DCR provider","description":"Accepts a raw database representation of the DCR Provider in the response body\n","requestBody":{"$ref":"#/components/requestBodies/PutDcrProvider"},"responses":{"200":{"$ref":"#/components/responses/PutDcrProviderResponse"},"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":"Deletes a 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"]}},"/internal/application-auth-strategies":{"get":{"operationId":"list-app-auth-strategies","summary":"List application auth strategies","description":"Returns a list of application auth strategies with their id and active status.\n","parameters":[{"$ref":"#/components/parameters/AppAuthStrategyFilters"}],"responses":{"200":{"$ref":"#/components/responses/ListAppAuthStrategiesResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["App Auth Strategies"]}},"/internal/application-auth-strategies/{authStrategyId}":{"parameters":[{"$ref":"#/components/parameters/AuthStrategyId"}],"put":{"operationId":"put-app-auth-strategy","summary":"Upsert an application auth strategy","description":"Accepts a raw database representation of the Auth Strategy in the request body.\nAccepts a raw database representation of the DCR provider (if provided) in the response body.\n","requestBody":{"$ref":"#/components/requestBodies/PutAppAuthStrategy"},"responses":{"200":{"$ref":"#/components/responses/PutAppAuthStrategyResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["App Auth Strategies"]},"delete":{"operationId":"delete-app-auth-strategy","summary":"Deletes an application auth strategy.\n","description":"Deletes the Auth Strategy.","responses":{"204":{"description":"No Content."},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["App Auth Strategies"]}}},"components":{"parameters":{"AppAuthStrategyFilters":{"name":"filter","description":"Filters application auth strategies in the response.","required":true,"in":"query","schema":{"$ref":"#/components/schemas/IdFilter"},"style":"deepObject"},"AuthStrategyId":{"name":"authStrategyId","description":"ID of the auth strategy to use for the application","in":"path","required":true,"schema":{"type":"string","format":"uuid","example":"ebbac5b0-ac89-45c3-9d2e-c4542c657e79"}},"DcrProviderFilters":{"name":"filter","description":"Filters DCR providers in the response.","required":true,"in":"query","schema":{"$ref":"#/components/schemas/IdFilter"},"style":"deepObject"},"DcrProviderId":{"name":"dcrProviderId","description":"DCR provider identifier","in":"path","required":true,"schema":{"type":"string","format":"uuid","example":"ebbac5b0-ac89-45c3-9d2e-c4542c657e79"}},"PortalId":{"schema":{"type":"string","format":"uuid"},"name":"portalId","in":"path","required":true,"description":"ID of the portal."}},"schemas":{"Portal":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"display_name":{"type":"string"},"uri":{"type":"string"},"custom_domain":{"type":"string","nullable":true},"is_domain_verified":{"type":"boolean"},"logo":{"type":"string","nullable":true},"logo_filename":{"type":"string","nullable":true},"favicon":{"type":"string","nullable":true},"favicon_filename":{"type":"string","nullable":true},"is_public":{"type":"boolean"},"authentication_enabled":{"type":"boolean"},"default_api_visibility":{"$ref":"#/components/schemas/Visibility"},"default_page_visibility":{"$ref":"#/components/schemas/Visibility"},"auto_approve_developers":{"type":"boolean"},"auto_approve_applications":{"type":"boolean"},"rbac_enabled":{"type":"boolean"},"config":{"type":"object","additionalProperties":true,"nullable":true},"version":{"type":"string"},"customization":{"type":"object","additionalProperties":true,"nullable":true},"labels":{"$ref":"#/components/schemas/Labels"},"description":{"type":"string","nullable":true},"default_application_auth_strategy":{"$ref":"#/components/schemas/NullableAuthStrategy"}},"required":["id","default_application_auth_strategy","name","uri","labels"],"title":"Portal"},"NullableAuthStrategy":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"display_name":{"type":"string"},"strategy_type":{"type":"string"},"configs":{"type":"object"},"labels":{"$ref":"#/components/schemas/Labels"},"dcr_provider":{"$ref":"#/components/schemas/NullableDcrProvider"}},"nullable":true,"required":["id","name","display_name","strategy_type","dcr_provider","configs","labels"]},"NullableDcrProvider":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"provider_type":{"type":"string"},"issuer":{"type":"string"},"dcr_config":{"type":"object"},"labels":{"$ref":"#/components/schemas/Labels"}},"nullable":true,"required":["id","name","provider_type","issuer","dcr_config","labels"]},"PutDcrProviderRequest":{"description":"Updates a DCR provider.","type":"object","allOf":[{"$ref":"#/components/schemas/DcrProvider"}],"title":"UpdateDcrProviderRequest"},"DcrProvider":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"org_id":{"type":"string","format":"uuid"},"name":{"$ref":"#/components/schemas/DcrProviderName"},"provider_type":{"description":"The type of DCR provider. Can be one of the following - auth0, azureAd, curity, okta, http, kongIdentity","type":"string","enum":["auth0","azureAd","curity","okta","http","kongIdentity"]},"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"}]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["id","name","provider_type","issuer","dcr_config","org_id","created_at","updated_at"],"title":"DcrProvider"},"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},"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},"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"},"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","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","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","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"},"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"},"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"},"DcrConfigPropertyAllowMultipleCredentials":{"description":"When enabled, indicates that the DCR provider supports creating and managing multiple credentials per application.","type":"boolean","default":false,"title":"DcrConfigPropertyAllowMultipleCredentials"},"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"},"UpdateDcrConfigOktaInRequest":{"description":"Payload to update an Okta DCR provider.","type":"object","properties":{"dcr_token":{"$ref":"#/components/schemas/DcrConfigPropertyDcrToken"}},"additionalProperties":false,"title":"DcrConfigOktaInRequest"},"DcrProviderResponse":{"description":"A response containing a raw database representation of the DCR Provider.","type":"object","allOf":[{"$ref":"#/components/schemas/DcrProvider"}]},"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"},"oneOf":[{"$ref":"#/components/schemas/AppAuthStrategyKeyAuth"},{"$ref":"#/components/schemas/AppAuthStrategyOpenIDConnect"}],"title":"AppAuthStrategy"},"AppAuthStrategyOpenIDConnect":{"description":"Response payload from creating an OIDC Application Auth Strategy","type":"object","properties":{"id":{"type":"string","format":"uuid"},"org_id":{"type":"string","format":"uuid"},"name":{"description":"The name of the app auth strategy.\n","type":"string","maxLength":256,"minLength":1},"display_name":{"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},"strategy_type":{"description":"The stategy type. Can be either openid_connect or key_auth.","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":{"$ref":"#/components/schemas/DcrProvider"},"labels":{"$ref":"#/components/schemas/Labels"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"additionalProperties":false,"required":["id","name","display_name","strategy_type","org_id","configs","labels","created_at","updated_at"],"title":"AppAuthStrategyOpenIDConnectResponse"},"AppAuthStrategyKeyAuth":{"description":"Response payload from creating or updating a Key Auth Application Auth Strategy","type":"object","properties":{"id":{"type":"string","format":"uuid"},"org_id":{"type":"string","format":"uuid"},"name":{"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},"display_name":{"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},"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/LabelsUpdate"},"dcr_provider":{"$ref":"#/components/schemas/DcrProvider"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"additionalProperties":false,"required":["id","name","display_name","strategy_type","org_id","configs","labels","created_at","updated_at"],"title":"AppAuthStrategyKeyAuthResponse"},"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"},"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"},"ApiIds":{"type":"object","properties":{"api_ids":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["api_ids"]},"ApisDetailsById":{"type":"object","properties":{"apis":{"type":"array","items":{"$ref":"#/components/schemas/ApiDetails"}}},"required":["apis"]},"ApiDetails":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"version":{"type":"string","nullable":true},"slug":{"type":"string"}},"required":["id","name","version","slug"]},"ActiveResponse":{"description":"The list of items with their active status","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ActiveItem"}}},"required":["data"],"title":"Active Response"},"ActiveItem":{"description":"The item with id and active status","type":"object","properties":{"id":{"description":"The unique identifier of the item","type":"string","format":"uuid"},"active":{"description":"Whether the item is currently active","type":"boolean"}},"required":["id","active"],"title":"Active Item"},"IdFilter":{"description":"Filter parameters for filtering by ID","type":"object","properties":{"id":{"description":"Filter items by their IDs","type":"array","items":{"type":"string","format":"uuid"}}},"title":"ID Filter"},"Visibility":{"type":"string","enum":["public","private"]},"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"},"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"}}}]},"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"}}}]},"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"}}}]},"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}},"examples":{"ApiDetailsByIdsRequest":{"summary":"Application auth strategy request example","value":{"api_ids":["93f8380e-7798-4566-99e3-2edf2b57d289","7f9fd312-a987-4628-b4c5-bb4f4fddd5f7"]}},"AppAuthStrategyRequest":{"summary":"Application auth strategy request example","value":{"id":"93f8380e-7798-4566-99e3-2edf2b57d289","name":"strategy","display_name":"strategy display name","strategy_type":"key_auth","org_id":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","labels":{},"configs":{"key-auth":{"key_names":["secret"]}},"created_at":"2023-01-01T00:00:00.000Z","updated_at":"2023-01-01T00:00:00.000Z","dcr_provider":{"id":"93f8380e-7798-4566-99e3-2edf2b57d289","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_audience":"https://my-custom-domain.com/api/v2/","use_developer_managed_scopes":false},"org_id":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","labels":{},"created_at":"2023-01-01T00:00:00.000Z","updated_at":"2023-01-01T00:00:00.000Z"}}},"DcrProviderPutRequest":{"summary":"DCR provider request example","value":{"id":"93f8380e-7798-4566-99e3-2edf2b57d289","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_audience":"https://my-custom-domain.com/api/v2/","use_developer_managed_scopes":false},"org_id":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","labels":{},"created_at":"2023-01-01T00:00:00.000Z","updated_at":"2023-01-01T00:00:00.000Z"}},"DcrProviderResponse":{"summary":"DCR provider Response example","value":{"id":"93f8380e-7798-4566-99e3-2edf2b57d289","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_audience":"https://my-custom-domain.com/api/v2/","use_developer_managed_scopes":false},"org_id":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","labels":{},"created_at":"2023-01-01T00:00:00.000Z","updated_at":"2023-01-01T00:00:00.000Z"}},"ApiDetailsByIdsResponse":{"summary":"Application auth strategy request example","value":{"apis":[{"id":"93f8380e-7798-4566-99e3-2edf2b57d289","name":"api1","slug":"api1-slug","version":"1.0.0"},{"id":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","name":"api2","slug":"api2-slug","version":"2.0.0"}]}},"ListActiveResponse":{"summary":"List active response example","value":{"data":[{"id":"93f8380e-7798-4566-99e3-2edf2b57d289","active":true},{"id":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","active":false},{"id":"123e4567-e89b-12d3-a456-426614174000","active":true}]}},"NotFoundExample":{"value":{"status":404,"title":"Not Found","instance":"kong:trace:6816496025408232265","detail":"Not Found"}},"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"}}},"requestBodies":{"PutPortal":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Portal"}}}},"PutDcrProvider":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PutDcrProviderRequest"},"examples":{"DcrProviderRequest":{"$ref":"#/components/examples/DcrProviderPutRequest"}}}}},"PutAppAuthStrategy":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppAuthStrategy"},"examples":{"PutAppAuthStrategy":{"$ref":"#/components/examples/AppAuthStrategyRequest"}}}}},"PostApiDetailsByIds":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiIds"},"examples":{"ApiDetailsByIds":{"$ref":"#/components/examples/ApiDetailsByIdsRequest"}}}}}},"responses":{"PutDcrProviderResponse":{"description":"A response containing a single DCR provider object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DcrProviderResponse"},"examples":{"DcrProviderResponse":{"$ref":"#/components/examples/DcrProviderResponse"}}}}},"PutAppAuthStrategyResponse":{"description":"A response containing a single DCR provider object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppAuthStrategy"}}}},"PostApiDetailsByIdsResponse":{"description":"A response containing a single DCR provider object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApisDetailsById"},"examples":{"ApiDetailsByIdsResponse":{"$ref":"#/components/examples/ApiDetailsByIdsResponse"}}}}},"ListDcrProvidersResponse":{"description":"A response containing a list of DCR providers with their status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActiveResponse"},"examples":{"ListDcrProvidersResponse":{"$ref":"#/components/examples/ListActiveResponse"}}}}},"ListAppAuthStrategiesResponse":{"description":"A response containing a list of application auth strategies with their status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActiveResponse"},"examples":{"ListAppAuthStrategiesResponse":{"$ref":"#/components/examples/ListActiveResponse"}}}}},"BadRequest":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"NotFound":{"description":"Not Found","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/NotFoundError"},"examples":{"NotFoundExample":{"$ref":"#/components/examples/NotFoundExample"}}}}},"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"}}}}}}},"tags":[{"name":"portal"},{"name":"DCR Providers"},{"name":"App Auth Strategies"},{"name":"apis"}]}
```
