Update My Organization
Updates the current user’s organization. When updating the owner, the new owner
must be an organization admin.
Body
application/json
Body
The request schema to update an organization.
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
The new name of the organization.
Example:Kong Inc
Whether multi-factor authentication (MFA) is enabled for the organization.
Example:true
Response
application/json
Response
Me Organization
Me Organization Response
UUID of the organization.
Name of the organization.
Owner ID of the organization.
Path to organization-specific login when single sign on (SSO) is enabled. Blank otherwise.
Date the organization was created.
Date the organization was last updated.
State of the organization
Allowed values:activeinactivedeletingdeleted
The number of days an organization spends inactive before being deleted.
Authentication
Body
Managed System Accounts - Roles
List Roles (Internal)
Lists the roles belonging to a managed system account. Returns 400 if any filter parameters are invalid.
Query Parameters
Filter roles returned in the response.
Show Child Parameters
Path Parameters
ID of the system account.
Response
application/json
Response
A paginated list response for a collection of parameterized assigned roles.
Parameterized Assigned Roles Collection Response
returns the pagination information
Show Child Parameters
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
Authentication
Path Parameters
Query Parameters
Assign a role to a managed System Account
Assigns a role to a managed system account. Returns 409 if role is already assigned.
Path Parameters
ID of the system account.
Body
application/json
Body
The request schema for assigning a role.
A parameterized assigned role is a role that has been assigned to a managed system account.
The desired role.
Example:Connector
The ID of the entity.
Example:e67490ce-44dc-4cbd-b65e-b52c746fc26a
The type of entity.
Example:Mesh Control Planes
The region to scope the role assignment to.
Allowed values:useuaumeinsg*
Example:eu
Example:{"zoneName":"zone3"}
Response
application/json
Response
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.
The ID of the role assignment.
Example:eaf7adf1-32c8-4bbf-b960-d1f8456afe67
Name of the role being assigned.
Example:Viewer
A RBAC entity ID.
Example:817d0422-45c9-4d88-8d64-45aef05c1ae7
Name of the entity type the role is being assigned to.
Example:Control Planes
Region of the entity.
Allowed values:useuaumeinsg*
Example:eu
Additional parameters for the role assignment.