List Users (Internal)

The response contains user ids and (non-deleted, non-deleting) organization ids for users associated with provided auth0 user subject.

get
https://global.api.konghq.com/v3/internal/users

Query Parameters

aidstring

Auth0 User ID

Response

application/json

A get action paginated response of users and organization IDs.

metaobject

returns the pagination information

Show Child Parameters
dataarray[object]

User with Organization IDs only.

Show Child Parameters
get/internal/users
 
application/json

Me

Delete My User Account

Deletes the user account for the user identified in the token of the request.

delete
https://global.api.konghq.com/v3/users/me

Response

No Content

delete/users/me
 

Update My User Account

Updates the user account for the user identified in the token of the request.

patch
https://global.api.konghq.com/v3/users/me

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/me

Body

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

Get My Permissions

Returns the permissions for the current user

get
https://global.api.konghq.com/v3/users/me/permissions

Query Parameters

filterobject

Filter permissions returned in the response.

Show Child Parameters

Response

application/json

User Permissions

User Permissions Response

dataarray[object]
Show Child Parameters
get/users/me/permissions
 
application/json