Skip to main content

service_accounts

Creates, updates, deletes, gets or lists a service_accounts resource.

Overview

Nameservice_accounts
TypeResource
Idconfluent.iam.service_accounts

Fields

NameDatatypeDescription
idstringID 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").
descriptionstringA free-form description of the Service Account
api_versionstringAPIVersion defines the schema version of this representation of a resource.
display_namestringA human-readable name for the Service Account
kindstringKind defines the object this REST resource represents.
metadata``ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

Methods

NameAccessible byRequired ParamsDescription
get_iam_v2service_accountSELECTidGeneral Availability Make a request to read a service account.
list_iam_v2service_accountsSELECTGeneral Availability Retrieve a sorted, filtered, paginated list of all service accounts.
create_iam_v2service_accountINSERTGeneral Availability Make a request to create a service account.
delete_iam_v2service_accountDELETEidGeneral Availability Make a request to delete a service account. If successful, this request will also recursively delete all of the service account's associated resources, including its cloud and cluster API keys.
update_iam_v2service_accountUPDATEidGeneral Availability Make a request to update a service account.

SELECT examples

General Availability Retrieve a sorted, filtered, paginated list of all service accounts.

SELECT
id,
description,
api_version,
display_name,
kind,
metadata
FROM confluent.iam.service_accounts
;

INSERT example

Use the following StackQL query and manifest file to create a new service_accounts resource.

/*+ create */
INSERT INTO confluent.iam.service_accounts (
data__display_name,
data__description
)
SELECT
'{{ display_name }}',
'{{ description }}'
;

UPDATE example

Updates a service_accounts resource.

/*+ update */
UPDATE confluent.iam.service_accounts
SET
description = '{{ description }}'
WHERE
id = '{{ id }}';

DELETE example

Deletes the specified service_accounts resource.

/*+ delete */
DELETE FROM confluent.iam.service_accounts
WHERE id = '{{ id }}';