API docs by Redocly

Konnect Sliver POC (0.0.1)

Download OpenAPI specification:Download

authserver

Auth server management API

List all auth servers

List all auth servers

Authorizations:
systemAccountAccessTokenpersonalAccessTokenkonnectAccessToken
query Parameters
page[size]
integer
Example: page[size]=10

The maximum number of items to include per page. The last page of a collection may include fewer items.

page[number]
integer
Example: page[number]=1

Determines which page of the entities to retrieve.

Responses

Response samples

Content type
application/json
{}

Create a new auth server

Create a new auth server

Authorizations:
systemAccountAccessTokenpersonalAccessTokenkonnectAccessToken
Request Body schema: application/json

Auth server to be created

name
required
string (AuthServerName)

The name of the auth server.

description
string (AuthServerDescription)

The description of the auth server.

audience
required
string (Audience)

The recipients that the tokens are intended for. This becomes the 'aud' claim in an access token.

object (Labels) <= 50 properties

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

Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".

Responses

Request samples

Content type
application/json
{
  • "name": "Auth Server",
  • "description": "Auth Server Description",
  • "audience": "api://default"
}

Response samples

Content type
application/json
{}

Get an auth server

Get an auth server

Authorizations:
systemAccountAccessTokenpersonalAccessTokenkonnectAccessToken
path Parameters
authServerId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

The auth server ID

Responses

Response samples

Content type
application/json
{}

Update an auth server

Update an auth server

Authorizations:
systemAccountAccessTokenpersonalAccessTokenkonnectAccessToken
path Parameters
authServerId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

The auth server ID

Request Body schema: application/json

Auth server to be updated

name
string (AuthServerName)

The name of the auth server.

description
string (AuthServerDescription)

The description of the auth server.

audience
string (Audience)

The recipients that the tokens are intended for. This becomes the 'aud' claim in an access token.

object or null (LabelsUpdate) <= 50 properties

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

Labels are intended to store INTERNAL metadata.

Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".

Responses

Request samples

Content type
application/json
{
  • "name": "Updated Auth Server",
  • "description": "Updated Auth Server Description",
  • "audience": "api://default"
}

Response samples

Content type
application/json
{}

Delete an auth server

Delete an auth server

Authorizations:
systemAccountAccessTokenpersonalAccessTokenkonnectAccessToken
path Parameters
authServerId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

The auth server ID

Responses

Response samples

Content type
application/problem+json
{
  • "status": 404,
  • "title": "Not Found",
  • "instance": "kong:trace:6816496025408232265",
  • "detail": "Not Found"
}

List all auth server claims

List all the claims for a given auth server

Authorizations:
systemAccountAccessTokenpersonalAccessTokenkonnectAccessToken
path Parameters
authServerId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

The auth server ID

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Create a new auth server claim

Create a new claim for a given auth server

Authorizations:
systemAccountAccessTokenpersonalAccessTokenkonnectAccessToken
path Parameters
authServerId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

The auth server ID

Request Body schema: application/json

Claim to be created

name
required
string (ClaimName)

The name of the claim.

value
required
string (ClaimValue)

Specifies the value of the claim.

include_in_token
boolean (ClaimIncludeInToken)
Default: false

Specifies whether to include claim in the token. If the value is set to 'false' for a claim, the client instead uses the access token to get claims from the '/userinfo' endpoint.

include_in_all_scopes
boolean (ClaimIncludeInAllScopes)
Default: false

Specifies whether to include the claim in all scopes. If the value is set to 'false' for a claim, the claim is only included in the scopes that explicitly list it.

include_in_scopes
Array of strings (ClaimIncludeInScopes)

Specifies the scopes in which the claim is included.

enabled
boolean (ClaimEnabled)
Default: true

Specifies whether the claim is enabled.

Responses

Request samples

Content type
application/json
{
  • "name": "Claim",
  • "value": "Claim Value",
  • "include_in_token": true,
  • "include_in_all_scopes": false,
  • "include_in_scopes": [
    ],
  • "enabled": true
}

Response samples

Content type
application/json
{
  • "id": "07d05309-45cc-4b37-92fb-1524846deec3",
  • "name": "Claim 1",
  • "value": "Claim 1 Value",
  • "include_in_token": true,
  • "include_in_all_scopes": false,
  • "include_in_scopes": [
    ],
  • "enabled": true,
  • "created_at": "2023-03-20T09:29:14.52Z",
  • "updated_at": "2023-03-21T09:29:14.52Z"
}

