---
title: "Konnect Sliver"
url: "https://nov18-dev.movespot.fyi/apis/konnect-sliver-dev-1/versions/12e1e75c-efaa-4e15-bec3-ed9d424d70c5"
---

# Konnect Sliver

OpenAPI specification document.

```json
{"openapi":"3.0.3","info":{"title":"Konnect Sliver","version":"1.0.0"},"servers":[{"url":"https://us.api.konghq.com/v1","description":"United-States Production region"},{"url":"https://eu.api.konghq.com/v1","description":"Europe Production region"},{"url":"https://au.api.konghq.com/v1","description":"Australia Production region"},{"url":"https://me.api.konghq.com/v1","description":"Middle-East Production region"},{"url":"https://in.api.konghq.com/v1","description":"India Production region"},{"url":"https://sg.api.konghq.com/v1","description":"Singapore Production region"}],"paths":{"/auth-servers":{"get":{"operationId":"listAuthServers","summary":"List all auth servers","description":"List all available auth servers.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"name":"sort","in":"query","description":"Sorts a collection of auth servers. Supported sort attributes are:\n- created_at\n- updated_at\n- name\n- audience\n","required":false,"schema":{"$ref":"#/components/schemas/SortQuery"}},{"name":"filter","in":"query","description":"Filter auth servers returned in the response.","required":false,"schema":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/LegacyStringFieldFilter"},"description":{"$ref":"#/components/schemas/LegacyStringFieldFilter"},"audience":{"$ref":"#/components/schemas/LegacyStringFieldFilter"},"id":{"$ref":"#/components/schemas/StringFieldEqualsFilter"},"labels":{"$ref":"#/components/schemas/StringFieldEqualsFilter"}}},"style":"deepObject"}],"responses":{"200":{"$ref":"#/components/responses/AuthServerList"}},"tags":["Auth Server"]},"post":{"operationId":"createAuthServer","summary":"Create a new auth server","description":"Create a new auth server. Each auth server has a unique, randomly generated, public issuer URL.","requestBody":{"$ref":"#/components/requestBodies/CreateAuthServer"},"responses":{"201":{"$ref":"#/components/responses/AuthServer"},"400":{"$ref":"#/components/responses/BadRequest"},"409":{"$ref":"#/components/responses/Conflict"}},"tags":["Auth Server"]}},"/auth-servers/_computed":{"get":{"operationId":"listAuthServersComputed","summary":"List auth servers with computed attributes","description":"List all the auth servers with computed attributes.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"name":"sort","in":"query","description":"Sorts a collection of auth servers. Supported sort attributes are:\n- created_at\n- updated_at\n- name\n- audience\n","required":false,"schema":{"$ref":"#/components/schemas/SortQuery"}},{"name":"filter","in":"query","description":"Filter auth servers returned in the response.","required":false,"schema":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/LegacyStringFieldFilter"},"description":{"$ref":"#/components/schemas/LegacyStringFieldFilter"},"audience":{"$ref":"#/components/schemas/LegacyStringFieldFilter"},"id":{"$ref":"#/components/schemas/StringFieldEqualsFilter"},"labels":{"$ref":"#/components/schemas/StringFieldEqualsFilter"}}},"style":"deepObject"}],"responses":{"200":{"$ref":"#/components/responses/AuthServerComputedList"}},"tags":["Auth Server"]}},"/auth-servers/{authServerId}":{"parameters":[{"$ref":"#/components/parameters/authServerId"}],"get":{"operationId":"getAuthServer","summary":"Get an auth server","description":"Get an auth server.","responses":{"200":{"$ref":"#/components/responses/AuthServer"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Auth Server"]},"patch":{"operationId":"updateAuthServer","summary":"Update an auth server","description":"Update an auth server.","requestBody":{"$ref":"#/components/requestBodies/UpdateAuthServer"},"responses":{"200":{"$ref":"#/components/responses/AuthServer"},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}},"tags":["Auth Server"]}},"/auth-servers/{authServerId}/clients":{"parameters":[{"$ref":"#/components/parameters/authServerId"}],"get":{"operationId":"listAuthServerClients","summary":"List all auth server clients","description":"List all the clients for a given auth server.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"name":"sort","in":"query","description":"Sorts a collection of clients. Supported sort attributes are:\n- created_at\n- updated_at\n- name\n","required":false,"schema":{"$ref":"#/components/schemas/SortQuery"}},{"name":"filter","in":"query","description":"Filter clients returned in the response.","required":false,"schema":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/LegacyStringFieldFilter"},"id":{"$ref":"#/components/schemas/StringFieldEqualsFilter"},"labels":{"$ref":"#/components/schemas/StringFieldEqualsFilter"}}},"style":"deepObject"}],"responses":{"200":{"$ref":"#/components/responses/ClientList"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Auth Server Clients"]},"post":{"operationId":"createAuthServerClient","summary":"Create a new auth server client","description":"Create a new client for a given auth server. The client ID and secret will be generated automatically. The `name` attribute must be unique within the auth server. The `grant_types` and `response_types` attributes define the OAuth 2.0 and OpenID Connect capabilities of the client.","requestBody":{"$ref":"#/components/requestBodies/CreateClient"},"responses":{"201":{"$ref":"#/components/responses/CreatedClient"},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}},"tags":["Auth Server Clients"]}},"/auth-servers/{authServerId}/clients/{clientId}":{"parameters":[{"$ref":"#/components/parameters/authServerId"},{"$ref":"#/components/parameters/clientId"}],"get":{"operationId":"getAuthServerClient","summary":"Get an auth server client","description":"Get a client for given auth server.","responses":{"200":{"$ref":"#/components/responses/Client"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Auth Server Clients"]},"patch":{"operationId":"updateAuthServerClient","summary":"Update an auth server client","description":"Update a client for a given auth server.","requestBody":{"$ref":"#/components/requestBodies/UpdateClient"},"responses":{"200":{"$ref":"#/components/responses/Client"},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}},"tags":["Auth Server Clients"]},"put":{"operationId":"replaceAuthServerClient","summary":"Replace an auth server client","description":"Replace a client for a given auth server. The client ID and secret can be provided to update an existing client, or to create a client with the matching ID and secret.","requestBody":{"$ref":"#/components/requestBodies/ReplaceClient"},"responses":{"200":{"$ref":"#/components/responses/Client"},"201":{"$ref":"#/components/responses/Client"},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}},"tags":["Auth Server Clients"]}},"/auth-servers/{authServerId}/clients/{clientId}/secrets":{"parameters":[{"$ref":"#/components/parameters/authServerId"},{"$ref":"#/components/parameters/clientId"}],"get":{"operationId":"listClientSecrets","summary":"List all client secrets","description":"List all the client secrets for a given client.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"name":"sort","in":"query","description":"Sorts a collection of secrets. Supported sort attributes are:\n- created_at\n- updated_at\n","required":false,"schema":{"$ref":"#/components/schemas/SortQuery"}},{"name":"filter","in":"query","description":"Filter secrets returned in the response.","required":false,"schema":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/StringFieldEqualsFilter"},"enabled":{"$ref":"#/components/schemas/BooleanFieldFilter"}}},"style":"deepObject"}],"responses":{"200":{"$ref":"#/components/responses/ClientSecretList"}},"tags":["Auth Server Clients"]},"post":{"operationId":"createClientSecret","summary":"Create a new client secret","description":"Create a new client secret for a given client. Multiple secrets can be active simultaneously for a single client.","requestBody":{"$ref":"#/components/requestBodies/CreateSecretPayload"},"responses":{"201":{"$ref":"#/components/responses/ClientSecretBody"},"400":{"$ref":"#/components/responses/BadRequest"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Auth Server Clients"]}},"/auth-servers/{authServerId}/clients/{clientId}/secrets/{clientSecretId}":{"parameters":[{"$ref":"#/components/parameters/authServerId"},{"$ref":"#/components/parameters/clientId"},{"$ref":"#/components/parameters/clientSecretId"}],"get":{"operationId":"getClientSecret","summary":"Get a client secret","description":"Get a specific client secret for a given client.","responses":{"200":{"$ref":"#/components/responses/ClientSecretBody"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Auth Server Clients"]},"patch":{"operationId":"updateClientSecret","summary":"Update a client secret","description":"Update a client secret for a given client, such as enabling or disabling the secret.","requestBody":{"$ref":"#/components/requestBodies/UpdateSecretPayload"},"responses":{"201":{"$ref":"#/components/responses/ClientSecretBody"},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Auth Server Clients"]},"delete":{"operationId":"deleteClientSecret","summary":"Delete a client secret","description":"Delete a client secret for a given client. This action is irreversible.","responses":{"204":{"description":"Success"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Auth Server Clients"]}},"/auth-servers/{authServerId}/clients/{clientId}/refresh-secret":{"parameters":[{"$ref":"#/components/parameters/authServerId"},{"$ref":"#/components/parameters/clientId"}],"post":{"operationId":"refreshAuthServerClientSecret","summary":"Refresh an auth server client secret","description":"Regenerate the client secret for this auth server client. The previous secret is immediately invalidated, but existing tokens remain valid until they expire. To revoke existing tokens, use the delete tokens endpoint.\n","responses":{"200":{"$ref":"#/components/responses/RefreshedSecret"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}},"tags":["Auth Server Clients"]}},"/auth-servers/{authServerId}/clients/{clientId}/tokens":{"parameters":[{"$ref":"#/components/parameters/authServerId"},{"$ref":"#/components/parameters/clientId"}],"get":{"operationId":"listAuthServerClientTokens","summary":"List all auth server client tokens","description":"List all the tokens for a given client.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"name":"sort","in":"query","description":"Sorts a collection of tokens. Supported sort attributes are:\n- created_at\n- expires_at\n","required":false,"schema":{"$ref":"#/components/schemas/SortQuery"}},{"name":"filter","in":"query","description":"Filter tokens returned in the response.","required":false,"schema":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/StringFieldEqualsFilter"}}},"style":"deepObject"}],"responses":{"200":{"$ref":"#/components/responses/TokenList"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Auth Server Clients"]}},"/auth-servers/{authServerId}/clients/{clientId}/tokens/{tokenId}":{"parameters":[{"$ref":"#/components/parameters/authServerId"},{"$ref":"#/components/parameters/clientId"},{"$ref":"#/components/parameters/tokenId"}],"get":{"operationId":"getAuthServerClientToken","summary":"Get an auth server client token","description":"Get a token for given client and auth server.","responses":{"200":{"$ref":"#/components/responses/Token"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Auth Server Clients"]}}},"components":{"parameters":{"authServerId":{"schema":{"type":"string","format":"uuid","example":"d32d905a-ed33-46a3-a093-d8f536af9a8a"},"name":"authServerId","in":"path","required":true,"description":"The auth server ID"},"clientId":{"schema":{"$ref":"#/components/schemas/ClientId"},"name":"clientId","in":"path","required":true,"description":"The OAuth 2.0 client ID"},"clientSecretId":{"schema":{"type":"string","format":"uuid","example":"07d05309-45cc-4b37-92fb-1524846deec3"},"name":"clientSecretId","in":"path","required":true,"description":"The client secret ID"},"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}},"tokenId":{"schema":{"type":"string","format":"uuid","example":"2cec70a4-d197-495c-8f3e-c0a1199d1da4"},"name":"tokenId","in":"path","required":true,"description":"The token ID"}},"schemas":{"CreateSecretPayload":{"type":"object","properties":{"secret":{"$ref":"#/components/schemas/ClientSecret"},"enabled":{"$ref":"#/components/schemas/SecretEnabled"}}},"UpdateSecretPayload":{"type":"object","properties":{"enabled":{"$ref":"#/components/schemas/SecretEnabled"}}},"ClientSecretList":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ClientSecretItem"}},"meta":{"$ref":"#/components/schemas/PaginatedMeta"}},"required":["data","meta"]},"ClientSecretItem":{"description":"The client secret. The secret value is only returned when creating a new secret item.","type":"object","properties":{"id":{"description":"The ID of the client secret","type":"string","format":"uuid"},"enabled":{"$ref":"#/components/schemas/SecretEnabled"},"secret":{"$ref":"#/components/schemas/ClientSecret"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"required":["id","enabled","created_at","updated_at"]},"ResponseType":{"description":"OAuth 2.0 response type","type":"string","enum":["none","token","code","id_token"]},"ResponseTypes":{"description":"List of OAuth 2.0 response types","type":"array","items":{"$ref":"#/components/schemas/ResponseType"},"nullable":false},"GrantType":{"description":"OAuth 2.0 grant type","type":"string","enum":["authorization_code","implicit","client_credentials","refresh_token"]},"GrantTypes":{"description":"List of OAuth 2.0 grant types","type":"array","items":{"$ref":"#/components/schemas/GrantType"},"nullable":false,"uniqueItems":true},"RedirectURIs":{"description":"The URIs that the client is allowed to redirect to after authentication in interactive flows. All redirect URIs must be absolute URIs, be secure (HTTPS), and must not include a fragment component.","type":"array","items":{"type":"string","format":"uri"},"nullable":false},"LoginURI":{"description":"The URI of the login page where the user is redirected to authenticate in interactive flows. The login page must be secure (HTTPS).","type":"string","format":"uri","nullable":true},"UpdateTokenDuration":{"description":"The duration of the minted token is valid for, in seconds","type":"integer","maximum":2592000,"minimum":60},"TokenDuration":{"description":"The duration of the minted token is valid for, in seconds","type":"integer","default":300,"maximum":2592000,"minimum":60},"UpdateRefreshTokenDuration":{"description":"The duration of the minted refresh token is valid for, in seconds","type":"integer","maximum":157680000,"minimum":60},"RefreshTokenDuration":{"description":"The duration of the minted refresh token is valid for, in seconds","type":"integer","default":2592000,"maximum":157680000,"minimum":60},"UpdateClientAllowAllScopes":{"description":"Specifies whether the client is allowed to request all scopes","type":"boolean"},"ClientAllowAllScopes":{"description":"Specifies whether the client is allowed to request all scopes","type":"boolean","default":false},"ClientAllowScopes":{"description":"Specifies the scopes IDs that the client is allowed to request","type":"array","items":{"type":"string","format":"uuid"},"nullable":false,"uniqueItems":true},"ClientId":{"description":"The OAuth 2.0 client ID","type":"string","example":"kYa9iQFU5xPDSIUH9z1z","maxLength":36,"minLength":1,"pattern":"[-_\\w]+","readOnly":true},"AuthServerName":{"description":"The name of the auth server","type":"string","minLength":1},"AuthServerDescription":{"description":"The description of the auth server","type":"string"},"Audience":{"description":"The recipients that the tokens are intended for. This becomes the 'aud' claim in an access token","type":"string","minLength":1},"UpdateAlgorithm":{"description":"Algorithm used in the key signing process","type":"string","enum":["RS256","RS384","RS512","PS256","PS384","PS512"]},"Algorithm":{"description":"Algorithm used in the key signing process","type":"string","default":"RS256","enum":["RS256","RS384","RS512","PS256","PS384","PS512"]},"Issuer":{"description":"The complete URL for the custom authorization server. This becomes the 'iss' claim in an access token.","type":"string"},"TokenEndpointAuthMethod":{"description":"Requested authentication method for OAuth 2.0 endpoints.","type":"string","default":"client_secret_post","enum":["client_secret_post","none"]},"TrustedOrigins":{"description":"A list or trusted origins to apply the CORS header on for the auth server","type":"array","items":{"$ref":"#/components/schemas/TrustedOrigin"},"maxLength":16,"uniqueItems":true},"TrustedOrigin":{"description":"A trusted origin for the auth server","type":"string","format":"uri","example":"https://example.com"},"DcrDefaultAccessTokenDuration":{"description":"The default access token duration, in seconds, applied to DCR clients registered against this auth server","type":"integer","default":300,"maximum":2592000,"minimum":60},"UpdateDcrDefaultAccessTokenDuration":{"description":"The default access token duration, in seconds, applied to DCR clients registered against this auth server","type":"integer","maximum":2592000,"minimum":60},"AuthServer":{"type":"object","properties":{"id":{"description":"The ID of the auth server","type":"string","format":"uuid"},"name":{"$ref":"#/components/schemas/AuthServerName"},"description":{"$ref":"#/components/schemas/AuthServerDescription"},"audience":{"$ref":"#/components/schemas/Audience"},"signing_algorithm":{"$ref":"#/components/schemas/Algorithm"},"issuer":{"$ref":"#/components/schemas/Issuer"},"metadata_uri":{"description":"The URI of the metadata document for the auth server","type":"string","format":"uri"},"labels":{"$ref":"#/components/schemas/Labels"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"},"trusted_origins":{"$ref":"#/components/schemas/TrustedOrigins"},"dcr_default_access_token_duration":{"$ref":"#/components/schemas/DcrDefaultAccessTokenDuration"}},"required":["id","name","description","audience","signing_algorithm","issuer","metadata_uri","labels","created_at","updated_at"]},"AuthServerComputed":{"allOf":[{"$ref":"#/components/schemas/AuthServer"},{"type":"object","required":["clients_count","claims_count","scopes_count"],"properties":{"clients_count":{"description":"The number of clients registered with the auth server","type":"integer","example":1},"claims_count":{"description":"The number of claims registered with the auth server","type":"integer","example":1},"scopes_count":{"description":"The number of scopes registered with the auth server","type":"integer","example":1}}}]},"AuthServerList":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AuthServer"}},"meta":{"$ref":"#/components/schemas/PaginatedMeta"}},"required":["data","meta"]},"AuthServerComputedList":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AuthServerComputed"}},"meta":{"$ref":"#/components/schemas/PaginatedMeta"}},"required":["data","meta"]},"SecretEnabled":{"description":"Specifies whether the secret is enabled. If the secret is not enabled, it will not be usable during authentication phase.","type":"boolean","default":true},"ClientName":{"description":"The name of the client","type":"string","minLength":1},"Client":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ClientId"},"name":{"$ref":"#/components/schemas/ClientName"},"grant_types":{"$ref":"#/components/schemas/GrantTypes"},"redirect_uris":{"$ref":"#/components/schemas/RedirectURIs"},"login_uri":{"$ref":"#/components/schemas/LoginURI"},"access_token_duration":{"$ref":"#/components/schemas/TokenDuration"},"id_token_duration":{"$ref":"#/components/schemas/TokenDuration"},"refresh_token_duration":{"$ref":"#/components/schemas/RefreshTokenDuration"},"allow_all_scopes":{"$ref":"#/components/schemas/ClientAllowAllScopes"},"allow_scopes":{"$ref":"#/components/schemas/ClientAllowScopes"},"labels":{"$ref":"#/components/schemas/Labels"},"response_types":{"$ref":"#/components/schemas/ResponseTypes"},"token_endpoint_auth_method":{"$ref":"#/components/schemas/TokenEndpointAuthMethod"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"required":["id","name","grant_types","redirect_uris","allow_all_scopes","allow_scopes","access_token_duration","id_token_duration","refresh_token_duration","labels","response_types","created_at","updated_at"]},"CreatedClient":{"allOf":[{"$ref":"#/components/schemas/Client"},{"type":"object","required":["client_secret"],"properties":{"client_secret":{"description":"The OAuth 2.0 client secret","type":"string","example":"YAzsyUlNZ5gNGeKS9H3VAdxVPzhPo4ae"}}}]},"RefreshedSecret":{"description":"The result of a refreshed client secret.","properties":{"secret":{"$ref":"#/components/schemas/ClientSecret"}},"required":["secret"]},"ClientSecret":{"description":"The OAuth 2.0 client secret","type":"string","example":"YAzsyUlNZ5gNGeKS9H3VAdxVPzhPo4ae"},"ClientList":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Client"}},"meta":{"$ref":"#/components/schemas/PaginatedMeta"}},"required":["data","meta"]},"Token":{"type":"object","properties":{"id":{"description":"The ID of the token","type":"string","format":"uuid"},"granted_scope_names":{"description":"The scopes that the token has been granted","type":"array","items":{"type":"string"},"nullable":false},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"expires_at":{"description":"An ISO-8601 timestamp representation of the expiration date","type":"string","format":"date-time","example":"2022-11-04T20:10:06.927Z","readOnly":true},"type":{"$ref":"#/components/schemas/TokenType"}},"required":["id","granted_scope_names","created_at","expires_at","type"]},"TokenType":{"description":"The type of the token","type":"string","enum":["access_token","refresh_token"]},"TokenList":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Token"}},"meta":{"$ref":"#/components/schemas/PaginatedMeta"}},"required":["data","meta"]},"SortQuery":{"description":"The `asc` suffix is optional as the default sort order is ascending.\nThe `desc` suffix is used to specify a descending order.\nMultiple sort attributes may be provided via a comma separated list.\nJSONPath notation may be used to specify a sub-attribute (eg: 'foo.bar desc').\n","type":"string","example":"created_at desc","title":"SortQuery"},"StringFieldEqualsFilter":{"description":"Filters on the given string field value by exact match.","properties":{"eq":{"type":"string"}},"title":"StringFieldEqualsFilter","x-examples":{"example-1":"equals-some-value","example-2":{"eq":"some-value"}}},"LegacyStringFieldFilter":{"description":"Filter using **one** of the following operators: `eq`, `contains`","type":"object","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"}},"additionalProperties":false,"x-examples":{"example-1":{"contains":"some-value"},"example-2":{"eq":"some-value"}}},"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"}}}]},"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"}}}]},"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},"BooleanFieldFilter":{"description":"Filter by a boolean value (true/false).","type":"boolean","title":"BooleanFieldFilter","x-examples":{"example-1":true}},"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"}}}]}},"examples":{"ClientSecretList":{"value":{"data":[{"id":"f44567da-a0b1-4eef-86c9-b27ab2e22048","enabled":true,"created_at":"2023-03-20T09:29:14.52Z","updated_at":"2023-03-21T09:29:14.52Z"},{"id":"5e051473-3b98-45c9-aa99-75b18c158bbf","enabled":false,"created_at":"2023-03-19T09:29:14.52Z","updated_at":"2023-03-20T09:29:14.52Z"}],"meta":{"page":{"number":1,"size":2,"total":2}}}},"ClientSecretBody":{"value":{"id":"f44567da-a0b1-4eef-86c9-b27ab2e22048","enabled":true,"secret":"YAzsyUlNZ5gNGeKS9H3VAdxVPzhPo4ae","created_at":"2023-03-20T09:29:14.52Z","updated_at":"2023-03-21T09:29:14.52Z"}},"RefreshedSecret":{"value":{"secret":"1v2gg4MKa3iNZGh1OgwQ8k6ShH3cSiuu"}},"CreateAuthServer":{"value":{"name":"Auth Server","description":"Auth Server Description","audience":"api://default"}},"UpdateAuthServer":{"value":{"name":"Updated Auth Server","description":"Updated Auth Server Description","audience":"api://default"}},"AuthServerList":{"value":{"data":[{"id":"f44567da-a0b1-4eef-86c9-b27ab2e22048","name":"Auth Server 1","description":"Auth Server 1 Description","audience":"api://default","signing_algorithm":"RS256","issuer":"https://auth-server-1.com","metadata_uri":"https://auth-server-1.com/auth/.well-known/openid-configuration","labels":{"env":"production"},"created_at":"2023-03-20T09:29:14.52Z","updated_at":"2023-03-21T09:29:14.52Z"},{"id":"5e051473-3b98-45c9-aa99-75b18c158bbf","name":"Auth Server 2","description":"Auth Server 2 Description","audience":"api://default","signing_algorithm":"RS256","issuer":"https://auth-server-2.com","metadata_uri":"https://auth-server-2.com/auth/.well-known/openid-configuration","labels":{"env":"production"},"created_at":"2023-03-20T09:29:14.52Z","updated_at":"2023-03-21T09:29:14.52Z"}],"meta":{"page":{"number":1,"size":2,"total":2}}}},"AuthServerComputedList":{"value":{"data":[{"id":"f44567da-a0b1-4eef-86c9-b27ab2e22048","name":"Auth Server 1","description":"Auth Server 1 Description","audience":"api://default","signing_algorithm":"RS256","issuer":"https://auth-server-1.com","metadata_uri":"https://auth-server-1.com/auth/.well-known/openid-configuration","labels":{"env":"production"},"created_at":"2023-03-20T09:29:14.52Z","updated_at":"2023-03-21T09:29:14.52Z","clients_count":1,"claims_count":1,"scopes_count":1},{"id":"5e051473-3b98-45c9-aa99-75b18c158bbf","name":"Auth Server 2","description":"Auth Server 2 Description","audience":"api://default","signing_algorithm":"RS256","issuer":"https://auth-server-2.com","metadata_uri":"https://auth-server-2.com/auth/.well-known/openid-configuration","labels":{"env":"production"},"created_at":"2023-03-20T09:29:14.52Z","updated_at":"2023-03-21T09:29:14.52Z","clients_count":1,"claims_count":1,"scopes_count":1}],"meta":{"page":{"number":1,"size":2,"total":2}}}},"AuthServer":{"value":{"id":"f44567da-a0b1-4eef-86c9-b27ab2e22048","name":"Auth Server 1","description":"Auth Server 1 Description","audience":"api://default","signing_algorithm":"RS256","issuer":"https://auth-server-1.com","metadata_uri":"https://auth-server-1.com/auth/.well-known/openid-configuration","labels":{"env":"production"},"created_at":"2023-03-20T09:29:14.52Z","updated_at":"2023-03-21T09:29:14.52Z"}},"CreateClient":{"value":{"name":"Client","grant_types":["client_credentials"],"allow_all_scopes":false,"allow_scopes":["c5e12516-182c-4928-ae04-05374b3b1cca","b5525b78-f3a0-4bd6-befc-7696be58717e"],"redirect_uris":["https://client.com/callback"],"access_token_duration":3600,"id_token_duration":3600,"refresh_token_duration":2592000,"response_types":["token"],"token_endpoint_auth_method":"client_secret_post"}},"UpdateClient":{"value":{"name":"Updated Client"}},"ReplaceClient":{"value":{"name":"Replace Client","client_secret":"SecretPassword","grant_types":["client_credentials"],"response_types":["token"]}},"ClientList":{"value":{"data":[{"id":"kYa9iQFU5xPDSIUH9z1z","name":"Client 1","grant_types":["implicit"],"allow_all_scopes":false,"allow_scopes":["c5e12516-182c-4928-ae04-05374b3b1cca","b5525b78-f3a0-4bd6-befc-7696be58717e"],"redirect_uris":["https://client.com/callback"],"access_token_duration":3600,"id_token_duration":3600,"refresh_token_duration":2592000,"labels":{"env":"prod"},"response_types":["token"],"token_endpoint_auth_method":"client_secret_post","created_at":"2023-03-20T09:29:14.52Z","updated_at":"2023-03-21T09:29:14.52Z"},{"id":"kYa9iQFU5xPDSIUH9z1z","name":"Client 2","grant_types":["client_credentials"],"allow_all_scopes":true,"allow_scopes":[],"redirect_uris":[],"access_token_duration":3600,"id_token_duration":3600,"refresh_token_duration":2592000,"labels":{"env":"prod"},"response_types":["token"],"token_endpoint_auth_method":"none","created_at":"2023-03-20T09:29:14.52Z","updated_at":"2023-03-21T09:29:14.52Z"}],"meta":{"page":{"number":1,"size":2,"total":2}}}},"Client":{"value":{"id":"kYa9iQFU5xPDSIUH9z1z","name":"Client 1","grant_types":["client_credentials","implicit"],"allow_all_scopes":false,"allow_scopes":["c5e12516-182c-4928-ae04-05374b3b1cca","b5525b78-f3a0-4bd6-befc-7696be58717e"],"redirect_uris":["https://client.com/callback"],"access_token_duration":3600,"id_token_duration":3600,"refresh_token_duration":2592000,"labels":{"env":"prod"},"response_types":["token"],"token_endpoint_auth_method":"client_secret_post","created_at":"2023-03-20T09:29:14.52Z","updated_at":"2023-03-21T09:29:14.52Z"}},"CreatedClient":{"value":{"id":"kYa9iQFU5xPDSIUH9z1z","name":"Client 1","grant_types":["client_credentials"],"allow_all_scopes":false,"allow_scopes":["c5e12516-182c-4928-ae04-05374b3b1cca","b5525b78-f3a0-4bd6-befc-7696be58717e"],"redirect_uris":["https://client.com/callback"],"access_token_duration":3600,"id_token_duration":3600,"refresh_token_duration":2592000,"labels":{"env":"test"},"response_types":["token"],"token_endpoint_auth_method":"client_secret_post","created_at":"2023-03-20T09:29:14.52Z","updated_at":"2023-03-21T09:29:14.52Z","client_secret":"YAzsyUlNZ5gNGeKS9H3VAdxVPzhPo4ae"}},"TokenList":{"value":{"data":[{"id":"2cec70a4-d197-495c-8f3e-c0a1199d1da4","granted_scope_names":["openid","profile"],"created_at":"2023-03-20T09:29:14.52Z","expires_at":"2022-11-04T20:10:06.927Z","type":"access_token"},{"id":"8b3bd4a9-7bb3-4b4b-9447-728577bd75e2","granted_scope_names":["openid","profile"],"created_at":"2023-03-20T09:29:14.52Z","expires_at":"2022-11-04T20:10:06.927Z","type":"refresh_token"}],"meta":{"page":{"number":1,"size":2,"total":2}}}},"Token":{"value":{"id":"2cec70a4-d197-495c-8f3e-c0a1199d1da4","granted_scope_names":["openid","profile"],"created_at":"2023-03-20T09:29:14.52Z","expires_at":"2022-11-04T20:10:06.927Z","type":"access_token"}},"NotFoundExample":{"value":{"status":404,"title":"Not Found","instance":"kong:trace:6816496025408232265","detail":"Not Found"}},"ForbiddenExample":{"value":{"status":403,"title":"Forbidden","instance":"kong:trace:2723154947768991354","detail":"You do not have permission to perform this action"}}},"requestBodies":{"CreateSecretPayload":{"description":"Secret to be created","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSecretPayload"}}}},"UpdateSecretPayload":{"description":"Secret to be updated","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSecretPayload"}}}},"CreateAuthServer":{"description":"Auth server to be created","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/AuthServerName"},"description":{"$ref":"#/components/schemas/AuthServerDescription"},"audience":{"$ref":"#/components/schemas/Audience"},"signing_algorithm":{"$ref":"#/components/schemas/Algorithm"},"labels":{"$ref":"#/components/schemas/Labels"},"trusted_origins":{"$ref":"#/components/schemas/TrustedOrigins"},"dcr_default_access_token_duration":{"$ref":"#/components/schemas/DcrDefaultAccessTokenDuration"}},"required":["name","audience"]},"examples":{"AuthServer":{"$ref":"#/components/examples/CreateAuthServer"}}}}},"UpdateAuthServer":{"description":"Auth server to be updated","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/AuthServerName"},"description":{"$ref":"#/components/schemas/AuthServerDescription"},"audience":{"$ref":"#/components/schemas/Audience"},"signing_algorithm":{"$ref":"#/components/schemas/UpdateAlgorithm"},"labels":{"$ref":"#/components/schemas/LabelsUpdate"},"trusted_origins":{"$ref":"#/components/schemas/TrustedOrigins"},"dcr_default_access_token_duration":{"$ref":"#/components/schemas/UpdateDcrDefaultAccessTokenDuration"}}},"examples":{"AuthServer":{"$ref":"#/components/examples/UpdateAuthServer"}}}}},"CreateClient":{"description":"Client to be created","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/ClientName"},"grant_types":{"$ref":"#/components/schemas/GrantTypes"},"response_types":{"$ref":"#/components/schemas/ResponseTypes"},"redirect_uris":{"$ref":"#/components/schemas/RedirectURIs"},"login_uri":{"$ref":"#/components/schemas/LoginURI"},"access_token_duration":{"$ref":"#/components/schemas/TokenDuration"},"id_token_duration":{"$ref":"#/components/schemas/TokenDuration"},"refresh_token_duration":{"$ref":"#/components/schemas/RefreshTokenDuration"},"allow_all_scopes":{"$ref":"#/components/schemas/ClientAllowAllScopes"},"allow_scopes":{"$ref":"#/components/schemas/ClientAllowScopes"},"labels":{"$ref":"#/components/schemas/Labels"},"token_endpoint_auth_method":{"$ref":"#/components/schemas/TokenEndpointAuthMethod"}},"required":["name","grant_types","response_types"]},"examples":{"Client":{"$ref":"#/components/examples/CreateClient"}}}}},"UpdateClient":{"description":"Client to be updated","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/ClientName"},"client_secret":{"description":"Secret of the client","type":"string","minLength":1},"grant_types":{"$ref":"#/components/schemas/GrantTypes"},"response_types":{"$ref":"#/components/schemas/ResponseTypes"},"redirect_uris":{"$ref":"#/components/schemas/RedirectURIs"},"login_uri":{"$ref":"#/components/schemas/LoginURI"},"access_token_duration":{"$ref":"#/components/schemas/UpdateTokenDuration"},"id_token_duration":{"$ref":"#/components/schemas/UpdateTokenDuration"},"refresh_token_duration":{"$ref":"#/components/schemas/UpdateRefreshTokenDuration"},"allow_all_scopes":{"$ref":"#/components/schemas/UpdateClientAllowAllScopes"},"allow_scopes":{"$ref":"#/components/schemas/ClientAllowScopes"},"token_endpoint_auth_method":{"$ref":"#/components/schemas/TokenEndpointAuthMethod"},"labels":{"$ref":"#/components/schemas/LabelsUpdate"}}},"examples":{"Client":{"$ref":"#/components/examples/UpdateClient"}}}}},"ReplaceClient":{"description":"Client to be replaced","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/ClientName"},"client_secret":{"description":"Secret of the client","type":"string","minLength":1},"grant_types":{"$ref":"#/components/schemas/GrantTypes"},"response_types":{"$ref":"#/components/schemas/ResponseTypes"},"redirect_uris":{"$ref":"#/components/schemas/RedirectURIs"},"login_uri":{"$ref":"#/components/schemas/LoginURI"},"access_token_duration":{"$ref":"#/components/schemas/TokenDuration"},"id_token_duration":{"$ref":"#/components/schemas/TokenDuration"},"refresh_token_duration":{"$ref":"#/components/schemas/RefreshTokenDuration"},"allow_all_scopes":{"$ref":"#/components/schemas/ClientAllowAllScopes"},"allow_scopes":{"$ref":"#/components/schemas/ClientAllowScopes"},"token_endpoint_auth_method":{"$ref":"#/components/schemas/TokenEndpointAuthMethod"},"labels":{"$ref":"#/components/schemas/Labels"}},"required":["name","client_secret","grant_types","response_types"]},"examples":{"Client":{"$ref":"#/components/examples/ReplaceClient"}}}}}},"responses":{"ClientSecretList":{"description":"List of client Secrets","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientSecretList"},"examples":{"ClientSecretList":{"$ref":"#/components/examples/ClientSecretList"}}}}},"ClientSecretBody":{"description":"A Client Secret item","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientSecretItem"},"examples":{"ClientSecretBody":{"$ref":"#/components/examples/ClientSecretBody"}}}}},"RefreshedSecret":{"description":"Result of a refreshed secret","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefreshedSecret"},"examples":{"RefreshedSecret":{"$ref":"#/components/examples/RefreshedSecret"}}}}},"AuthServer":{"description":"An auth server","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthServer"},"examples":{"AuthServer":{"$ref":"#/components/examples/AuthServer"}}}}},"AuthServerList":{"description":"List of auth servers","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthServerList"},"examples":{"AuthServerList":{"$ref":"#/components/examples/AuthServerList"}}}}},"AuthServerComputedList":{"description":"List of auth servers with computed fields","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthServerComputedList"},"examples":{"AuthServerListComputed":{"$ref":"#/components/examples/AuthServerComputedList"}}}}},"Client":{"description":"A client","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Client"},"examples":{"Client":{"$ref":"#/components/examples/Client"}}}}},"ClientList":{"description":"List of clients","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientList"},"examples":{"ClientList":{"$ref":"#/components/examples/ClientList"}}}}},"CreatedClient":{"description":"A client with a secret","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatedClient"},"examples":{"CreatedClient":{"$ref":"#/components/examples/CreatedClient"}}}}},"Token":{"description":"A token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Token"},"examples":{"Token":{"$ref":"#/components/examples/Token"}}}}},"TokenList":{"description":"List of tokens","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenList"},"examples":{"TokenList":{"$ref":"#/components/examples/TokenList"}}}}},"BadRequest":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"Conflict":{"description":"Conflict","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConflictError"}}}},"NotFound":{"description":"Not Found","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/NotFoundError"},"examples":{"NotFoundExample":{"$ref":"#/components/examples/NotFoundExample"}}}}},"Forbidden":{"description":"Forbidden","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"},"examples":{"UnauthorizedExample":{"$ref":"#/components/examples/ForbiddenExample"}}}}}},"securitySchemes":{"systemAccountAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"Token","description":"The system account access token is meant for automations and integrations that are not directly associated with a human identity.\nYou can generate a system account Access Token by creating a system account and then obtaining a system account access token for that account.\nThe access token must be passed in the header of a request, for example:\n`curl -X GET 'https://global.api.konghq.com/v2/users/' --header 'Authorization: Bearer spat_i2Ej...'`\n"},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"Token","description":"The personal access token is meant to be used as an alternative to basic-auth when accessing Konnect via APIs.\nYou can generate a Personal Access Token (PAT) from the [personal access token page](https://cloud.konghq.com/global/account/tokens/) in the Konnect dashboard.\nThe PAT token must be passed in the header of a request, for example:\n`curl -X GET 'https://global.api.konghq.com/v2/users/' --header 'Authorization: Bearer kpat_xgfT...'`\n"},"konnectAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The Konnect access token is meant to be used by the Konnect dashboard and the decK CLI authenticate with.\n"}}},"tags":[{"name":"Auth Server","description":"Auth Servers expose an OAuth 2.0 and OpenID Connect server interface for generating access tokens. The management API will give you the ability to create, configure and manage multiple Auth Servers per Konnect organization. Auth Servers are a regional Konnect entity."},{"name":"Auth Server Clients","description":"Clients represent the identity of machines, such as microservices, mobile apps, or scripts entity. The management API will give you the ability to create, configure and manage multiple Clients per Auth Server."}],"security":[{"systemAccountAccessToken":[]},{"personalAccessToken":[]},{"konnectAccessToken":[]}]}
```
