Update ip allow list for organization

Updates the ip allow list configuration for an organization.

patch

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/internal/organizations/{organizationId}/ip-allow-list

Body

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

MFA Settings Request

object

Settings related to Multi-Factor Authentication (MFA) for the organization.

* Additional properties are NOT allowed.
enabledbooleanrequired

Whether MFA is enabled for the user

Example:true

Example

OrganizationId

string

UUID representing an organization.

Example

Error

object

standard error

statusintegerrequiredread-only

The HTTP status code of the error. Useful when passing the response
body to child properties in a frontend UI. Must be returned as an integer.

titlestringrequiredread-only

A short, human-readable summary of the problem. It should not
change between occurences of a problem, except for localization.
Should be provided as “Sentence case” for direct use in the UI.

typestringread-only

The error type.

instancestringrequiredread-only

Used to return the correlation ID back to the user, in the format
kong:trace:<correlation_id>. This helps us find the relevant logs
when a customer reports an issue.

detailstringrequiredread-only

A human readable explanation specific to this occurence of the problem.
This field may contain request/entity data to help the user understand
what went wrong. Enclose variable values in square brackets. Should be
provided as “Sentence case” for direct use in the UI.

Example

InvalidRules

string

invalid parameters rules

Allowed values:requiredis_arrayis_base64is_booleanis_date_timeis_integeris_nullis_numberis_objectis_stringis_uuidis_fqdnis_arnunknown_propertymissing_referenceis_labelmatches_regexinvalidis_supported_network_availability_zone_listis_supported_network_cidr_blockis_supported_provider_regiontype