How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Confluent Invitations (iam/v2) API

[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)`Invitation` objects represent invitations to invite users to join your organizations in Confluent Cloud.The API allows you to list all your invitations, as well as create, read, and delete a specified invitation.Related guide: [User invitations in Confluent Cloud](https://docs.confluent.io/cloud/current/access-management/identity/user-accounts.html).## The Invitations Model## Quotas and LimitsThis resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html):| Quota | Description || --- | --- || `invitations_per_org` | Invitations in a Confluent Cloud organization |

Confluent Invitations (iam/v2) API is one of 127 APIs that Confluent publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Invitations (iam/v2). The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 4 operations across 2 paths, and defines 8 schemas. It is described by OpenAPI 3.2.0.

Requests are made against a single base URL, https://api.confluent.cloud.

4 operations 2 paths 8 schemas 1 DELETE2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
Base URL
https://api.confluent.cloud
Authentication
HTTP Basic, OAuth 2.0, HTTP Basic, HTTP Basic, OAuth 2.0, OAuth 2.0
Resource Areas
1

Authentication & Security 6

Confluent Invitations (iam/v2) API declares 6 security schemes for authenticating requests. It accepts HTTP basic authentication (cloud-api-key). It supports OAuth 2.0 (confluent-sts-access-token) using the clientCredentials flow. It accepts HTTP basic authentication (global-api-key). It accepts HTTP basic authentication (resource-api-key). It supports OAuth 2.0 (external-access-token) using the clientCredentials flow. It supports OAuth 2.0 (oauth) using the clientCredentials flow, exposing 4 scopes.

  • cloud-api-key — Authenticate with Cloud API Keys using HTTP Basic Auth. Treat the Cloud API Key ID as the username and Cloud API Key Secret as the password.
  • confluent-sts-access-token — Authenticate with Confluent API using this credentials (JSON Web Tokens) following OAuth 2.0.
  • global-api-key — Authenticate with Global API Keys using HTTP Basic Auth. Treat the Global API Key ID as the username and Global API Key Secret as the password.
  • resource-api-key — Authenticate with resource-specific API Keys using HTTP Basic Auth. Treat the resource-specific API Key ID as the username and resource-specific API Key Secret…
  • external-access-token — Authenticate with Confluent API using this credentials (JSON Web Tokens) following OAuth 2.0.
  • oauth — Authenticate with OAuth 2.0. Currently this is only supported for partner APIs.

Paths & Operations 4

Across 2 paths, the API surfaces 4 operations — 1 DELETE, 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Invitations (iam/v2) 4

[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](section/Versioning/API-Lifecycle-Policy) Invitation objects represent in…

GET
/iam/v2/invitations
List of Invitations
listIamV2Invitations 6 params → 200400401403429500
POST
/iam/v2/invitations
Create an Invitation
createIamV2Invitation body → 201400401402403409422429
GET
/iam/v2/invitations/{id}
Read an Invitation
getIamV2Invitation 1 param → 200400401403404429500
DELETE
/iam/v2/invitations/{id}
Delete an Invitation
deleteIamV2Invitation 1 param → 204400401403404429500

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are iam.v2.Invitation (11 properties), Error (8 properties), ListMeta (5 properties), ObjectMeta (5 properties). Each schema is shown below with its type and property counts.

Error
object
Describes a particular error encountered while performing an operation.
8 properties
ObjectMeta
object
ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
5 properties 1 required
iam.v2.Invitation
object
Invitation objects represent invitations to invite users to join your organizations in Confluent Cloud. The API allows you to list all your invitations, as wel…
11 properties
GlobalObjectReference
object
ObjectReference provides information for you to locate the referred object
3 properties 3 required
Failure
object
Provides information about problems encountered while performing an operation.
1 property 1 required
SearchFilter
string
Filter a collection by a string search
ListMeta
object
ListMeta describes metadata that resource collections may have
5 properties
iam.v2.InvitationList
object
Invitation objects represent invitations to invite users to join your organizations in Confluent Cloud. The API allows you to list all your invitations, as wel…
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

confluent-invitations-iam-v2-api-openapi.yml Raw ↑

Other APIs Confluent publishes across the network.

Confluent
Confluent Managed MCP Servers
Confluent ACLs API
Confluent API Keys API
Confluent Clusters API
Confluent Consumer Groups API
Confluent Environments API
Confluent Partitions API
Confluent Service Accounts API
Confluent Topics API
Confluent Access Points (networking/v1) API
Confluent ACL (v3) API
Where this information came from

This is an independent, third-party profile of Confluent Invitations (iam/v2) API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.