Resources / Invitation

Invitation

A one-time link that grants a role to whoever redeems it after signing in.

Overview

APIiam.etorm.com/v1alpha1
Resourceinvitations (cluster-scoped inside its cluster)
Short namesinvite
Available inthe platform and project clusters
Statusnone: the object is configuration only

Minimal example

apiVersion: iam.etorm.com/v1alpha1
kind: Invitation
metadata:
  name: example
spec:
  roleRef:
    name: "<name>"

Spec

FieldTypeRequiredDefaultAllowedDescription
roleRefobjectyesThe role granted when the invitation is redeemed.
roleRef.namestringyeslength 1 to 63
scopeobjectRoot invitations only. Restricts the grant to one billing account and its projects, or to one workspace, its descendants and their projects. Name exactly one.
scope.billingAccountreference to BillingAccountlength 1 to 63
scope.workspacereference to Workspacelength 1 to 63
maxUsesinteger11 to 50How many people can redeem it (1 to 50).
expiresAtstringup to 20 charactersRFC 3339 UTC. Default 7 days from creation, at most 30 days for anyone below platform level.
descriptionstringup to 512 characters

Status

FieldTypeRequiredDefaultAllowedDescription
tokenHashstring
tokenstringReturned once, in the create response only.

Columns in listings

ColumnFrom
Role.spec.roleRef.name
Scope.spec.scope.billingAccount
Uses.spec.maxUses
Expires.spec.expiresAt

Related guides

All resources