Resources / APIToken

APIToken

A bearer secret for a principal. The secret is shown once at creation and never stored.

Overview

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

Minimal example

apiVersion: iam.etorm.com/v1alpha1
kind: APIToken
metadata:
  name: example
spec:
  subject:
    kind: User
    name: "<name>"

Spec

FieldTypeRequiredDefaultAllowedDescription
descriptionstringup to 512 characters
expiresAtstringup to 20 charactersRFC 3339 UTC, e.g. 2027-01-01T00:00:00Z.
subjectobjectyesThe principal the token authenticates as.
subject.kindstring (one of)yesUser, ServiceAccount
subject.namestringyeslength 1 to 63

Status

FieldTypeRequiredDefaultAllowedDescription
secretHashstring
subjectUidstringThe uid of the principal the token was issued for; the token stops working if the principal is deleted and recreated.
tokenstringReturned once, in the create response only.

Columns in listings

ColumnFrom
Kind.spec.subject.kind
Subject.spec.subject.name
Expires.spec.expiresAt

Related guides

All resources