List Teams for a System Account

Returns a paginated list of a teams that the system account belongs to.

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

Query Parameters

page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[number]integer

Determines which page of the entities to retrieve.

Example:1

filterobject

Filter teams 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 users.

Team Collection Response

metaobject

returns the pagination information

Show Child Parameters
dataarray[object]

The team object contains information about a group of users.

Example:{"id":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","name":"IDM - Developers","description":"The developers for the IDM API.","system_team":false,"labels":{"env":"test"},"created_at":"1992-02-07T17:46:57.52Z","updated_at":"2022-08-31T17:00:00.52Z"}

Show Child Parameters
get/system-accounts/{accountId}/teams
 
application/json

Me

Get My User Account

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

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

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

get/users/me
 
application/json

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.

get/organizations/me
 
application/json

Authentication