invitations

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

Overview

Name	invitations
Type	Resource
Id	confluent.iam.invitations

Fields

The following fields are returned by SELECT queries:

get_iam_v2_invitation

Invitation.

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)
accepted_at	string (date-time)	The timestamp that the invitation was accepted (example: 2022-07-06T17:21:33.000Z)
api_version	string	APIVersion defines the schema version of this representation of a resource. (iam/v2)
auth_type	string	The user/invitee's authentication type. Note that only the OrganizationAdmin role can invite AUTH_TYPE_LOCAL users to SSO organizations. The user's auth_type is set as AUTH_TYPE_SSO by default if the organization has SSO enabled. Otherwise, the user's auth_type is AUTH_TYPE_LOCAL by default. (example: AUTH_TYPE_SSO)
creator	object	The invitation creator
email	string (email)	The user/invitee's email address (example: johndoe@confluent.io)
expires_at	string (date-time)	The timestamp that the invitation will expire (example: 2022-07-07T17:22:39.000Z)
kind	string	Kind defines the object this REST resource represents. (Invitation)
metadata	object	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
status	string	The status of invitations (example: INVITE_STATUS_SENT)
user	object	The user/invitee

list_iam_v2_invitations

Invitation.

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)
accepted_at	string (date-time)	The timestamp that the invitation was accepted (example: 2022-07-06T17:21:33.000Z)
api_version	string	APIVersion defines the schema version of this representation of a resource. (iam/v2)
auth_type	string	The user/invitee's authentication type. Note that only the OrganizationAdmin role can invite AUTH_TYPE_LOCAL users to SSO organizations. The user's auth_type is set as AUTH_TYPE_SSO by default if the organization has SSO enabled. Otherwise, the user's auth_type is AUTH_TYPE_LOCAL by default. (example: AUTH_TYPE_SSO)
creator	object	The invitation creator
email	string (email)	The user/invitee's email address (example: johndoe@confluent.io)
expires_at	string (date-time)	The timestamp that the invitation will expire (example: 2022-07-07T17:22:39.000Z)
kind	string	Kind defines the object this REST resource represents. (Invitation)
metadata	object	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
status	string	The status of invitations (example: INVITE_STATUS_SENT)
user	object	The user/invitee

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_iam_v2_invitation	select	id		Make a request to read an invitation.
list_iam_v2_invitations	select		email, status, user, creator, page_size, page_token	Retrieve a sorted, filtered, paginated list of all invitations.
create_iam_v2_invitation	insert	email		Make a request to create an invitation. The newly invited user will not have any permissions. Give the user permission by assigning them to one or more roles by creating role bindings for the created user.
delete_iam_v2_invitation	delete	id		Make a request to delete an invitation. Delete will deactivate the user if the user didn't accept the invitation yet.

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 invitation.
creator	string	Filter the results by exact match for creator. (example: u-m2r9o7)
email	string	Filter the results by exact match for email. (example: johndoe@confluent.io)
page_size	integer	A pagination size for collection requests.
page_token	string	An opaque pagination token for collection requests.
status	string	Filter the results by exact match for status. (example: INVITE_STATUS_SENT)
user	string	Filter the results by exact match for user. (example: u-j93dy8)

SELECT examples

get_iam_v2_invitation

Make a request to read an invitation.

SELECT
id,
accepted_at,
api_version,
auth_type,
creator,
email,
expires_at,
kind,
metadata,
status,
user
FROM confluent.iam.invitations
WHERE id = '{{ id }}' -- required
;

list_iam_v2_invitations

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

SELECT
id,
accepted_at,
api_version,
auth_type,
creator,
email,
expires_at,
kind,
metadata,
status,
user
FROM confluent.iam.invitations
WHERE email = '{{ email }}'
AND status = '{{ status }}'
AND user = '{{ user }}'
AND creator = '{{ creator }}'
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;

INSERT examples

create_iam_v2_invitation

Make a request to create an invitation.

The newly invited user will not have any permissions. Give the user permission by assigning them to one or
more roles by creating
role bindings
for the created user.

INSERT INTO confluent.iam.invitations (
email,
auth_type
)
SELECT 
'{{ email }}' /* required */,
'{{ auth_type }}'
RETURNING
id,
accepted_at,
api_version,
auth_type,
creator,
email,
expires_at,
kind,
metadata,
status,
user
;

Manifest

# Description fields are for documentation purposes
- name: invitations
props:
  - name: email
    value: "{{ email }}"
    description: |
      The user/invitee's email address
  - name: auth_type
    value: "{{ auth_type }}"
    description: |
      The user/invitee's authentication type. Note that only the [OrganizationAdmin role](https://docs.confluent.io/cloud/current/access-management/access-control/cloud-rbac.html#organizationadmin)
      can invite AUTH_TYPE_LOCAL users to SSO organizations.
      The user's auth_type is set as AUTH_TYPE_SSO by default if the organization has SSO enabled.
      Otherwise, the user's auth_type is AUTH_TYPE_LOCAL by default.

DELETE examples

delete_iam_v2_invitation

Make a request to delete an invitation.

Delete will deactivate the user if the user didn't accept the invitation yet.

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