COconfluent
Organizations (org/v2)

Update an Organization

Changed on

General Availability

Make a request to update an organization.

patch/org/v2/organizations/{id}

Request

  • Base URL
    https://api.confluent.cloud
  • URL
    https://api.confluent.cloud/org/v2/organizations/{id}
  • Auth
    • HTTP basic
    • or HTTP basic
    • or OAuth 2
      Client credentials
      Token URL: https://api.confluent.cloud/sts/v1/oauth2/token

Path parameters

idstring required

The unique identifier for the organization.

Request body

api_version'org/v2'

APIVersion defines the schema version of this representation of a resource.

kind'Organization'

Kind defines the object this REST resource represents.

idstring

ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object kinds or objects of the same kind within a different scope/namespace ("space").

display_namestring

A human-readable name for the Organization

jit_enabledboolean

The flag to toggle Just-In-Time user provisioning for SSO-enabled organization. Available for early access only.

scim_enabledboolean

The flag to toggle SCIM user provisioning for an SSO-enabled organization.

Example request

{
  "id": "dlz-f3a90de",
  "metadata": {
    "self": "https://api.confluent.cloud/org/v2/organizations/o-12345",
    "resource_name": "crn://confluent.cloud/organization=o-12345",
    "created_at": "2006-01-02T15:04:05-07:00",
    "updated_at": "2006-01-02T15:04:05-07:00",
    "deleted_at": "2006-01-02T15:04:05-07:00"
  },
  "display_name": "Finance Org"
}

Response

Organization.

api_version'org/v2' required

APIVersion defines the schema version of this representation of a resource.

kind'Organization' required

Kind defines the object this REST resource represents.

idstring required

ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object kinds or objects of the same kind within a different scope/namespace ("space").

display_namestring

A human-readable name for the Organization

jit_enabledboolean

The flag to toggle Just-In-Time user provisioning for SSO-enabled organization. Available for early access only.

scim_enabledboolean

The flag to toggle SCIM user provisioning for an SSO-enabled organization.

Example response

{
  "id": "dlz-f3a90de",
  "metadata": {
    "self": "https://api.confluent.cloud/org/v2/organizations/o-12345",
    "resource_name": "crn://confluent.cloud/organization=o-12345",
    "created_at": "2006-01-02T15:04:05-07:00",
    "updated_at": "2006-01-02T15:04:05-07:00",
    "deleted_at": "2006-01-02T15:04:05-07:00"
  },
  "display_name": "Finance Org"
}

Changes

  • 83f5e4fbfe08Revision changes
    • info

      added the new optional request property

    • info

      added the optional property //// to the response with the status