organizations

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

Overview

Name	organizations
Type	Resource
Id	confluent.partner.organizations

Fields

The following fields are returned by SELECT queries:

get_partner_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)
name	string	The name of the organization (example: Acme Organization, pattern: ^[^<>#%'*^`{|}~"]{1,31}$)
api_version	string	APIVersion defines the schema version of this representation of a resource. (partner/v2)
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.
sso_config	object
sso_url	string (uri)	The login URL for the customer to access Confluent Cloud (example: https://confluent.cloud/login/sso/AzureAD-OIDC-Conn)

list_partner_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)
name	string	The name of the organization (example: Acme Organization, pattern: ^[^<>#%'*^`{|}~"]{1,31}$)
api_version	string	APIVersion defines the schema version of this representation of a resource. (partner/v2)
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.
sso_config	object
sso_url	string (uri)	The login URL for the customer to access Confluent Cloud (example: https://confluent.cloud/login/sso/AzureAD-OIDC-Conn)

Methods

The following methods are available for this resource:

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

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_partner_v2_organization

Make a request to read an organization.

SELECT
id,
name,
api_version,
kind,
metadata,
sso_config,
sso_url
FROM confluent.partner.organizations
WHERE id = '{{ id }}' -- required
;

list_partner_v2_organizations

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

SELECT
id,
name,
api_version,
kind,
metadata,
sso_config,
sso_url
FROM confluent.partner.organizations
WHERE page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;