Sign in
Invitations (iam/v2)

Read an Invitation

General Availability

Make a request to read an invitation.

get/iam/v2/invitations/{id}

Path parameters

idstring required

The unique identifier for the invitation.

Response

Invitation.

api_version'iam/v2' required

APIVersion defines the schema version of this representation of a resource.

kind'Invitation' required

Kind defines the object this REST resource represents.

idstring required

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").

emailstring email required

The user/invitee's email address

auth_typestring

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.

statusstring

The status of invitations

accepted_atstring date-time nullable

The timestamp that the invitation was accepted

expires_atstring date-time

The timestamp that the invitation will expire

Example response

{
  "id": "dlz-f3a90de",
  "metadata": {
    "self": "https://api.confluent.cloud/iam/v2/invitations/i-12345",
    "resource_name": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/invitation=i-12345",
    "created_at": "2006-01-02T15:04:05-07:00",
    "updated_at": "2006-01-02T15:04:05-07:00",
    "deleted_at": "2006-01-02T15:04:05-07:00"
  },
  "email": "johndoe@confluent.io",
  "auth_type": "AUTH_TYPE_SSO",
  "status": "INVITE_STATUS_SENT",
  "accepted_at": "2022-07-06T17:21:33Z",
  "expires_at": "2022-07-07T17:22:39Z"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.