Skip to content

AuraInvite API Reference

⚠️ BETA / best-effort. Uses the Aura API v2beta1 (unstable beta). See the Aura Orchestration Guide. ✅ Live-verified 2026-08-01. See Verification status.

The AuraInvite CRD invites a user (by email) to a Neo4j Aura organization — or a project within it — with a role. This is how a new person is granted Aura console access; it is not an in-database Neo4j user. An existing member's role is managed with AuraOrganizationMember / AuraProjectMember.

Overview

  • API Version: neo4j.neo4j.com/v1beta1
  • Kind: AuraInvite
  • Scope: Namespaced
  • Short name: aurainvite
  • Guide: Aura Orchestration Guide

Spec

Set exactly one of providerConfigRef or credentialsSecretRef.

Field Type Description
providerConfigRef object References an AuraProviderConfig ({name}) in the same namespace. Mutually exclusive with credentialsSecretRef.
credentialsSecretRef object Inline single-account credentials. Mutually exclusive with providerConfigRef.
organizationId string The Aura organization to invite into. Falls back to the provider config's defaultOrganizationId.
projectId string Optionally scopes the invite to a project (a project-member invite). Omit for an org-level invite.
email string Required. The invitee's email address.
role string Required. Enum organization-owner / organization-admin / organization-member for an org invite (projectId must be unset), or namespace-admin / namespace-member / namespace-viewer / namespace-metrics-integration-reader for a project-scoped invite (projectId required). Enforced by CEL. The Aura invite body spells project roles namespace-* even though the project-members endpoint spells the same concepts project-*.
organizationRole string Enum organization-owner / organization-admin / organization-member. Grants the organization-level role on acceptance. Required when role is a namespace-* role — Aura demands an organization role on every invite (an empty role list is rejected), so a project-only invite is impossible. Enforced by CEL.
deletionPolicy string Enum Delete (default; revoke a still-pending invite) / Orphan (leave it).
managementPolicies []string Items enum Observe/Create/Delete/*. Default ["*"].

Status

Field Type Description
inviteId string Aura-assigned invite ID.
phase string Sent (invite active, awaiting acceptance), Accepted, Revoked, Expired, Declined (mirroring the Aura invite status), Gone (the invite is no longer listed at all — accepted, declined, revoked or expired, and Aura does not say which), Pending (no matching invite exists and managementPolicies does not permit creating one), or Error.
conditions []metav1.Condition Standard readiness conditions.
observedGeneration int64 The .metadata.generation last reconciled.
lastSyncedTime *metav1.Time When the invite was last observed from the Aura API.

Example

apiVersion: neo4j.neo4j.com/v1beta1
kind: AuraInvite
metadata:
  name: invite-carol
  namespace: neo4j
spec:
  providerConfigRef: { name: aura }
  organizationId: "<org-id>"
  email: carol@example.com
  role: organization-member