Get an auth server claim

Get a claim for given auth server

Authorizations:
systemAccountAccessTokenpersonalAccessTokenkonnectAccessToken
path Parameters
authServerId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

The auth server ID

claimId
required
string <uuid>
Example: 07d05309-45cc-4b37-92fb-1524846deec3

The claim ID

Responses

Response samples

Content type
application/json
{
  • "id": "07d05309-45cc-4b37-92fb-1524846deec3",
  • "name": "Claim 1",
  • "value": "Claim 1 Value",
  • "include_in_token": true,
  • "include_in_all_scopes": false,
  • "include_in_scopes": [
    ],
  • "enabled": true,
  • "created_at": "2023-03-20T09:29:14.52Z",
  • "updated_at": "2023-03-21T09:29:14.52Z"
}

Update an auth server claim

Update a claim for a given auth server

Authorizations:
systemAccountAccessTokenpersonalAccessTokenkonnectAccessToken
path Parameters
authServerId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

The auth server ID

claimId
required
string <uuid>
Example: 07d05309-45cc-4b37-92fb-1524846deec3

The claim ID

Request Body schema: application/json

Claim to be updated

name
string (ClaimName)

The name of the claim.

value
string (ClaimValue)

Specifies the value of the claim.

include_in_token
boolean (ClaimIncludeInToken)
Default: false

Specifies whether to include claim in the token. If the value is set to 'false' for a claim, the client instead uses the access token to get claims from the '/userinfo' endpoint.

include_in_all_scopes
boolean (ClaimIncludeInAllScopes)
Default: false

Specifies whether to include the claim in all scopes. If the value is set to 'false' for a claim, the claim is only included in the scopes that explicitly list it.

include_in_scopes
Array of strings (ClaimIncludeInScopes)

Specifies the scopes in which the claim is included.

enabled
boolean (ClaimEnabled)
Default: true

Specifies whether the claim is enabled.

Responses

Request samples

Content type
application/json
{
  • "name": "Updated Claim",
  • "value": "Updated Claim Value",
  • "include_in_token": true,
  • "include_in_all_scopes": true,
  • "include_in_scopes": [
    ],
  • "enabled": false
}

Response samples

Content type
application/json
{
  • "id": "07d05309-45cc-4b37-92fb-1524846deec3",
  • "name": "Claim 1",
  • "value": "Claim 1 Value",
  • "include_in_token": true,
  • "include_in_all_scopes": false,
  • "include_in_scopes": [
    ],
  • "enabled": true,
  • "created_at": "2023-03-20T09:29:14.52Z",
  • "updated_at": "2023-03-21T09:29:14.52Z"
}

Delete an auth server claim

Delete a claim for a given auth server

Authorizations:
systemAccountAccessTokenpersonalAccessTokenkonnectAccessToken
path Parameters
authServerId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

The auth server ID

claimId
required
string <uuid>
Example: 07d05309-45cc-4b37-92fb-1524846deec3

The claim ID

Responses

Response samples

Content type
application/problem+json
{
  • "status": 404,
  • "title": "Not Found",
  • "instance": "kong:trace:6816496025408232265",
  • "detail": "Not Found"
}

List all auth server scopes

List all the scopes for a given auth server

Authorizations:
systemAccountAccessTokenpersonalAccessTokenkonnectAccessToken
path Parameters
authServerId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

The auth server ID

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Create a new auth server scope

Create a new scope for a given auth server

Authorizations:
systemAccountAccessTokenpersonalAccessTokenkonnectAccessToken
path Parameters
authServerId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

The auth server ID

Request Body schema: application/json

Scope to be created

name
required
string (ScopeName)

The name of the scope.

description
string (ScopeDescription)

Description of the scope.

default
boolean (ScopeDefault)
Default: false

Specifies whether the scope is a default scope.

include_in_metadata
boolean (ScopeIncludeInMetadata)
Default: false

Specifies whether to include the scope in the metadata document.

enabled
boolean (ScopeEnabled)
Default: true

Specifies whether the scope is enabled.

Responses

Request samples

Content type
application/json
{
  • "name": "Scope",
  • "description": "Scope Description",
  • "default": false,
  • "include_in_metadata": false,
  • "enabled": true
}

Response samples

Content type
application/json
{
  • "id": "c5e12516-182c-4928-ae04-05374b3b1cca",
  • "name": "Scope 1",
  • "description": "Scope 1 Description",
  • "default": false,
  • "include_in_metadata": false,
  • "enabled": true,
  • "created_at": "2023-03-20T09:29:14.52Z",
  • "updated_at": "2023-03-21T09:29:14.52Z"
}

