---
title: "Portal Developer Applications"
url: "https://nov18-dev.movespot.fyi/apis/portal-developer-applications-2/versions/8bf883b0-816e-47b5-b43c-ae6e213e4bb6"
---

# Portal Developer Applications

OpenAPI specification document.

```json
{"openapi":"3.0.0","info":{"title":"Portal Developer Applications","version":"2.0.0","description":"N/A (this description is removed during bundling)","contact":{"name":"Kong","url":"https://cloud.konghq.com"}},"paths":{"/api/v2/applications":{"get":{"operationId":"list-applications","summary":"List Applications","description":"List applications owned by the developer currently logged in.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"$ref":"#/components/parameters/FilterByNameEquality"},{"$ref":"#/components/parameters/FilterByNameEqualityShort"},{"$ref":"#/components/parameters/FilterByNameContains"},{"$ref":"#/components/parameters/FilterByAuthStrategyEquality"},{"$ref":"#/components/parameters/FilterByAuthStrategyEqualityShort"}],"responses":{"200":{"$ref":"#/components/responses/ListApplications"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"}},"security":[{"portalAccessToken":[]}],"tags":["applications"]},"post":{"operationId":"create-application","summary":"Create an Application","description":"Creates a new Application.","requestBody":{"$ref":"#/components/requestBodies/CreateApplication"},"responses":{"201":{"$ref":"#/components/responses/ApplicationCreation"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}},"security":[{"portalAccessToken":[]}],"tags":["applications"]}},"/api/v2/applications/{applicationId}":{"get":{"operationId":"get-application","summary":"Get an Application","description":"Gets the details for an existing application. You need only supply the unique application identifier that was returned upon application creation or by the list-applications endpoint.","parameters":[{"$ref":"#/components/parameters/ApplicationId"}],"responses":{"200":{"$ref":"#/components/responses/GetApplication"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"portalAccessToken":[]}],"tags":["applications"]},"delete":{"operationId":"delete-application","summary":"Delete Application","description":"Deletes an application and all of its associated entities (registrations).","parameters":[{"$ref":"#/components/parameters/ApplicationId"}],"responses":{"204":{"description":"Application was deleted successfully."},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"security":[{"portalAccessToken":[]}],"tags":["applications"]},"patch":{"operationId":"update-application","summary":"Update Application","description":"Updates an application, replacing specified properties with any new values supplied in the request body.","parameters":[{"$ref":"#/components/parameters/ApplicationId"}],"requestBody":{"$ref":"#/components/requestBodies/UpdateApplication"},"responses":{"200":{"$ref":"#/components/responses/ApplicationUpdate"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}},"security":[{"portalAccessToken":[]}],"tags":["applications"]}},"/api/v2/applications/{applicationId}/refresh-token":{"post":{"operationId":"refresh-application-token","summary":"Refresh Client Secret","description":"Resets the client secret for an application.","parameters":[{"$ref":"#/components/parameters/ApplicationId"}],"responses":{"201":{"$ref":"#/components/responses/RefreshToken"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"portalAccessToken":[]}],"tags":["credentials"]}},"/api/v2/applications/{applicationId}/credentials":{"get":{"operationId":"list-credentials","summary":"List credentials","description":"Lists the credentials for an application they own.","parameters":[{"$ref":"#/components/parameters/ApplicationId"},{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"}],"responses":{"200":{"$ref":"#/components/responses/ListCredentials"},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}},"security":[{"portalAccessToken":[]}],"tags":["credentials"]},"post":{"operationId":"create-credential","summary":"Create Credential for Application","description":"Allows a developer to create a credential for an application they own.","parameters":[{"$ref":"#/components/parameters/ApplicationId"}],"requestBody":{"$ref":"#/components/requestBodies/CreateCredential"},"responses":{"201":{"$ref":"#/components/responses/CredentialCreation"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/PostCredentials403Response"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"portalAccessToken":[]}],"tags":["credentials"]}},"/api/v2/applications/{applicationId}/credentials/{credentialId}":{"put":{"operationId":"update-credential","summary":"Update Credential","description":"Updates a credential for an application owned by the current logged in developer.","parameters":[{"$ref":"#/components/parameters/ApplicationId"},{"$ref":"#/components/parameters/CredentialId"}],"requestBody":{"$ref":"#/components/requestBodies/UpdateCredential"},"responses":{"200":{"description":"Credential successfully updated."},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}},"security":[{"portalAccessToken":[]}],"tags":["credentials"]},"delete":{"operationId":"delete-credential","summary":"Delete Credential","description":"Deletes a credential for an application they own.","parameters":[{"$ref":"#/components/parameters/ApplicationId"},{"$ref":"#/components/parameters/CredentialId"}],"responses":{"204":{"description":"Credential successfully deleted."},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}},"security":[{"portalAccessToken":[]}],"tags":["credentials"]}},"/api/v2/applications/{applicationId}/product-versions/{productVersionId}/granted-scopes":{"get":{"operationId":"get-application-product-version-granted-scopes","summary":"Get the granted scopes","description":"Retrieves the granted scopes of a specified application and product version directly from the IDP.\nScopes shared between product versions will be returned, even if not currently registered for given product version.\nWill return 422 if this feature is not supported by the application.\n","parameters":[{"$ref":"#/components/parameters/ApplicationId"},{"$ref":"#/components/parameters/ProductVersionId"}],"responses":{"200":{"$ref":"#/components/responses/GetGrantedScopesProductVersion"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/GetGrantedScopesProductVersion422Response"}},"security":[{"portalAccessToken":[]}],"tags":["applications"]}},"/api/v2/applications/auth-strategies":{"get":{"operationId":"list-application-auth-strategies","summary":"List the available auth strategies","description":"Retrieve the available Auth Strategies on this portal.\nAn Auth Strategy is a set of plugin configurations that represent how the gateway will perform authentication and authorization for a Product Version.\nIt may reference to Key-Auth or an OIDC configuration (with or without DCR).\n","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"$ref":"#/components/parameters/FilterByNameEquality"},{"$ref":"#/components/parameters/FilterByNameEqualityShort"},{"$ref":"#/components/parameters/FilterByNameContains"},{"$ref":"#/components/parameters/FilterByCredentialTypeEquality"}],"responses":{"200":{"$ref":"#/components/responses/ListAuthStrategies"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"}},"security":[{"portalAccessToken":[]}],"tags":["applications"]}}},"components":{"parameters":{"ApplicationId":{"name":"applicationId","in":"path","required":true,"description":"Id of the targeted application","schema":{"type":"string","format":"uuid"}},"CredentialId":{"name":"credentialId","in":"path","required":true,"description":"Id of the targeted credential.\nUse the list-credentials endpoint to obtain the `id` field for each credential.\n","schema":{"type":"string"}},"FilterByAuthStrategyEquality":{"name":"filter[auth_strategy_id][eq]","description":"Filter by the id of the auth strategy supported by the application.","in":"query","required":false,"schema":{"type":"string","example":"5be86298-147b-45ab-bfaf-a1bff97dce39"}},"FilterByAuthStrategyEqualityShort":{"name":"filter[auth_strategy_id]","description":"Filter by the id of the auth strategy supported by the application (short-hand).","in":"query","required":false,"schema":{"type":"string","example":"5be86298-147b-45ab-bfaf-a1bff97dce39"}},"FilterByCredentialTypeEquality":{"name":"filter[credential_type][eq]","description":"Filter by direct equality comparison of the credential_type with a supplied value.","in":"query","required":false,"schema":{"type":"string","example":"key_auth","enum":["client_credentials","self_managed_client_credentials","key_auth"]}},"FilterByNameContains":{"name":"filter[name][contains]","description":"Filter by contains comparison of the name property with a supplied substring","in":"query","required":false,"schema":{"type":"string","example":"good service"}},"FilterByNameEquality":{"name":"filter[name][eq]","description":"Filter by direct equality comparison of the name property with a supplied value.","in":"query","required":false,"schema":{"type":"string","example":"good service"}},"FilterByNameEqualityShort":{"name":"filter[name]","description":"Filter by direct equality comparison (short-hand) of the name property with a supplied value.","in":"query","required":false,"schema":{"type":"string","example":"good service"}},"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}},"ProductVersionId":{"name":"productVersionId","in":"path","required":true,"description":"Contains a unique identifier used by the Portal API for this resource.","schema":{"type":"string","format":"uuid"}}},"schemas":{"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"},"UUID":{"description":"Contains a unique identifier used for this resource.","type":"string","format":"uuid","example":"5f9fd312-a987-4628-b4c5-bb4f4fddd5f7","readOnly":true},"ApplicationReferenceId":{"description":"An identifier to correlate the application with an external system.\nCannot be set when using Dynamic Client Registration.\n","type":"string","maxLength":255},"PortalAuthStrategyKeyAuth":{"description":"KeyAuth Auth strategy that the application uses.","type":"object","properties":{"id":{"description":"The Application Auth Strategy ID.","type":"string","format":"uuid","example":"b9e81174-b5bb-4638-a3c3-8afe61a0abf8","readOnly":true},"name":{"type":"string","example":"name","default":"name"},"credential_type":{"type":"string","enum":["key_auth"]},"key_names":{"type":"array","items":{"type":"string"},"example":["apikey"]},"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"]},"supports_multiple_credentials":{"description":"Indicates whether this auth strategy supports multiple credentials.\nAlways `true` for KEY_AUTH.\n","type":"boolean","default":true,"readOnly":true}},"required":["id","name","credential_type","key_names"]},"AvailableScopes":{"description":"Possible developer selectable scopes for an application. Only present when using DCR Provider that supports it.","type":"array","items":{"type":"string"},"example":["scope1","scope2"]},"AuthMethods":{"type":"array","items":{"description":"Auth Methods enabled for this strategy","type":"string"},"example":["bearer"]},"PortalAuthStrategyClientCredentials":{"description":"Client Credential Auth strategy that the application uses.","type":"object","properties":{"id":{"description":"The Application Auth Strategy ID.","type":"string","format":"uuid","example":"b9e81174-b5bb-4638-a3c3-8afe61a0abf8","readOnly":true},"available_scopes":{"$ref":"#/components/schemas/AvailableScopes"},"name":{"type":"string","example":"name","default":"name"},"credential_type":{"type":"string","enum":["client_credentials","self_managed_client_credentials"]},"auth_methods":{"$ref":"#/components/schemas/AuthMethods"},"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}},"required":["id","name","credential_type","auth_methods"]},"PortalAuthStrategy":{"type":"object","discriminator":{"propertyName":"credential_type"},"oneOf":[{"$ref":"#/components/schemas/PortalAuthStrategyKeyAuth"},{"$ref":"#/components/schemas/PortalAuthStrategyClientCredentials"}]},"Scopes":{"description":"The granted scopes for the application. Will only be included if supported by the application's auth strategy.","type":"array","items":{"type":"string"}},"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},"GetApplicationResponse":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/UUID"},"name":{"type":"string"},"reference_id":{"$ref":"#/components/schemas/ApplicationReferenceId"},"description":{"type":"string","nullable":true},"redirect_uri":{"type":"string","nullable":true},"auth_strategy":{"$ref":"#/components/schemas/PortalAuthStrategy"},"scopes":{"$ref":"#/components/schemas/Scopes"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"additionalProperties":false,"required":["id","name","reference_id","description","updated_at","created_at"]},"ListApplicationsResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/GetApplicationResponse"}}},"additionalProperties":false,"required":["data","meta"]},"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"}}}]},"AuthStrategyId":{"description":"ID of the auth strategy to use for the application. If null or not included, the default application auth strategy will be used.","type":"string","format":"uuid","nullable":true},"CreateApplicationPayload":{"description":"Application creation payload","type":"object","properties":{"name":{"description":"The name of the application","type":"string","maxLength":255},"reference_id":{"$ref":"#/components/schemas/ApplicationReferenceId"},"redirect_uri":{"description":"URL to redirect to after completing an OIDC auth flow","type":"string","format":"uri"},"description":{"description":"A brief description of the application","type":"string","maxLength":255},"auth_strategy_id":{"$ref":"#/components/schemas/AuthStrategyId"},"scopes":{"$ref":"#/components/schemas/Scopes"}},"additionalProperties":false,"required":["name"],"title":"CreateApplicationPayload"},"ApplicationCreationResponse":{"description":"Application creation response payload","type":"object","properties":{"id":{"$ref":"#/components/schemas/UUID"},"name":{"type":"string"},"reference_id":{"$ref":"#/components/schemas/ApplicationReferenceId"},"description":{"type":"string","nullable":true},"redirect_uri":{"type":"string","nullable":true},"credentials":{"type":"object","additionalProperties":false,"properties":{"client_id":{"type":"string"},"client_secret":{"type":"string"}},"required":["client_id","client_secret"]},"auth_strategy":{"$ref":"#/components/schemas/PortalAuthStrategy"},"scopes":{"$ref":"#/components/schemas/Scopes"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"additionalProperties":false,"required":["id","name","reference_id","description","created_at","updated_at","auth_strategy"],"title":"ApplicationCreationResponse"},"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"}}}]},"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"}}}]},"TooManyRequestsError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":429},"title":{"example":"Too Many Requests"},"type":{"example":"https://httpstatuses.com/429"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Too Many Requests"}}}]},"UpdateApplicationPayload":{"description":"Payload required to update an application","type":"object","properties":{"name":{"description":"The name of the application","type":"string","maxLength":255},"reference_id":{"$ref":"#/components/schemas/ApplicationReferenceId"},"redirect_uri":{"description":"URL to redirect to after completing an OIDC auth flow","type":"string","format":"uri"},"description":{"description":"A brief description of the application","type":"string","maxLength":255},"scopes":{"$ref":"#/components/schemas/Scopes"}},"additionalProperties":false,"title":"UpdateApplicationPayload"},"ApplicationUpdateResponse":{"description":"Application update response payload","type":"object","properties":{"id":{"$ref":"#/components/schemas/UUID"},"name":{"type":"string"},"reference_id":{"$ref":"#/components/schemas/ApplicationReferenceId"},"description":{"type":"string","example":"A brief description of the application","nullable":true},"redirect_uri":{"type":"string","example":"https://example.com/callback","nullable":true},"auth_strategy":{"$ref":"#/components/schemas/PortalAuthStrategy"},"scopes":{"$ref":"#/components/schemas/Scopes"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"additionalProperties":false,"required":["id","name","reference_id","description","updated_at","created_at"],"title":"ApplicationUpdateResponse"},"RefreshTokenResponse":{"description":"Refresh token response","type":"object","properties":{"client_id":{"type":"string"},"client_secret":{"type":"string"}},"additionalProperties":false,"required":["client_id","client_secret"],"title":"Refresh token response"},"ApiKeyCredentialListItem":{"description":"API key credential returned when listing credentials.","type":"object","properties":{"type":{"type":"string","enum":["api_key"],"readOnly":true},"id":{"$ref":"#/components/schemas/UUID"},"display_name":{"type":"string"},"status":{"type":"string","enum":["active","expired","revoked"],"readOnly":true},"expires_at":{"type":"string","format":"date-time","nullable":true,"readOnly":true},"created_at":{"$ref":"#/components/schemas/CreatedAt"}},"additionalProperties":false,"required":["type","id","display_name","created_at"]},"ClientSecretCredentialListItem":{"description":"Client secret credential returned when listing credentials.","type":"object","properties":{"type":{"type":"string","enum":["client_secret"],"readOnly":true},"id":{"description":"Credential identifier","type":"string"},"display_name":{"description":"May not be available for all Client Credentials applications","type":"string","nullable":true},"client_id":{"description":"OAuth2 client identifier","type":"string","readOnly":true},"created_at":{"description":"Creation timestamp, if available","type":"string","format":"date-time","nullable":true,"readOnly":true},"expires_at":{"description":"Expiration timestamp, if applicable","type":"string","format":"date-time","nullable":true,"readOnly":true}},"additionalProperties":false,"required":["type","id","client_id","created_at"]},"CredentialListItem":{"type":"object","discriminator":{"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/ApiKeyCredentialListItem"},{"$ref":"#/components/schemas/ClientSecretCredentialListItem"}]},"ListCredentialsResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/CredentialListItem"}}},"additionalProperties":false,"required":["data","meta"]},"CreateCredentialRequest":{"type":"object","properties":{"display_name":{"type":"string","maxLength":255}},"additionalProperties":false},"ApiKeyCredentialCreationResponse":{"description":"Response when creating an API key credential.","type":"object","properties":{"type":{"type":"string","enum":["api_key"],"readOnly":true},"id":{"$ref":"#/components/schemas/UUID"},"display_name":{"type":"string"},"credential":{"description":"The API key value (only returned on creation)","type":"string"},"status":{"type":"string","enum":["active","expired","revoked"],"readOnly":true},"expires_at":{"type":"string","format":"date-time","nullable":true,"readOnly":true},"created_at":{"$ref":"#/components/schemas/CreatedAt"}},"additionalProperties":false,"required":["type","id","display_name","credential","created_at"]},"ClientSecretCredentialCreationResponse":{"description":"Response when creating a client secret credential.","type":"object","properties":{"type":{"type":"string","enum":["client_secret"],"readOnly":true},"id":{"description":"Credential identifier","type":"string"},"display_name":{"type":"string","nullable":true},"client_id":{"type":"string","readOnly":true},"client_secret":{"description":"Client secret value (only returned on creation)","type":"string"},"created_at":{"type":"string","format":"date-time","nullable":true,"readOnly":true},"expires_at":{"description":"Expiration timestamp, if applicable","type":"string","format":"date-time","nullable":true,"readOnly":true}},"additionalProperties":false,"required":["type","id","client_id","client_secret","created_at"]},"CredentialCreationResponse":{"type":"object","discriminator":{"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/ApiKeyCredentialCreationResponse"},{"$ref":"#/components/schemas/ClientSecretCredentialCreationResponse"}]},"UpdateCredentialRequest":{"type":"object","properties":{"display_name":{"type":"string","maxLength":255}},"additionalProperties":false,"required":["display_name"]},"RefreshedGrantedScopes":{"description":"List of granted scopes, directly updated from the IDP","type":"array","items":{"type":"string"}},"GetGrantedScopesProductVersionResponse":{"type":"object","properties":{"scopes":{"$ref":"#/components/schemas/RefreshedGrantedScopes"}},"additionalProperties":false,"required":["scopes"]},"UnprocessableContentError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":422},"title":{"example":"Unprocessable Content"},"type":{"example":"https://httpstatuses.com/422"},"instance":{"example":"kong:trace:1234567891"},"detail":{"example":"Unprocessable Content"}}}]},"ListAuthStrategiesResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/PortalAuthStrategy"}}},"additionalProperties":false,"required":["data","meta"]}},"examples":{"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"}},"ListApiKeyCredentialsExample":{"value":{"data":[{"type":"api_key","id":"5f9fd312-a987-4628-b4c5-bb4f4fddd5f7","display_name":"My API Key","status":"active","expires_at":"2025-12-31T23:59:59.000Z","created_at":"2025-01-01T00:00:00.000Z"}],"meta":{"page":{"number":1,"size":10,"total":1}}}},"ListClientSecretCredentialsExample":{"value":{"data":[{"type":"client_secret","id":"6e5f4d3c-2b1a-0987-6543-210fedcba987","display_name":null,"client_id":"12345678-abcd-efgh-ijkl-mnopqrstuvwx","created_at":"2024-01-15T10:30:00.000Z"}],"meta":{"page":{"number":1,"size":10,"total":1}}}},"ApiKeyCredentialCreationResponseExample":{"value":{"type":"api_key","id":"5f9fd312-a987-4628-b4c5-bb4f4fddd5f7","display_name":"My API Key","credential":"sk_live_abc123def456","status":"active","expires_at":null,"created_at":"2025-01-01T00:00:00.000Z"}},"AzureClientSecretCredentialCreationResponseExample":{"value":{"type":"client_secret","id":"6e5f4d3c-2b1a-0987-6543-210fedcba987","display_name":null,"client_id":"12345678-abcd-efgh-ijkl-mnopqrstuvwx","client_secret":"azR~8Q~abcdefghijklmnopqrstuvwxyz123456","created_at":"2024-01-15T10:30:00.000Z"}},"PostCredentials403Example":{"value":{"status":403,"title":"Forbidden","detail":"Maximum number of Credentials exceeded. Max Allowed: 20","instance":"kong:trace:2724154947768991355"}},"GetGrantedScopesProductVersion200Response":{"value":{"scopes":["openid"]}},"GetGrantedScopesProductVersion422Example":{"value":{"status":422,"title":"Unsupported IDP","type":"https://kongapi.info/konnect/portal/granted-scopes-unavailable","detail":"This feature is not supported by the application.","instance":"kong:trace:2724154947768991354"}}},"requestBodies":{"CreateApplication":{"description":"Create an application","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateApplicationPayload"}}}},"UpdateApplication":{"description":"Update an application","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateApplicationPayload"}}}},"CreateCredential":{"description":"Create a credential","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCredentialRequest"}}}},"UpdateCredential":{"description":"Update a credential","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCredentialRequest"}}}}},"responses":{"ListApplications":{"description":"Get applications response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListApplicationsResponse"}}}},"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"}}}}},"ApplicationCreation":{"description":"Application Creation success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationCreationResponse"}}}},"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"}}}},"GetApplication":{"description":"Get application response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetApplicationResponse"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}},"ApplicationUpdate":{"description":"Application Update success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationUpdateResponse"}}}},"RefreshToken":{"description":"Refresh token response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefreshTokenResponse"}}}},"ListCredentials":{"description":"List credentials response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCredentialsResponse"},"examples":{"ListApiKeyCredentials":{"$ref":"#/components/examples/ListApiKeyCredentialsExample"},"ListClientSecretCredentials":{"$ref":"#/components/examples/ListClientSecretCredentialsExample"}}}}},"CredentialCreation":{"description":"Credential Creation success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CredentialCreationResponse"},"examples":{"ApiKeyCredentialCreationResponse":{"$ref":"#/components/examples/ApiKeyCredentialCreationResponseExample"},"ClientSecretCredentialCreationResponse":{"$ref":"#/components/examples/AzureClientSecretCredentialCreationResponseExample"}}}}},"PostCredentials403Response":{"description":"Error returned when the number of credentials exceed the quota.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"},"examples":{"PostCredentials403Example":{"$ref":"#/components/examples/PostCredentials403Example"}}}}},"GetGrantedScopesProductVersion":{"description":"Get granted scopes response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetGrantedScopesProductVersionResponse"},"examples":{"GetGrantedScopesProductVersion200Response":{"$ref":"#/components/examples/GetGrantedScopesProductVersion200Response"}}}}},"GetGrantedScopesProductVersion422Response":{"description":"Get granted with application using unsupported IDP.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/UnprocessableContentError"},"examples":{"GetGrantedScopesProductVersion422Example":{"$ref":"#/components/examples/GetGrantedScopesProductVersion422Example"}}}}},"ListAuthStrategies":{"description":"List auth strategies response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAuthStrategiesResponse"}}}}},"securitySchemes":{"portalAccessToken":{"type":"apiKey","in":"cookie","name":"portalaccesstoken","description":"The Developer portal cookie is meant to be used by the Developer API to authenticate with.\n"}}},"tags":[{"name":"applications","description":"The API for Konnect Portal developer applications within a private portal (i.e. requires registration/authentication). When a portal is in `public` mode, all of the described endpoints will return a 404 error. A public portal means that applications and registrations are not available/needed. In this API's context, \"you\" and \"your\" refers to the developer consuming the API."},{"name":"credentials","description":"The API for Konnect Portal developer credentials within a private portal (i.e. requires registration/authentication)."}],"x-errors":{"granted-scopes-unavailable":{"description":"The IDP used does not support granted scopes.\n","resolution":"Switch to an IDP that allows you to grant specific scopes.\n"}}}
```
