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

Update My Organization

Updates the current user’s organization. When updating the owner, the new owner
must be an organization admin.

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

Body

application/json

The request schema to update an organization.

owner_idstring(uuid)

The user id of the new owner of the organization. Must be a member of the Organization Admins team.

Example:d9c56d92-0339-4dfb-be0c-2253162edba9

namestring

The new name of the organization.

Example:Kong Inc

mfa_enabledboolean

Whether multi-factor authentication (MFA) is enabled for the organization.

Example:true

Response

application/json

Me Organization

Me Organization Response

idstring(uuid)read-only

UUID of the organization.

namestring

Name of the organization.

owner_idstring

Owner ID of the organization.

login_pathstring

Path to organization-specific login when single sign on (SSO) is enabled. Blank otherwise.

created_atstring(date-time)read-only

Date the organization was created.

updated_atstring(date-time)read-only

Date the organization was last updated.

statestring

State of the organization

Allowed values:activeinactivedeletingdeleted

retention_period_daysinteger

The number of days an organization spends inactive before being deleted.

patch/organizations/me

Body

{ "owner_id": "df120cb4-f60b-47bc-a2f8-6a28e6a3c63b", "name": "Kong Inc" }
 
application/json

Managed System Accounts - Roles

List Roles (Internal)

Lists the roles belonging to a managed system account. Returns 400 if any filter parameters are invalid.

get
https://global.api.konghq.com/v3/internal/system-accounts/{accountId}/assigned-roles

Query Parameters

filterobject

Filter roles returned in the response.

Show Child Parameters

Path Parameters

accountIdstringrequired

ID of the system account.

Response

application/json

A paginated list response for a collection of parameterized assigned roles.

Parameterized Assigned Roles Collection Response

metaobject

returns the pagination information

Show Child Parameters
dataarray[object]

A parameterized assigned role is a role that has been assigned to a managed system account with additional parameters.

Example:{"id":"54cc6168-ebb1-4300-8168-d62a0dd08fc8","role_name":"Viewer","entity_id":"18ee2573-dec0-4b83-be99-fa7700bcdc61","entity_type_name":"Control Planes","entity_region":"us","parameters":{"zoneName":"zone3"}}

Show Child Parameters
get/internal/system-accounts/{accountId}/assigned-roles
 
application/json