Get My Organization

Returns the organization of the user identified in the token of the request.

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

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.

pats_enabledboolean

Whether Personal Access Tokens (PATs) are enabled for the organization.

mfa_enabledboolean

Whether Multi-Factor Authentication (MFA) is enabled for the organization.

get/organizations/me
 
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.

pats_enabledboolean

Whether Personal Access Tokens (PATs) are enabled for the organization.

mfa_enabledboolean

Whether Multi-Factor Authentication (MFA) is enabled for the organization.

patch/organizations/me

Body

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

Get Auth0 User MFA Settings (Internal)

Returns whether Multi-Factor Authentication (MFA) is enabled for an Auth0 user. A user’s MFA status is determined from their Konnect organization’s settings. If the user is associated with multiple organizations, MFA is considered enabled if any of their organizations have MFA enabled. Although a user is generally uniquely identified by their email address, this endpoint requires the user’s Auth0 ID to manage cases where the user logs in with multiple authentication providers but chooses not to link their accounts (in which case a single email address may correspond to multiple Auth0 user IDs).
Note: The email address is not a part of the URL path to avoid PII data in request logs/traces.

post
https://global.api.konghq.com/v3/internal/auth0/users/mfa-settings

Body

application/json

Request body for getting Multi-Factor Authentication (MFA) settings.

* Additional properties are NOT allowed.
emailstring(email)required

The email address of the user to get MFA settings for.

Example:user@example.com

auth0idstringrequired

The Auth0 ID of the user to get MFA settings for.

>= 1 characters

Example:auth0|1234567890

Response

application/json

Response containing Multi-Factor Authentication settings.

* Additional properties are NOT allowed.
mfa_enabledbooleanrequired

Whether MFA is enabled for the user

post/internal/auth0/users/mfa-settings

Body

{ "email": "user@example.com", "auth0id": "auth0|1234567890" }
 
application/json

IdpTeamGroupMapping

object

A mapping between a Konnect team and an identity provider group.

idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

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

team_idstring(uuid)required

The Konnect team ID.

Example:6801e673-cc10-498a-94cd-4271de07a0d3

groupstringrequired

The identity provider group name. Group names are case sensitive.

Example:Tech Leads

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

Example

Portals Roles

object
* Additional properties are NOT allowed.
namestringrequired

Allowed values:Portals

rolesobjectrequired
Show Child Parameters
Example