Delete User

Deletes an individual user. Returns 404 if the requested user was not found.

delete
https://global.api.konghq.com/v2/users/{userId}

Path Parameters

userIdstring(uuid)required

The ID of the user being deleted.

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

Response

No Content

delete/users/{userId}
 

System Accounts

List System Accounts

Returns an array of system accounts (SA) in the organization. Returns 400 if any filter parameters are invalid.

get
https://global.api.konghq.com/v2/system-accounts

Query Parameters

page[size]integer

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

Example:10

page[number]integer

Determines which page of the entities to retrieve.

Example:1

filterobject

Filter system accounts returned in the response.

Show Child Parameters

Response

application/json

A paginated list response for a collection of system accounts.

metaobject

returns the pagination information

Show Child Parameters
dataarray[object]

Schema of the system account.

Example:{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","name":"Example System Account","description":"This is a sample system account description.","created_at":"2022-08-24T14:15:22Z","updated_at":"2022-10-05T10:33:49Z","konnect_managed":false}

Show Child Parameters
get/system-accounts
 
application/json

Create System Account

Creates a system account. Returns a 409 if a system account with the same name already exists.

post
https://global.api.konghq.com/v2/system-accounts

Body

application/json

The request schema to create a system account.

namestringrequired

Name of the system account.

descriptionstringrequired

Description of the system account. Useful when the system account name is not sufficient to differentiate one system account from another.

konnect_managedboolean

The system account is managed by Konnect (true/false).

Response

application/json

A response including a single system account.

System Account

Schema of the system account.

idstring(uuid)read-only

ID of the system account.

namestring

Name of the system account.

descriptionstring

Description of the system account.

created_atstring(date-time)read-only

Timestamp of when the system account was created.

updated_atstring(date-time)read-only

Timestamp of when the system account was last updated.

konnect_managedboolean

The system account is managed by Konnect (true/false).

post/system-accounts

Body

{ "name": "Sample System Account", "description": "This is a sample system account description.", "konnect_managed": false }
 
application/json

Get a System Account

Returns the system account (SA) for the SA ID specified as a path parameter.

get
https://global.api.konghq.com/v2/system-accounts/{accountId}

Path Parameters

accountIdstringrequired

ID of the system account.

Response

application/json

A response including a single system account.

System Account

Schema of the system account.

idstring(uuid)read-only

ID of the system account.

namestring

Name of the system account.

descriptionstring

Description of the system account.

created_atstring(date-time)read-only

Timestamp of when the system account was created.

updated_atstring(date-time)read-only

Timestamp of when the system account was last updated.

konnect_managedboolean

The system account is managed by Konnect (true/false).

get/system-accounts/{accountId}
 
application/json