organizations

Creates, updates, deletes, gets or lists an organizations resource.

Overview

Name	organizations
Type	Resource
Id	confluent.org.organizations

Fields

The following fields are returned by SELECT queries:

get_org_v2_organization

Organization.

Name	Datatype	Description
id	string	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"). (example: dlz-f3a90de)
display_name	string	A human-readable name for the Organization (example: Finance Org, pattern: ^[^<>#%'*^`{|}~"]{1,31}$)
api_version	string	APIVersion defines the schema version of this representation of a resource. (org/v2)
jit_enabled	boolean	The flag to toggle Just-In-Time user provisioning for SSO-enabled organization. Available for early access only.
kind	string	Kind defines the object this REST resource represents. (Organization)
metadata	object	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

list_org_v2_organizations

Organization.

Name	Datatype	Description
id	string	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"). (example: dlz-f3a90de)
display_name	string	A human-readable name for the Organization (example: Finance Org, pattern: ^[^<>#%'*^`{|}~"]{1,31}$)
api_version	string	APIVersion defines the schema version of this representation of a resource. (org/v2)
jit_enabled	boolean	The flag to toggle Just-In-Time user provisioning for SSO-enabled organization. Available for early access only.
kind	string	Kind defines the object this REST resource represents. (Organization)
metadata	object	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_org_v2_organization	select	id		Make a request to read an organization.
list_org_v2_organizations	select		page_size, page_token	Retrieve a sorted, filtered, paginated list of all organizations.
update_org_v2_organization	update	id		Make a request to update an organization.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
id	string	The unique identifier for the organization.
page_size	integer	A pagination size for collection requests.
page_token	string	An opaque pagination token for collection requests.

SELECT examples

get_org_v2_organization

Make a request to read an organization.

SELECT
id,
display_name,
api_version,
jit_enabled,
kind,
metadata
FROM confluent.org.organizations
WHERE id = '{{ id }}' -- required
;

list_org_v2_organizations

Retrieve a sorted, filtered, paginated list of all organizations.

SELECT
id,
display_name,
api_version,
jit_enabled,
kind,
metadata
FROM confluent.org.organizations
WHERE page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;

UPDATE examples

update_org_v2_organization

Make a request to update an organization.

UPDATE confluent.org.organizations
SET 
display_name = '{{ display_name }}',
jit_enabled = {{ jit_enabled }}
WHERE 
id = '{{ id }}' --required
RETURNING
id,
display_name,
api_version,
jit_enabled,
kind,
metadata;