Get an auth server scope

Get a scope for given auth server

Authorizations:
systemAccountAccessTokenpersonalAccessTokenkonnectAccessToken
path Parameters
authServerId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

The auth server ID

scopeId
required
string <uuid>
Example: c5e12516-182c-4928-ae04-05374b3b1cca

The scope ID

Responses

Response samples

Content type
application/json
{
  • "id": "c5e12516-182c-4928-ae04-05374b3b1cca",
  • "name": "Scope 1",
  • "description": "Scope 1 Description",
  • "default": false,
  • "include_in_metadata": false,
  • "enabled": true,
  • "created_at": "2023-03-20T09:29:14.52Z",
  • "updated_at": "2023-03-21T09:29:14.52Z"
}

Update an auth server scope

Update a scope for a given auth server

Authorizations:
systemAccountAccessTokenpersonalAccessTokenkonnectAccessToken
path Parameters
authServerId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

The auth server ID

scopeId
required
string <uuid>
Example: c5e12516-182c-4928-ae04-05374b3b1cca

The scope ID

Request Body schema: application/json

Scope to be updated

name
string (ScopeName)

The name of the scope.

description
string (ScopeDescription)

Description of the scope.

default
boolean (ScopeDefault)
Default: false

Specifies whether the scope is a default scope.

include_in_metadata
boolean (ScopeIncludeInMetadata)
Default: false

Specifies whether to include the scope in the metadata document.

enabled
boolean (ScopeEnabled)
Default: true

Specifies whether the scope is enabled.

Responses

Request samples

Content type
application/json
{
  • "name": "Updated Scope",
  • "description": "Updated Scope Description",
  • "default": true,
  • "include_in_metadata": true,
  • "enabled": false
}

Response samples

Content type
application/json
{
  • "id": "c5e12516-182c-4928-ae04-05374b3b1cca",
  • "name": "Scope 1",
  • "description": "Scope 1 Description",
  • "default": false,
  • "include_in_metadata": false,
  • "enabled": true,
  • "created_at": "2023-03-20T09:29:14.52Z",
  • "updated_at": "2023-03-21T09:29:14.52Z"
}

Delete an auth server scope

Delete a scope for a given auth server

Authorizations:
systemAccountAccessTokenpersonalAccessTokenkonnectAccessToken
path Parameters
authServerId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

The auth server ID

scopeId
required
string <uuid>
Example: c5e12516-182c-4928-ae04-05374b3b1cca

The scope ID

Responses

Response samples

Content type
application/problem+json
{
  • "status": 404,
  • "title": "Not Found",
  • "instance": "kong:trace:6816496025408232265",
  • "detail": "Not Found"
}

List all auth server clients

List all the clients for a given auth server

Authorizations:
systemAccountAccessTokenpersonalAccessTokenkonnectAccessToken
path Parameters
authServerId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

The auth server ID

query Parameters
page[size]
integer
Example: page[size]=10

The maximum number of items to include per page. The last page of a collection may include fewer items.

page[number]
integer
Example: page[number]=1

Determines which page of the entities to retrieve.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Create a new auth server client

Create a new client for a given auth server

Authorizations:
systemAccountAccessTokenpersonalAccessTokenkonnectAccessToken
path Parameters
authServerId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

The auth server ID

Request Body schema: application/json

Client to be created

name
required
string (ClientName)

The name of the client.

grant_types
required
Array of strings (GrantTypes) unique
Items Enum: "authorization_code" "implicit" "client_credentials"

Array of OAuth 2.0 grant type strings.

response_types
required
Array of strings (ResponseTypes)
Items Enum: "none" "token" "code" "id_token"

array of OAuth 2.0 reponse type string.

redirect_uris
Array of strings <uri> (RedirectURIs)

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.

login_uri
string or null <uri> (LoginURI)

The URI of the login page where the user is redirected to authenticate in interactive flows. The login page must be secure (HTTPS).

allow_all_scopes
boolean (ClientAllowAllScopes)
Default: false

Specifies whether the client is allowed to request all scopes.

allow_scopes
Array of strings (ClientAllowScopes)

Specifies the scopes that the client is allowed to request.

object (Labels) <= 50 properties

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

Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".

Responses

Request samples

