Resources / Invitation
Invitation
A one-time link that grants a role to whoever redeems it after signing in.
Overview
| API | iam.etorm.com/v1alpha1 |
| Resource | invitations (cluster-scoped inside its cluster) |
| Short names | invite |
| Available in | the platform and project clusters |
| Status | none: the object is configuration only |
Minimal example
apiVersion: iam.etorm.com/v1alpha1
kind: Invitation
metadata:
name: example
spec:
roleRef:
name: "<name>"
Spec
| Field | Type | Required | Default | Allowed | Description |
roleRef | object | yes | | | The role granted when the invitation is redeemed. |
roleRef.name | string | yes | | length 1 to 63 | |
scope | object | | | | Root 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.billingAccount | reference to BillingAccount | | | length 1 to 63 | |
scope.workspace | reference to Workspace | | | length 1 to 63 | |
maxUses | integer | | 1 | 1 to 50 | How many people can redeem it (1 to 50). |
expiresAt | string | | | up to 20 characters | RFC 3339 UTC. Default 7 days from creation, at most 30 days for anyone below platform level. |
description | string | | | up to 512 characters | |
Status
| Field | Type | Required | Default | Allowed | Description |
tokenHash | string | | | | |
token | string | | | | Returned once, in the create response only. |
Columns in listings
| Column | From |
|---|
| Role | .spec.roleRef.name |
| Scope | .spec.scope.billingAccount |
| Uses | .spec.maxUses |
| Expires | .spec.expiresAt |
Related guides
All resources