Skip to main content
POST
Invite to organization

Authorizations

Authorization
string
header
required

Bearer token for the authenticated caller.

Headers

idempotency-key
string

Optional caller-supplied idempotency key. Any non-empty key up to 64 characters is accepted. Endpoint-specific documentation describes how the key is used.

Required string length: 1 - 64
Example:

"create-prod-2026-05-07"

Path Parameters

id
string
required
Required string length: 3 - 54

Body

application/json
email
string<email>
required
Maximum string length: 254
Pattern: ^[^\s@]+@[^\s@]+\.[^\s@]+$
Example:

"ada@example.com"

role
enum<string>
required

Only an owner may invite an owner. roles/viewer is granted through :setIamPolicy.

Available options:
roles/member,
roles/admin,
roles/owner

Response

Invitation created

id
string
required
Required string length: 3 - 55
organization_id
string
required
Required string length: 3 - 54
email
string<email>
required
Maximum string length: 254
Pattern: ^[^\s@]+@[^\s@]+\.[^\s@]+$
Example:

"ada@example.com"

role
enum<string>
required

Only an owner may invite an owner. roles/viewer is granted through :setIamPolicy.

Available options:
roles/member,
roles/admin,
roles/owner
state
enum<string>
required
Available options:
pending,
accepted,
declined,
revoked,
expired
expire_at
integer
required

When a pending invitation becomes expired.

Required range: 0 <= x <= 9007199254740991
created_at
integer
required

Unix timestamp (seconds)

Required range: 0 <= x <= 9007199254740991
updated_at
integer
required

Unix timestamp (seconds)

Required range: 0 <= x <= 9007199254740991