invitations

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

Overview

Name	invitations
Type	Resource
Id	confluent.iam.invitations

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").
accepted_at	string	The timestamp that the invitation was accepted
api_version	string	APIVersion defines the schema version of this representation of a resource.
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.
creator	object	The invitation creator
email	string	The user/invitee's email address
expires_at	string	The timestamp that the invitation will expire
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.
status	string	The status of invitations
user	object	The user/invitee

Methods

Name	Accessible by	Required Params	Description
get_iam_v2invitation	SELECT	id	Make a request to read an invitation.
list_iam_v2invitations	SELECT		Retrieve a sorted, filtered, paginated list of all invitations.
create_iam_v2invitation	INSERT		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_v2invitation	DELETE	id	Make a request to delete an invitation. Delete will deactivate the user if the user didn't accept the invitation yet.

SELECT examples

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
;

INSERT example

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

Required Properties

/*+ create */
INSERT INTO confluent.iam.invitations (
data__email,
data__auth_type,
data__user,
data__creator
)
SELECT 
'{{ email }}',
'{{ auth_type }}',
'{{ user }}',
'{{ creator }}'
;

All Properties

/*+ create */
INSERT INTO confluent.iam.invitations (
data__email
)
SELECT 
'{{ email }}'
;

Manifest

- name: invitations
  props:
    - name: email
      value: string
    - name: auth_type
      value: string
    - name: user
      props:
        - name: id
          value: string
    - name: creator
      props:
        - name: id
          value: string

DELETE example

Deletes the specified invitations resource.

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