users

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

Overview

Name	users
Type	Resource
Id	confluent.iam.users

Fields

The following fields are returned by SELECT queries:

get_iam_v2_user

User.

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)
full_name	string	The user's full name (example: Marty McFly)
api_version	string	APIVersion defines the schema version of this representation of a resource. (iam/v2)
auth_type	string	The user's authentication method (example: AUTH_TYPE_SSO)
email	string (email)	The user's email address (example: marty.mcfly@example.com)
kind	string	Kind defines the object this REST resource represents. (User)
metadata	object	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

list_iam_v2_users

User.

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)
full_name	string	The user's full name (example: Marty McFly)
api_version	string	APIVersion defines the schema version of this representation of a resource. (iam/v2)
auth_type	string	The user's authentication method (example: AUTH_TYPE_SSO)
email	string (email)	The user's email address (example: marty.mcfly@example.com)
kind	string	Kind defines the object this REST resource represents. (User)
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_iam_v2_user	select	id		Make a request to read a user.
list_iam_v2_users	select		page_size, page_token	Retrieve a sorted, filtered, paginated list of all users.
update_iam_v2_user	update	id		Make a request to update a user.
delete_iam_v2_user	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_auth_type_iam_v2_user	exec	id		Update the auth type of a user

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 user.
page_size	integer	A pagination size for collection requests.
page_token	string	An opaque pagination token for collection requests.

SELECT examples

get_iam_v2_user

Make a request to read a user.

SELECT
id,
full_name,
api_version,
auth_type,
email,
kind,
metadata
FROM confluent.iam.users
WHERE id = '{{ id }}' -- required
;

list_iam_v2_users

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

SELECT
id,
full_name,
api_version,
auth_type,
email,
kind,
metadata
FROM confluent.iam.users
WHERE page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;

UPDATE examples

update_iam_v2_user

Make a request to update a user.

UPDATE confluent.iam.users
SET 
email = '{{ email }}',
full_name = '{{ full_name }}'
WHERE 
id = '{{ id }}' --required
RETURNING
id,
full_name,
api_version,
auth_type,
email,
kind,
metadata;

DELETE examples

delete_iam_v2_user

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.

DELETE FROM confluent.iam.users
WHERE id = '{{ id }}' --required
;

Lifecycle Methods

update_auth_type_iam_v2_user

Update the auth type of a user

EXEC confluent.iam.users.update_auth_type_iam_v2_user 
@id='{{ id }}' --required 
@@json=
'{
"auth_type": "{{ auth_type }}"
}'
;