COconfluent
Invitations (iam/v2)

Create an Invitation

General Availability

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.

post/iam/v2/invitations

Request

  • Base URL
    https://api.confluent.cloud
  • URL
    https://api.confluent.cloud/iam/v2/invitations
  • Auth
    • HTTP basic
    • or OAuth 2
      Client credentials
      Token URL: https://api.confluent.cloud/sts/v1/oauth2/token

Request body

api_version'iam/v2'

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

kind'Invitation'

Kind defines the object this REST resource represents.

idstring

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 request

{
  "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"
}

Response

An Invitation was created.

api_version'iam/v2'

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

kind'Invitation'

Kind defines the object this REST resource represents.

idstring

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 operation across all 7 revisions of this API.