spec

Field Type Required Description
displayName string yes The name a screen shows for this person.
nickname string no A short name, one word, for a screen with little room: a first name, or what people call this person. Optional. A screen shows the display name when this is unset.
avatar string no This person’s picture, as a claim://<claim>/<path> reference to a file on a claim. It is the same form a Play uses to name media. Optional.
uid integer no The Linux uid that owns this person’s files. Set it when this person’s files already exist under a uid, on a NAS for example. Optional. Nothing assigns one yet.
identity object no This person’s login at an outside identity provider, as an OIDC issuer URL and subject. Optional. Nothing reads it yet.

spec.identity

This person’s login at an outside identity provider, as an OIDC issuer URL and subject. Optional. Nothing reads it yet.

Field Type Required Description
issuer string yes The issuer URL, exactly as the provider’s discovery document states it.
subject string yes The subject claim, sub, that the issuer gives this person.

status

Field Type Required Description
uid integer no The uid in effect for this person. Nothing writes it yet.