List organization invitations

Auth

Fetch open invitations to the selected organization. Currently unavailable in self-hosted ECE.

Path parameters

organization_id string required

Identifier for the Organization

Responses

Organization invitations fetched successfully

application/json
invitations object[] required

The list of organization invitations

token string required

The token used to accept the invitation

email string required

The email address to invite to the organization

created_at string · format: date-time required

The date and time when the invitation was created

expires_at string · format: date-time required

The date and time when the invitation expires

expired boolean required

True if the invitation is expired

accepted_at string · format: date-time

The date and time when the invitation was accepted

organization object required

An organization

id string required

The organization's identifier

name string required

The organization's friendly name

default_disk_usage_alerts_enabled boolean

Whether the default disk alerts are enabled

notifications_allowed_email_domains string[]

The list of allowed domains for notification-email recipients

billing_contacts string[]

The list of contacts for billing notifications, if specified

operational_contacts string[]

The list of contacts for operational notifications, if specified

sso_login_identifier string

The login identifier for initiating SSO

role_assignments object

Roles assigned to users, API keys or organization invitations. Currently unavailable in self-hosted ECE.

platform object[]

Assignments for roles with platform scope.

role_id string required

The ID of the role that is assigned.

organization object[]

Assignments for roles with organization scope.

role_id string required

The ID of the role that is assigned.

organization_id string required

The ID of the organization the role is scoped to.

application_roles string[]

If provided, the user assigned this role assignment will be granted this application role when signing in to a deployment or project

deployment object[]

Assignments for roles with deployment scope.

role_id string required

The ID of the role that is assigned.

organization_id string required

The ID of the organization the role is scoped to.

all boolean

When true, the role applies to all deployments in the organization, otherwise the role is scoped to the deployments specified in deployment_ids.

deployment_ids string[]

The IDs of the deployments the role is scoped to. Must be absent if all is true, and present if all is false.

application_roles string[]

If provided, the user assigned this role assignment will be granted this application role when signing in to the deployment(s) specified in the role assignment.

project object

Assignments for roles with project scope.

elasticsearch object[]

The Elasticsearch project-scoped role assignments to set

role_id string required

The ID of the role that is assigned.

organization_id string required

The ID of the organization the role is scoped to.

all boolean

When true, the role applies to all projects in the organization, otherwise the role is scoped to the projects specified in project_ids.

project_ids string[]

The IDs of the projects the role is scoped to. Must be absent if all is true, and present if all is false.

application_roles string[]

If provided, the user assigned this role assignment will be granted this application role when signing in to the project(s) specified in the role assignment.

observability object[]

The Observability project-scoped role assignments to set

role_id string required

The ID of the role that is assigned.

organization_id string required

The ID of the organization the role is scoped to.

all boolean

When true, the role applies to all projects in the organization, otherwise the role is scoped to the projects specified in project_ids.

project_ids string[]

The IDs of the projects the role is scoped to. Must be absent if all is true, and present if all is false.

application_roles string[]

If provided, the user assigned this role assignment will be granted this application role when signing in to the project(s) specified in the role assignment.

security object[]

The Security project-scoped role assignments to set

role_id string required

The ID of the role that is assigned.

organization_id string required

The ID of the organization the role is scoped to.

all boolean

When true, the role applies to all projects in the organization, otherwise the role is scoped to the projects specified in project_ids.

project_ids string[]

The IDs of the projects the role is scoped to. Must be absent if all is true, and present if all is false.

application_roles string[]

If provided, the user assigned this role assignment will be granted this application role when signing in to the project(s) specified in the role assignment.

workplaceai object[]

The WorkplaceAI project-scoped role assignments to set

role_id string required

The ID of the role that is assigned.

organization_id string required

The ID of the organization the role is scoped to.

all boolean

When true, the role applies to all projects in the organization, otherwise the role is scoped to the projects specified in project_ids.

project_ids string[]

The IDs of the projects the role is scoped to. Must be absent if all is true, and present if all is false.

application_roles string[]

If provided, the user assigned this role assignment will be granted this application role when signing in to the project(s) specified in the role assignment.

vectordb object[]

The VectorDB project-scoped role assignments to set

role_id string required

The ID of the role that is assigned.

organization_id string required

The ID of the organization the role is scoped to.

all boolean

When true, the role applies to all projects in the organization, otherwise the role is scoped to the projects specified in project_ids.

project_ids string[]

The IDs of the projects the role is scoped to. Must be absent if all is true, and present if all is false.

application_roles string[]

If provided, the user assigned this role assignment will be granted this application role when signing in to the project(s) specified in the role assignment.

Organization not found. (code: organization.not_found)

application/json
errors object[] required

A list of errors that occurred in the failing request

code string required

A structured code representing the error type that occurred

message string required

A human readable message describing the error that occurred

fields string[]

If the error can be tied to a specific field or fields in the user request, this lists those fields

Response headers

x-cloud-error-codes enum

The error codes associated with the response