users

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

Overview

Name	users
Type	Resource
Id	confluent.iam.users

Fields

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").
api_version	string	APIVersion defines the schema version of this representation of a resource.
auth_type	string	The user's authentication method
email	string	The user's email address
full_name	string	The user's full name
kind	string	Kind 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

Name	Accessible by	Required Params	Description
get_iam_v2user	SELECT	id	Make a request to read a user.
list_iam_v2users	SELECT		Retrieve a sorted, filtered, paginated list of all users.
delete_iam_v2user	DELETE	id	Make a request to delete a user. If successful, this request will also recursively delete all of the user's associated resources, including its cloud and cluster API keys.
update_iam_v2user	UPDATE	id	Make a request to update a user.

SELECT examples

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

SELECT
id,
api_version,
auth_type,
email,
full_name,
kind,
metadata
FROM confluent.iam.users
;

UPDATE example

Updates a users resource.

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

DELETE example

Deletes the specified users resource.

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