identity
Who may do what, and how they prove it
Applies to: Identity and access. Who may do what: principals, sessions, roles, policies, relationships, keys and certificates, machines, devices, delegation and agents.
Written in commons/data/models/identity/mod.ts:17. Requires arcaParty, arcaTenancy. Required by identityAccess, identityPki. 24 concepts, 27 code lists.
Diagram source
flowchart LR
audit_event -->|actor| principal
audit_event -->|onBehalfOf| principal
audit_event -->|tenant| tenant
challenge -->|destination| electronicContact
challenge -->|principal| principal
contact_verification -->|contact| electronicContact
credential -->|principal| principal
domain_claim -->|tenant| tenant
group_member -->|group| userGroup
group_member -->|member| principal
invitation -->|acceptedBy| userAccount
invitation -->|invitedBy| principal
invitation -->|tenant| tenant
known_browser -->|principal| principal
lockout_policy -->|tenant| tenant
login_attempt -->|principal| principal
login_session -->|knownBrowser| knownBrowser
login_session -->|principal| principal
login_session -->|tenant| tenant
membership -->|tenant| tenant
membership -->|userAccount| userAccount
mfa_policy -->|tenant| tenant
otp_secret -->|credential| credential
passkey -->|credential| credential
password_credential -->|credential| credential
password_policy -->|tenant| tenant
principal -->|owner| principal
principal -->|tenant| tenant
recovery_code -->|credential| credential
refresh_token -->|replacedBy| refreshToken
refresh_token -->|session| loginSession
session_policy -->|tenant| tenant
user_account -->|homeTenant| tenant
user_account -->|person| person
user_account -->|primaryEmail| electronicContact
user_account -->|principal| principal
user_group -->|principal| principal
user_group -->|tenant| tenant
verified_domain -->|tenant| tenantConcepts
| Concept | Definition | Attributes | Written in |
|---|---|---|---|
auditEvent | Something that was done, or tried, kept in a chain of hashes so that it cannot be changed without showing | 22 | commons/data/models/identity/concepts.ts:438 |
challenge | Something a person is asked to prove, once: a reset link, a magic link, a code or a passkey challenge, kept as a hash | 7 | commons/data/models/identity/concepts.ts:212 |
contactVerification | The proof that an address is a person's | 3 | commons/data/models/identity/concepts.ts:85 |
credential | What a principal proves itself with; the secret is in the kind of credential | 7 | commons/data/models/identity/concepts.ts:137 |
domainClaim | A claim on a domain, waiting to be proved | 7 | commons/data/models/identity/concepts.ts:336 |
groupMember | A principal's place in a group: a user, or another group | 1 | commons/data/models/identity/concepts.ts:126 |
invitation | An invitation to join a tenant | 7 | commons/data/models/identity/concepts.ts:315 |
knownBrowser | A browser or app that a principal signs in from, recognised by a hash of what it says it is | 6 | commons/data/models/identity/concepts.ts:249 |
lockoutPolicy | The rules for locking an account after failed sign-ins | 5 | commons/data/models/identity/concepts.ts:389 |
loginAttempt | A sign-in attempt, kept for lockout and for risk, with the identifier hashed so that an unknown user leaves nothing personal | 5 | commons/data/models/identity/concepts.ts:232 |
loginSession | A principal's being signed in, from a device, for a time | 14 | commons/data/models/identity/concepts.ts:265 |
membership | A user's place in a tenant | 5 | commons/data/models/identity/concepts.ts:98 |
mfaPolicy | The rules for second factors | 6 | commons/data/models/identity/concepts.ts:420 |
otpSecret | The secret of a one-time-code factor, kept as ciphertext under a key held outside the database | 6 | commons/data/models/identity/concepts.ts:187 |
passkey | A passkey: the public half of a key pair whose private half never leaves the person's device | 9 | commons/data/models/identity/concepts.ts:168 |
passwordCredential | A password, kept only as a hash that carries its algorithm, its parameters and its salt | 4 | commons/data/models/identity/concepts.ts:154 |
passwordPolicy | The rules for passwords | 7 | commons/data/models/identity/concepts.ts:372 |
principal | Anyone or anything that can be granted a role, own a key or act: a person, a machine, a device, an AI agent or a group | 7 | commons/data/models/identity/concepts.ts:36 |
recoveryCode | A code kept for when the other ways are lost, kept as a hash and used once | 2 | commons/data/models/identity/concepts.ts:203 |
refreshToken | A token that renews a session, kept as a hash, used once and replaced by the next one of its family | 7 | commons/data/models/identity/concepts.ts:293 |
sessionPolicy | The rules for sessions | 6 | commons/data/models/identity/concepts.ts:404 |
userAccount | A person's way in: who signs in, and where it stands | 6 | commons/data/models/identity/concepts.ts:64 |
userGroup | A set of principals that is granted what its members are | 3 | commons/data/models/identity/concepts.ts:113 |
verifiedDomain | A domain that a tenant has proved to be its own, and what that means for those who sign in with it | 5 | commons/data/models/identity/concepts.ts:353 |
Code lists
| Code list | Definition | Codes |
|---|---|---|
actorKind | What did something | 6 |
assuranceLevel | How sure a session is of who it is for, in the sense of NIST SP 800-63B | 3 |
auditOutcome | How something that was tried ended | 3 |
authMethod | How a session was authenticated | 6 |
challengePurpose | What a challenge is for | 7 |
claimMethod | How a domain is proved to be a tenant's | 3 |
claimStatus | Where a claim on a domain is | 3 |
createdVia | How a user account came to be | 5 |
credentialKind | What a principal proves itself with | 13 |
credentialStatus | Where a credential is | 3 |
decision | What an authorization decision was | 2 |
domainPolicy | What a verified domain makes of those who sign in with it | 3 |
groupSource | Where a group is kept | 2 |
invitationStatus | Where an invitation is | 4 |
loginOutcome | How a sign-in attempt ended | 6 |
membershipSource | How a user came to be a member of a tenant | 5 |
membershipStatus | Where a membership is | 4 |
mfaRequirement | Whether a second factor is needed | 4 |
otpAlgorithm | The hash a one-time code is made with | 3 |
passwordAlgorithm | How a password is hashed | 4 |
principalKind | What can be granted a role, own a key or act | 5 |
principalStatus | Where a principal is in its life | 5 |
revokedReason | Why a session ended early | 6 |
sessionStatus | Where a session is | 4 |
unlockMode | How a locked account is freed | 3 |
useStatus | Whether a thing is in use | 2 |
verificationMethod | How an address was proved to be a person's | 4 |