Content type
application/json
{
  • "name": "Client",
  • "grant_types": [
    ],
  • "allow_all_scopes": false,
  • "allow_scopes": [
    ],
  • "redirect_uris": [],
  • "login_uri": "https://client.com/login",
  • "response_types": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "kYa9iQFU5xPDSIUH9z1z",
  • "name": "Client 1",
  • "grant_types": [
    ],
  • "allow_all_scopes": false,
  • "allow_scopes": [
    ],
  • "redirect_uris": [],
  • "login_uri": "https://client.com/login",
  • "labels": {
    },
  • "response_types": [
    ],
  • "created_at": "2023-03-20T09:29:14.52Z",
  • "updated_at": "2023-03-21T09:29:14.52Z",
  • "client_secret": "YAzsyUlNZ5gNGeKS9H3VAdxVPzhPo4ae"
}

Get an auth server client

Get a client for given auth server

Authorizations:
systemAccountAccessTokenpersonalAccessTokenkonnectAccessToken
path Parameters
authServerId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

The auth server ID

clientId
required
string (ClientId) [ 1 .. 36 ] characters [-_\w]+
Example: kYa9iQFU5xPDSIUH9z1z

The OAuth 2.0 client ID

Responses

Response samples

Content type
application/json
{
  • "id": "kYa9iQFU5xPDSIUH9z1z",
  • "name": "Client 1",
  • "grant_types": [
    ],
  • "allow_all_scopes": false,
  • "allow_scopes": [
    ],
  • "redirect_uris": [],
  • "login_uri": "https://client.com/login",
  • "labels": {
    },
  • "response_types": [
    ],
  • "created_at": "2023-03-20T09:29:14.52Z",
  • "updated_at": "2023-03-21T09:29:14.52Z"
}

Update an auth server client

Update a client for a given auth server

Authorizations:
systemAccountAccessTokenpersonalAccessTokenkonnectAccessToken
path Parameters
authServerId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

The auth server ID

clientId
required
string (ClientId) [ 1 .. 36 ] characters [-_\w]+
Example: kYa9iQFU5xPDSIUH9z1z

The OAuth 2.0 client ID

Request Body schema: application/json

Client to be updated

name
string (ClientName)

The name of the client.

client_secret
string non-empty

Secret of the client

grant_types
Array of strings (GrantTypes) unique
Items Enum: "authorization_code" "implicit" "client_credentials"

Array of OAuth 2.0 grant type strings.

response_types
Array of strings (ResponseTypes)
Items Enum: "none" "token" "code" "id_token"

array of OAuth 2.0 reponse type string.

redirect_uris
Array of strings <uri> (RedirectURIs)

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.

login_uri
string or null <uri> (LoginURI)

The URI of the login page where the user is redirected to authenticate in interactive flows. The login page must be secure (HTTPS).

allow_all_scopes
boolean (ClientAllowAllScopes)
Default: false

Specifies whether the client is allowed to request all scopes.

allow_scopes
Array of strings (ClientAllowScopes)

Specifies the scopes that the client is allowed to request.

object or null (LabelsUpdate) <= 50 properties

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

Labels are intended to store INTERNAL metadata.

Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".

Responses

Request samples

Content type
application/json
{
  • "name": "Updated Client"
}

Response samples

Content type
application/json
{
  • "id": "kYa9iQFU5xPDSIUH9z1z",
  • "name": "Client 1",
  • "grant_types": [
    ],
  • "allow_all_scopes": false,
  • "allow_scopes": [
    ],
  • "redirect_uris": [],
  • "login_uri": "https://client.com/login",
  • "labels": {
    },
  • "response_types": [
    ],
  • "created_at": "2023-03-20T09:29:14.52Z",
  • "updated_at": "2023-03-21T09:29:14.52Z"
}

Replace an auth server client

Replace a client for a given auth server

Authorizations:
systemAccountAccessTokenpersonalAccessTokenkonnectAccessToken
path Parameters
authServerId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

The auth server ID

clientId
required
string (ClientId) [ 1 .. 36 ] characters [-_\w]+
Example: kYa9iQFU5xPDSIUH9z1z

The OAuth 2.0 client ID

Request Body schema: application/json

Client to be replaced

name
required
string (ClientName)

The name of the client.

client_secret
required
string non-empty

Secret of the client

grant_types
required
Array of strings (GrantTypes) unique
Items Enum: "authorization_code" "implicit" "client_credentials"

Array of OAuth 2.0 grant type strings.

response_types
required
Array of strings (ResponseTypes)
Items Enum: "none" "token" "code" "id_token"

array of OAuth 2.0 reponse type string.

