API docs by Redocly

Konnect Sliver DCR POC (0.0.1)

Download OpenAPI specification:Download

dcrmanagement

Auth server Dynamic Client Registration management API

List all clients the auth server

List all clients for the auth server

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
{
  • "data": [
    ],
  • "meta": {
    }
}

Create a new client in the auth server

Create a new client in the auth server

Authorizations:
systemAccountAccessTokenpersonalAccessTokenkonnectAccessToken
Request Body schema: application/json

Client to be created

client_name
required
string

name of the client

application_type
required
string (ApplicationType)
Value: "machine"

Type of the application

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

Array of OAuth 2.0 grant type strings.

token_endpoint_auth_method
required
string (TokenEndpointAuthMethod)
Enum: "client_secret_basic" "client_secret_jwt" "client_secret_post" "none"

Requested authentication method for OAuth 2.0 endpoints.

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

Array of redirection URI strings for use in redirect-based flows

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
{
  • "client_name": "kYa9iQFU5xPDSIUH9z1z",
  • "application_type": "machine",
  • "grant_types": [
    ],
  • "token_endpoint_auth_method": "client_secret_basic",
  • "response_types": [
    ],
  • "redirect_uris": []
}

Response samples

Content type
application/json
{
  • "client_id": "kYa9iQFU5xPDSIUH9z1z",
  • "client_name": "Client 1",
  • "client_id_issued_at": 1742314963,
  • "client_secret": "$€cr€T",
  • "client_secret_expires_at": 0,
  • "application_type": "machine",
  • "grant_types": [
    ],
  • "token_endpoint_auth_method": "client_secret_basic",
  • "response_types": [
    ],
  • "labels": {
    },
  • "redirect_uris": []
}

Get a client for given auth server

Get a client for given auth server

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

The OAuth 2.0 client ID

Responses

Response samples

Content type
application/json
{
  • "client_id": "kYa9iQFU5xPDSIUH9z1z",
  • "client_name": "Client 1",
  • "client_id_issued_at": 1742314963,
  • "client_secret": "$€cr€T",
  • "client_secret_expires_at": 0,
  • "application_type": "machine",
  • "grant_types": [
    ],
  • "token_endpoint_auth_method": "client_secret_basic",
  • "response_types": [
    ],
  • "labels": {
    },
  • "redirect_uris": []
}

Replace a client

Replace a client

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

The OAuth 2.0 client ID

Request Body schema: application/json

Client to be created

client_name
required
string

name of the client

application_type
required
string (ApplicationType)
Value: "machine"

Type of the application

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

Array of OAuth 2.0 grant type strings.

token_endpoint_auth_method
required
string (TokenEndpointAuthMethod)
Enum: "client_secret_basic" "client_secret_jwt" "client_secret_post" "none"

Requested authentication method for OAuth 2.0 endpoints.

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

Array of redirection URI strings for use in redirect-based flows

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
{
  • "client_name": "kYa9iQFU5xPDSIUH9z1z",
  • "application_type": "machine",
  • "grant_types": [
    ],
  • "token_endpoint_auth_method": "client_secret_basic",
  • "response_types": [
    ],
  • "redirect_uris": []
}

Response samples

Content type
application/json
{
  • "client_id": "kYa9iQFU5xPDSIUH9z1z",
  • "client_name": "Client 1",
  • "client_id_issued_at": 1742314963,
  • "client_secret": "$€cr€T",
  • "client_secret_expires_at": 0,
  • "application_type": "machine",
  • "grant_types": [
    ],
  • "token_endpoint_auth_method": "client_secret_basic",
  • "response_types": [
    ],
  • "labels": {
    },
  • "redirect_uris": []
}

Delete a client for a given auth server

Delete a client for a given auth server

Authorizations:
systemAccountAccessTokenpersonalAccessTokenkonnectAccessToken
path Parameters
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"
}

Refresh the secret of a client

Refresh the secret of a client

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

The OAuth 2.0 client ID

Responses

Response samples

Content type
application/json
{
  • "client_id": "kYa9iQFU5xPDSIUH9z1z",
  • "client_name": "Client 1",
  • "client_id_issued_at": 1742314963,
  • "client_secret": "$€cr€T",
  • "client_secret_expires_at": 0,
  • "application_type": "machine",
  • "grant_types": [
    ],
  • "token_endpoint_auth_method": "client_secret_basic",
  • "response_types": [
    ],
  • "labels": {
    },
  • "redirect_uris": []
}