Get a User

Returns the user object for the user ID specified as a path parameter.

get
https://global.api.konghq.com/v3/users/{userId}

Path Parameters

userIdstring(uuid)required

The ID of the user being deleted.

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

Response

application/json

A get action response of a single user.

User

The user object contains information about an individual user who can use the Konnect application and API.

idstring(uuid)read-only

The User ID.

Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

emailstring(email)

The email registered to the user.

<= 250 characters

Example:user@email.com

full_namestring

The User’s full name.

Match pattern:^[\w \W]+$

<= 250 characters

Example:Jane Doe

preferred_namestring

The User’s preferred name.

<= 250 characters

Example:Jane

activebooleanread-only

Returns True if a user has verified their email address.

Default:true

inferred_regionstringread-only

The Konnect region closest to the user’s IP address. This property might only be set for users on signup through Konnect’s build-in native authentication.

Example:us

created_atstring(date-time)read-only

The time stamp for the date the account was registered.

Example:2022-02-07T17:46:57.52Z

updated_atstring(date-time)read-only

A Unix timestamp representation of the most recent change to the User account.

Example:2022-10-08T17:00:00.52Z

get/users/{userId}
 
application/json

Update User

Update an individual user.

patch
https://global.api.konghq.com/v3/users/{userId}

Path Parameters

userIdstring(uuid)required

The ID of the user being deleted.

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

Body

application/json

The request schema for the update user request.

full_namestring

The user’s full name.

Match pattern:^[\w \W]+$

<= 250 characters

Example:James C. Woods

preferred_namestring

The user’s desired name.

<= 250 characters

Example:Jimmy

Response

application/json

A get action response of a single user.

User

The user object contains information about an individual user who can use the Konnect application and API.

idstring(uuid)read-only

The User ID.

Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

emailstring(email)

The email registered to the user.

<= 250 characters

Example:user@email.com

full_namestring

The User’s full name.

Match pattern:^[\w \W]+$

<= 250 characters

Example:Jane Doe

preferred_namestring

The User’s preferred name.

<= 250 characters

Example:Jane

activebooleanread-only

Returns True if a user has verified their email address.

Default:true

inferred_regionstringread-only

The Konnect region closest to the user’s IP address. This property might only be set for users on signup through Konnect’s build-in native authentication.

Example:us

created_atstring(date-time)read-only

The time stamp for the date the account was registered.

Example:2022-02-07T17:46:57.52Z

updated_atstring(date-time)read-only

A Unix timestamp representation of the most recent change to the User account.

Example:2022-10-08T17:00:00.52Z

patch/users/{userId}

Body

{ "full_name": "James C Woods", "preferred_name": "Jimmy" }
 
application/json

Delete User

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

delete
https://global.api.konghq.com/v3/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/v3/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.

System Account Collection Response

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