redirect_uris
Array of strings <uri> (RedirectURIs)

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.

login_uri
string or null <uri> (LoginURI)

The URI of the login page where the user is redirected to authenticate in interactive flows. The login page must be secure (HTTPS).

allow_all_scopes
boolean (ClientAllowAllScopes)
Default: false

Specifies whether the client is allowed to request all scopes.

allow_scopes
Array of strings (ClientAllowScopes)

Specifies the scopes that the client is allowed to request.

object (Labels) <= 50 properties

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

Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".

Responses

Request samples

Content type
application/json
{
  • "name": "Replace Client",
  • "client_secret": "SecretPassword",
  • "grant_types": [
    ],
  • "response_types": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "kYa9iQFU5xPDSIUH9z1z",
  • "name": "Client 1",
  • "grant_types": [
    ],
  • "allow_all_scopes": false,
  • "allow_scopes": [
    ],
  • "redirect_uris": [],
  • "login_uri": "https://client.com/login",
  • "labels": {
    },
  • "response_types": [
    ],
  • "created_at": "2023-03-20T09:29:14.52Z",
  • "updated_at": "2023-03-21T09:29:14.52Z"
}

Delete an auth server client

Delete a client for a given auth server

Authorizations:
systemAccountAccessTokenpersonalAccessTokenkonnectAccessToken
path Parameters
authServerId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

The auth server ID

clientId
required
string (ClientId) [ 1 .. 36 ] characters [-_\w]+
Example: kYa9iQFU5xPDSIUH9z1z

The OAuth 2.0 client ID

Responses

Response samples

Content type
application/problem+json
{
  • "status": 404,
  • "title": "Not Found",
  • "instance": "kong:trace:6816496025408232265",
  • "detail": "Not Found"
}

List all auth server client tokens

List all the tokens for a given client and auth server

Authorizations:
systemAccountAccessTokenpersonalAccessTokenkonnectAccessToken
path Parameters
authServerId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

The auth server ID

clientId
required
string (ClientId) [ 1 .. 36 ] characters [-_\w]+
Example: kYa9iQFU5xPDSIUH9z1z

The OAuth 2.0 client ID

query Parameters
page[size]
integer
Example: page[size]=10

The maximum number of items to include per page. The last page of a collection may include fewer items.

page[number]
integer
Example: page[number]=1

Determines which page of the entities to retrieve.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Delete all auth server client tokens

Revoke all tokens for a given client and auth server

Authorizations:
systemAccountAccessTokenpersonalAccessTokenkonnectAccessToken
path Parameters
authServerId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

The auth server ID

clientId
required
string (ClientId) [ 1 .. 36 ] characters [-_\w]+
Example: kYa9iQFU5xPDSIUH9z1z

The OAuth 2.0 client ID

Responses

Response samples

Content type
application/problem+json
{
  • "status": 404,
  • "title": "Not Found",
  • "instance": "kong:trace:6816496025408232265",
  • "detail": "Not Found"
}

Get an auth server client token

Get a token for given client and auth server

Authorizations:
systemAccountAccessTokenpersonalAccessTokenkonnectAccessToken
path Parameters
authServerId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

The auth server ID

clientId
required
string (ClientId) [ 1 .. 36 ] characters [-_\w]+
Example: kYa9iQFU5xPDSIUH9z1z

The OAuth 2.0 client ID

tokenId
required
string <uuid>
Example: 2cec70a4-d197-495c-8f3e-c0a1199d1da4

The token ID

Responses

Response samples

Content type
application/json
{
  • "id": "2cec70a4-d197-495c-8f3e-c0a1199d1da4",
  • "created_at": "2023-03-20T09:29:14.52Z",
  • "expires_at": "2022-11-04T20:10:06.927Z"
}

Delete an auth server client token

Revoke a token for a given client and auth server

Authorizations:
systemAccountAccessTokenpersonalAccessTokenkonnectAccessToken
path Parameters
authServerId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

The auth server ID

clientId
required
string (ClientId) [ 1 .. 36 ] characters [-_\w]+
Example: kYa9iQFU5xPDSIUH9z1z

The OAuth 2.0 client ID

tokenId
required
string <uuid>
Example: 2cec70a4-d197-495c-8f3e-c0a1199d1da4

The token ID

Responses

Response samples

Content type
application/problem+json
{
  • "status": 404,
  • "title": "Not Found",
  • "instance": "kong:trace:6816496025408232265",
  • "detail": "Not Found"
}