API docs by Redocly

Konnect Organization Lifecycle (0.0.0)

Download OpenAPI specification:Download

URL: https://konghq.com

The management API for Konnect Organization Lifecycle.

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.

Request Body schema: application/json

The request schema to set an organization's state.

state
required
string
Enum: "active" "inactive" "deleting" "deleted"

The state of the organization to set.

reason
string

The reason for the state change.

changed_by
string

The uuid of the konger who modified the state.

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": "d99c041a-c7cf-46a2-bf3a-44bb5f75400e",
  • "state": "active",
  • "reason": "invoice overdue (30 days)",
  • "service": "kadmin",
  • "changed_by": "00uerwcs8eC4ifanR256",
  • "created_at": "2023-01-18T11:35:45.130Z"
}

Returns the state history of an organization.

Returns the state history of an organization sorted in reverse chronological order. Possible states include active, inactive, deleting, and deleted. An organization state will be transitioned to the deleting state if the organization remains inactive for 90 days. After deletion is complete, the state will be transitioned to the final deleted state.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Sets the deletion configs for a specifed organization.

Sets the deletion configs for a specified organization. The retention period is the number of days an organization can remain in the inactive state before being permanently deleted.

path Parameters
organizationId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

The ID of the organization being patched.

Request Body schema: application/json

The request schema to set an organization's retention period.

retention_period_days
integer [ 1 .. 365 ]

The retention period in days.

Responses

Request samples

Content type
application/json
{
  • "retention_period_days": 90
}

Response samples

Content type
application/json
{
  • "retention_period_days": 90
}