0.0.1OAS 3.0

The management API for Konnect Organization Lifecycle.

API Base URL
  • Server 1:https://global.api.konghq.com/v3

    Global Base URL

Additional Information
Contact Kong

Organization Lifecycle

Sets a new state for an organization

Sets a new state for an organization and creates an organization state
history record. An organization can be set to active or inactive.

post
https://global.api.konghq.com/v3/organizations/state

Body

application/json

The request schema to set an organization’s state.

statestringrequired

The state of the organization to set.

Allowed values:activeinactivedeletingdeleted

Example:inactive

reasonstring

The reason for the state change.

Example:invoice overdue (30 days)

changed_bystring

The uuid of the konger who modified the state.

Example:00uerwcs8eC4ifanR256

Response

application/json

A response for setting the organization state.

Organization State

idstring(uuid)read-only

UUID of the organization.

Example:d99c041a-c7cf-46a2-bf3a-44bb5f75400e

statestring

State of the organization.

Allowed values:activeinactivedeletingdeleted

Example:active

reasonstring

The reason for the organization’s state.

Example:invoice overdue (30 days)

servicestring

The service that modified the state.

Example:kbilling

changed_bystring

The ID of the Konger who modified the state.

Example:00uerwcs8eC4ifanR256

created_atstring(date-time)read-only

Date the organization state was created.

Example:2023-01-23T17:22:52.150Z

post/organizations/state

Body

{ "state": "inactive", "reason": "invoice overdue (30 days)", "changed_by": "00uerwcs8eC4ifanR256" }
 
application/json