IF Commons GitHub

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.

actor onBehalfOf tenant destination principal contact principal tenant group member acceptedBy invitedBy tenant principal tenant principal knownBrowser principal tenant tenant userAccount tenant credential credential credential tenant owner tenant credential replacedBy session tenant homeTenant person primaryEmail principal principal tenant tenant audit_event principal tenant challenge electronicContact contact_verification credential domain_claim group_member userGroup invitation userAccount known_browser lockout_policy login_attempt login_session knownBrowser membership mfa_policy otp_secret passkey password_credential password_policy recovery_code refresh_token refreshToken loginSession session_policy user_account person user_group verified_domain
How the concepts of identity relate
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| tenant

Concepts

ConceptDefinitionAttributesWritten in
auditEventSomething that was done, or tried, kept in a chain of hashes so that it cannot be changed without showing22commons/data/models/identity/concepts.ts:438
challengeSomething a person is asked to prove, once: a reset link, a magic link, a code or a passkey challenge, kept as a hash7commons/data/models/identity/concepts.ts:212
contactVerificationThe proof that an address is a person's3commons/data/models/identity/concepts.ts:85
credentialWhat a principal proves itself with; the secret is in the kind of credential7commons/data/models/identity/concepts.ts:137
domainClaimA claim on a domain, waiting to be proved7commons/data/models/identity/concepts.ts:336
groupMemberA principal's place in a group: a user, or another group1commons/data/models/identity/concepts.ts:126
invitationAn invitation to join a tenant7commons/data/models/identity/concepts.ts:315
knownBrowserA browser or app that a principal signs in from, recognised by a hash of what it says it is6commons/data/models/identity/concepts.ts:249
lockoutPolicyThe rules for locking an account after failed sign-ins5commons/data/models/identity/concepts.ts:389
loginAttemptA sign-in attempt, kept for lockout and for risk, with the identifier hashed so that an unknown user leaves nothing personal5commons/data/models/identity/concepts.ts:232
loginSessionA principal's being signed in, from a device, for a time14commons/data/models/identity/concepts.ts:265
membershipA user's place in a tenant5commons/data/models/identity/concepts.ts:98
mfaPolicyThe rules for second factors6commons/data/models/identity/concepts.ts:420
otpSecretThe secret of a one-time-code factor, kept as ciphertext under a key held outside the database6commons/data/models/identity/concepts.ts:187
passkeyA passkey: the public half of a key pair whose private half never leaves the person's device9commons/data/models/identity/concepts.ts:168
passwordCredentialA password, kept only as a hash that carries its algorithm, its parameters and its salt4commons/data/models/identity/concepts.ts:154
passwordPolicyThe rules for passwords7commons/data/models/identity/concepts.ts:372
principalAnyone or anything that can be granted a role, own a key or act: a person, a machine, a device, an AI agent or a group7commons/data/models/identity/concepts.ts:36
recoveryCodeA code kept for when the other ways are lost, kept as a hash and used once2commons/data/models/identity/concepts.ts:203
refreshTokenA token that renews a session, kept as a hash, used once and replaced by the next one of its family7commons/data/models/identity/concepts.ts:293
sessionPolicyThe rules for sessions6commons/data/models/identity/concepts.ts:404
userAccountA person's way in: who signs in, and where it stands6commons/data/models/identity/concepts.ts:64
userGroupA set of principals that is granted what its members are3commons/data/models/identity/concepts.ts:113
verifiedDomainA domain that a tenant has proved to be its own, and what that means for those who sign in with it5commons/data/models/identity/concepts.ts:353

Code lists

Code listDefinitionCodes
actorKindWhat did something6
assuranceLevelHow sure a session is of who it is for, in the sense of NIST SP 800-63B3
auditOutcomeHow something that was tried ended3
authMethodHow a session was authenticated6
challengePurposeWhat a challenge is for7
claimMethodHow a domain is proved to be a tenant's3
claimStatusWhere a claim on a domain is3
createdViaHow a user account came to be5
credentialKindWhat a principal proves itself with13
credentialStatusWhere a credential is3
decisionWhat an authorization decision was2
domainPolicyWhat a verified domain makes of those who sign in with it3
groupSourceWhere a group is kept2
invitationStatusWhere an invitation is4
loginOutcomeHow a sign-in attempt ended6
membershipSourceHow a user came to be a member of a tenant5
membershipStatusWhere a membership is4
mfaRequirementWhether a second factor is needed4
otpAlgorithmThe hash a one-time code is made with3
passwordAlgorithmHow a password is hashed4
principalKindWhat can be granted a role, own a key or act5
principalStatusWhere a principal is in its life5
revokedReasonWhy a session ended early6
sessionStatusWhere a session is4
unlockModeHow a locked account is freed3
useStatusWhether a thing is in use2
verificationMethodHow an address was proved to be a person's4

Titles, headings, exports, tables, columns and requirements. Esc closes.