1.0.8OAS 3.0

Admin API for Kong Authorization (KAuth) service

API Base URL
  • Server 1:http://admin-api.kauth.svc.cluster.local:8000/v1

    KAuth Admin API Internal url

  • Server 2:http://kauth-source-ip-api.kauth.svc.cluster.local:8080/v1

    Source IP API Internal url

Additional Information
Contact Kong

Organization

Organization management

Update organization settings

Updates organization settings for the organization identified by the organization-scoped token.
Currently supports MFA settings only, but will be extended
to support additional settings and eventually replace specialized Organization Lifecycle API patch operations
like /deletion-config.

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.

* Additional properties are NOT allowed.
mfa_settingsobject

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

* Additional properties are NOT allowed.
Show Child Parameters

Response

application/json

The response schema for updating an organization.

mfa_settingsobject

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

* Additional properties are NOT allowed.
Show Child Parameters
patch/internal/organizations/{organizationId}

Body

{ "mfa_settings": { "enabled": true } }
 
application/json

Portal IP Allow List

APIs related to Portal IP Allow List

Get all ip allow lists for portal

Gets all the ip allow lists for a portal.

get

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Response

application/json

The response schema for getting all ip allow lists for a portal.

allowed_ipsarray[string]

The list of allowed ips for the portal.

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

get/internal/portals/{portalId}/ip-allow-list
 
application/json