Organizations

API related to the management of Konnect Organizations

Set the ip allow list for organization

Sets the ip allow list for an organization.

put
https://global.api.konghq.com/v3/organizations/{organizationId}/ip-allow-list

Path Parameters

organizationIdstring(uuid)requiredread-only

UUID representing an organization.

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

Body

application/json

The request schema to set an organization’s ip allow list configuration.

Organization Source IP Restriction

* Additional properties are NOT allowed.
enabledbooleanrequired

Whether ip allow list is enabled for the organization.

Default:false

Example:true

allowed_ipsarray[string]requiredunique-items

The list of allowed ips for the organization.

>= 1 items<= 1000 items

Example:["192.168.1.1","192.168.1.0/22"]

Response

application/json

The organization’s ip allow list configuration.

Organization Source IP Restriction

* Additional properties are NOT allowed.
enabledbooleanrequired

Whether ip allow list is enabled for the organization.

Default:false

Example:true

allowed_ipsarray[string]requiredunique-items

The list of allowed ips for the organization.

>= 1 items<= 1000 items

Example:["192.168.1.1","192.168.1.0/22"]

put/organizations/{organizationId}/ip-allow-list

Body

{ "enabled": true, "allowed_ips": [ "192.168.1.1", "192.168.1.0/22" ] }
 
application/json

Update the ip allow list for organization

Updates the ip allow list configuration for an organization.

patch
https://global.api.konghq.com/v3/organizations/{organizationId}/ip-allow-list

Path Parameters

organizationIdstring(uuid)requiredread-only

UUID representing an organization.

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

Body

application/json

The request schema to update an organization’s ip allow list configuration.

* Additional properties are NOT allowed.
enabledboolean

Whether ip allow list is enabled for the organization.

Default:false

Example:true

allowed_ipsarray[string]unique-items

The list of allowed ips for the organization.

>= 1 items<= 1000 items

Example:["192.168.1.1","192.168.1.0/22"]

Response

application/json

The organization’s ip allow list configuration.

Organization Source IP Restriction

* Additional properties are NOT allowed.
enabledbooleanrequired

Whether ip allow list is enabled for the organization.

Default:false

Example:true

allowed_ipsarray[string]requiredunique-items

The list of allowed ips for the organization.

>= 1 items<= 1000 items

Example:["192.168.1.1","192.168.1.0/22"]

patch/organizations/{organizationId}/ip-allow-list

Body

{ "enabled": true, "allowed_ips": [ "192.168.1.1", "192.168.1.0/22" ] }
 
application/json

Get the ip allow list for organization

Gets the ip allow list configuration for an organization.

get
https://global.api.konghq.com/v3/organizations/{organizationId}/ip-allow-list

Path Parameters

organizationIdstring(uuid)requiredread-only

UUID representing an organization.

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

Response

application/json

The organization’s ip allow list configuration.

Organization Source IP Restriction

* Additional properties are NOT allowed.
enabledbooleanrequired

Whether ip allow list is enabled for the organization.

Default:false

Example:true

allowed_ipsarray[string]requiredunique-items

The list of allowed ips for the organization.

>= 1 items<= 1000 items

Example:["192.168.1.1","192.168.1.0/22"]

get/organizations/{organizationId}/ip-allow-list
 
application/json

List PATs

List personal access tokens in your organization. Only organization administrators are authorized to perform this action.

get
https://global.api.konghq.com/v3/organizations/{organizationId}/personal-access-tokens

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[before]string

Request the next page of data, starting with the item before this parameter.

Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

page[after]string

Request the next page of data, starting with the item after this parameter.

Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

filterobject

Filters a collection of personal access tokens in an organization.

* Additional properties are NOT allowed.
Show Child Parameters

Path Parameters

organizationIdstring(uuid)requiredread-only

UUID representing an organization.

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

Response

application/json

A list response for a collection of personal access tokens.

* Additional properties are NOT allowed.
dataarray[object]required

Properties of a personal access token.

* Additional properties are NOT allowed.
Show Child Parameters
metaobjectrequired
Show Child Parameters
get/organizations/{organizationId}/personal-access-tokens
 
application/json