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

Assign a role to a managed System Account

Assigns a role to a managed system account. Returns 409 if role is already assigned.

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

Path Parameters

accountIdstringrequired

ID of the system account.

Body

application/json

The request schema for assigning a role.

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

role_namestring

The desired role.

Example:Connector

entity_idstring(uuid)

The ID of the entity.

Example:e67490ce-44dc-4cbd-b65e-b52c746fc26a

entity_type_namestring

The type of entity.

Example:Mesh Control Planes

entity_regionstring

The region to scope the role assignment to.

Allowed values:useuaumeinsg*

Example:eu

parametersobject

Example:{"zoneName":"zone3"}

Response

application/json

A get response of a single parameterized assigned role.

ParameterizedAssignedRole

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

idstring(uuid)

The ID of the role assignment.

Example:eaf7adf1-32c8-4bbf-b960-d1f8456afe67

role_namestring

Name of the role being assigned.

Example:Viewer

entity_idstring(uuid)

A RBAC entity ID.

Example:817d0422-45c9-4d88-8d64-45aef05c1ae7

entity_type_namestring

Name of the entity type the role is being assigned to.

Example:Control Planes

entity_regionstring

Region of the entity.

Allowed values:useuaumeinsg*

Example:eu

parametersobject

Additional parameters for the role assignment.

* Additional properties are allowed.
post/internal/system-accounts/{accountId}/assigned-roles

Body

{ "id": "eaf7adf1-32c8-4bbf-b960-d1f8456afe67", "role_name": "Connector", "entity_id": "18ee2573-dec0-4b83-be99-fa7700bcdc61", "entity_type_name": "Mesh Control Planes", "entity_region": "eu", "parameters": { "zoneName": "zone4" } }
 
application/json

Authentication