Written to: 8 requirements: 8 proved, 0 partly, 0 failing, 0 with no test recorded. 0030-identity FR-001, 0030-identity FR-002, 0030-identity FR-005, 0030-identity FR-006, 0030-identity FR-007, 0030-identity FR-008 and 2 more
The concepts of the identity model (commons data 0030-identity): who may do what, and how they prove it. A principal (a user, a service account or a group) plays the part for identity that a party plays for Arca. Secrets are never stored in the clear: a password is a hash, a one-time-code secret is ciphertext under a key kept outside the database, and a token or a key is a hash of a secret that was shown once. Sessions and tokens are short-lived and are kept only as long as they are of use. Every concept says how private and how secret it is, and what it is kept for.
Source: commons/data/models/identity/concepts.ts
0 of 25 exports are imported by a test of the run. A test that imports an export may not call it or check what it returns.
principalconstno test imports itconst principal: AnyConcept
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. What every kind has (a lifecycle, an owner, credentials, roles, attributes, policies and a place in the audit trail) is attached to the principal; what is specific to a kind is in a concept of its own, in the module of that kind.
userAccountconstno test imports itconst userAccount: Concept<"userAccount", { readonly loginIdentifier: Attribute<Datatype, Multiplicity>; readonly create… (716 characters)
const userAccount: Concept<"userAccount", { readonly loginIdentifier: Attribute<Datatype, Multiplicity>; readonly createdVia: Attribute<Datatype, Multiplicity>; readonly lockedUntil: Attribute<Datatype, Multiplicity>; readonly lastAuthenticatedAt: Attribute<Datatype, Multiplicity>; readonly locale: Attribute<Datatype, Multiplicity>; readonly timeZone: Attribute<Datatype, Multiplicity>; }, { readonly principal: Relationship<"one", AnyConcept | (() => AnyConcept)>; readonly person: Relationship<"one", AnyConcept | (() => AnyConcept)>; readonly homeTenant: Relationship<"optional", AnyConcept | (() => AnyConcept)>; readonly primaryEmail: Relationship<"optional", AnyConcept | (() => AnyConcept)>; }, "principal">
A user account: a person's way in. Its identity is its principal's.
contactVerificationconstno test imports itconst contactVerification: Concept<"contactVerification", { readonly contactVerificationId: Attribute<Datatype, Multiplicity>; readonly verifiedAt: Attribute<Datatype, Multiplicity>; readonly method: Attribute<Datatype, Multiplicity>; }, { readonly contact: Relationship<"one", AnyConcept | (() => AnyConcept)>; }, "contactVerificationId">
The proof that an address is a person's: Arca's electronic contact does not say, so identity does.
membershipconstno test imports itconst membership: Concept<"membership", { readonly membershipId: Attribute<Datatype, Multiplicity>; readonly status: Att… (483 characters)
const membership: Concept<"membership", { readonly membershipId: Attribute<Datatype, Multiplicity>; readonly status: Attribute<Datatype, Multiplicity>; readonly source: Attribute<Datatype, Multiplicity>; readonly joinedAt: Attribute<Datatype, Multiplicity>; readonly removedAt: Attribute<Datatype, Multiplicity>; }, { readonly userAccount: Relationship<"one", AnyConcept | (() => AnyConcept)>; readonly tenant: Relationship<"one", AnyConcept | (() => AnyConcept)>; }, "membershipId">
A user's place in a tenant.
userGroupconstno test imports itconst userGroup: Concept<"userGroup", { readonly name: Attribute<Datatype, Multiplicity>; readonly source: Attribute<Datatype, Multiplicity>; readonly externalId: Attribute<Datatype, Multiplicity>; }, { readonly principal: Relationship<"one", AnyConcept | (() => AnyConcept)>; readonly tenant: Relationship<"one", AnyConcept | (() => AnyConcept)>; }, "principal">
A group: a set of principals that is granted what its members are. Its identity is its principal's.
groupMemberconstno test imports itconst groupMember: Concept<"groupMember", { readonly addedAt: Attribute<Datatype, Multiplicity>; }, { readonly group: Relationship<"one", AnyConcept | (() => AnyConcept)>; readonly member: Relationship<"one", AnyConcept | (() => AnyConcept)>; }, "group" | "member">
A principal's place in a group: a user, or another group.
credentialconstno test imports itconst credential: Concept<"credential", { readonly credentialId: Attribute<Datatype, Multiplicity>; readonly kind: Attri… (516 characters)
const credential: Concept<"credential", { readonly credentialId: Attribute<Datatype, Multiplicity>; readonly kind: Attribute<Datatype, Multiplicity>; readonly status: Attribute<Datatype, Multiplicity>; readonly label: Attribute<Datatype, Multiplicity>; readonly createdAt: Attribute<Datatype, Multiplicity>; readonly lastUsedAt: Attribute<Datatype, Multiplicity>; readonly revokedAt: Attribute<Datatype, Multiplicity>; }, { readonly principal: Relationship<"one", AnyConcept | (() => AnyConcept)>; }, "credentialId">
What a principal proves itself with. The secret is in the kind of credential, never here.
passwordCredentialconstno test imports itconst passwordCredential: Concept<"passwordCredential", { readonly hash: Attribute<Datatype, Multiplicity>; readonly algorithm: Attribute<Datatype, Multiplicity>; readonly changedAt: Attribute<Datatype, Multiplicity>; readonly mustChange: Attribute<Datatype, Multiplicity>; }, { readonly credential: Relationship<"one", AnyConcept | (() => AnyConcept)>; }, "credential">
A password, as a hash that carries its algorithm, parameters and salt.
passkeyconstno test imports itconst passkey: Concept<"passkey", { readonly credentialIdValue: Attribute<Datatype, Multiplicity>; readonly publicKey: A… (648 characters)
const passkey: Concept<"passkey", { readonly credentialIdValue: Attribute<Datatype, Multiplicity>; readonly publicKey: Attribute<Datatype, Multiplicity>; readonly signCount: Attribute<Datatype, Multiplicity>; readonly aaguid: Attribute<Datatype, Multiplicity>; readonly transports: Attribute<Datatype, Multiplicity>; readonly backupEligible: Attribute<Datatype, Multiplicity>; readonly backedUp: Attribute<Datatype, Multiplicity>; readonly userVerified: Attribute<Datatype, Multiplicity>; readonly attestationFormat: Attribute<Datatype, Multiplicity>; }, { readonly credential: Relationship<"one", AnyConcept | (() => AnyConcept)>; }, "credential">
A passkey: the public half of a key pair whose private half never leaves the person's device.
otpSecretconstno test imports itconst otpSecret: Concept<"otpSecret", { readonly secretCiphertext: Attribute<Datatype, Multiplicity>; readonly keyRefere… (480 characters)
const otpSecret: Concept<"otpSecret", { readonly secretCiphertext: Attribute<Datatype, Multiplicity>; readonly keyReference: Attribute<Datatype, Multiplicity>; readonly algorithm: Attribute<Datatype, Multiplicity>; readonly digits: Attribute<Datatype, Multiplicity>; readonly periodSeconds: Attribute<Datatype, Multiplicity>; readonly lastUsedStep: Attribute<Datatype, Multiplicity>; }, { readonly credential: Relationship<"one", AnyConcept | (() => AnyConcept)>; }, "credential">
The secret of a one-time-code factor, encrypted under a key that is kept outside the database.
recoveryCodeconstno test imports itconst recoveryCode: Concept<"recoveryCode", { readonly hash: Attribute<Datatype, Multiplicity>; readonly usedAt: Attribute<Datatype, Multiplicity>; }, { readonly credential: Relationship<"one", AnyConcept | (() => AnyConcept)>; }, "credential">
A recovery code, kept as a hash and used once.
challengeconstno test imports itconst challenge: Concept<"challenge", { readonly challengeId: Attribute<Datatype, Multiplicity>; readonly purpose: Attri… (610 characters)
const challenge: Concept<"challenge", { readonly challengeId: Attribute<Datatype, Multiplicity>; readonly purpose: Attribute<Datatype, Multiplicity>; readonly secretHash: Attribute<Datatype, Multiplicity>; readonly attempts: Attribute<Datatype, Multiplicity>; readonly maxAttempts: Attribute<Datatype, Multiplicity>; readonly expiresAt: Attribute<Datatype, Multiplicity>; readonly consumedAt: Attribute<Datatype, Multiplicity>; }, { readonly principal: Relationship<"optional", AnyConcept | (() => AnyConcept)>; readonly destination: Relationship<"optional", AnyConcept | (() => AnyConcept)>; }, "challengeId">
Something a person is asked to prove, once: a reset link, a magic link, an emailed code or a passkey challenge, always kept as a hash.
loginAttemptconstno test imports itconst loginAttempt: Concept<"loginAttempt", { readonly loginAttemptId: Attribute<Datatype, Multiplicity>; readonly login… (424 characters)
const loginAttempt: Concept<"loginAttempt", { readonly loginAttemptId: Attribute<Datatype, Multiplicity>; readonly loginIdentifierHash: Attribute<Datatype, Multiplicity>; readonly ip: Attribute<Datatype, Multiplicity>; readonly outcome: Attribute<Datatype, Multiplicity>; readonly at: Attribute<Datatype, Multiplicity>; }, { readonly principal: Relationship<"optional", AnyConcept | (() => AnyConcept)>; }, "loginAttemptId">
A sign-in attempt, for lockout and for risk; the identifier is hashed so that an unknown user leaves nothing personal.
knownBrowserconstno test imports itconst knownBrowser: Concept<"knownBrowser", { readonly knownBrowserId: Attribute<Datatype, Multiplicity>; readonly finge… (488 characters)
const knownBrowser: Concept<"knownBrowser", { readonly knownBrowserId: Attribute<Datatype, Multiplicity>; readonly fingerprintHash: Attribute<Datatype, Multiplicity>; readonly label: Attribute<Datatype, Multiplicity>; readonly firstSeenAt: Attribute<Datatype, Multiplicity>; readonly lastSeenAt: Attribute<Datatype, Multiplicity>; readonly trustedUntil: Attribute<Datatype, Multiplicity>; }, { readonly principal: Relationship<"one", AnyConcept | (() => AnyConcept)>; }, "knownBrowserId">
A browser or app that a principal signs in from, recognised by a hash of what it says it is.
loginSessionconstno test imports itconst loginSession: Concept<"loginSession", { readonly sessionId: Attribute<Datatype, Multiplicity>; readonly authentica… (1095 characters)
const loginSession: Concept<"loginSession", { readonly sessionId: Attribute<Datatype, Multiplicity>; readonly authenticatedAt: Attribute<Datatype, Multiplicity>; readonly lastSeenAt: Attribute<Datatype, Multiplicity>; readonly idleExpiresAt: Attribute<Datatype, Multiplicity>; readonly absoluteExpiresAt: Attribute<Datatype, Multiplicity>; readonly assuranceLevel: Attribute<Datatype, Multiplicity>; readonly authMethods: Attribute<Datatype, Multiplicity>; readonly federatedProvider: Attribute<Datatype, Multiplicity>; readonly ip: Attribute<Datatype, Multiplicity>; readonly userAgent: Attribute<Datatype, Multiplicity>; readonly status: Attribute<Datatype, Multiplicity>; readonly revokedAt: Attribute<Datatype, Multiplicity>; readonly revokedReason: Attribute<Datatype, Multiplicity>; readonly stepUpAt: Attribute<Datatype, Multiplicity>; }, { readonly principal: Relationship<"one", AnyConcept | (() => AnyConcept)>; readonly tenant: Relationship<"optional", AnyConcept | (() => AnyConcept)>; readonly knownBrowser: Relationship<"optional", AnyConcept | (() => AnyConcept)>; }, "sessionId">
A session: a principal's being signed in, from a device, for a time.
refreshTokenconstno test imports itconst refreshToken: AnyConcept
A refresh token, kept as a hash: used once, and replaced by the next in its family.
invitationconstno test imports itconst invitation: Concept<"invitation", { readonly invitationId: Attribute<Datatype, Multiplicity>; readonly email: Attr… (670 characters)
const invitation: Concept<"invitation", { readonly invitationId: Attribute<Datatype, Multiplicity>; readonly email: Attribute<Datatype, Multiplicity>; readonly tokenHash: Attribute<Datatype, Multiplicity>; readonly status: Attribute<Datatype, Multiplicity>; readonly expiresAt: Attribute<Datatype, Multiplicity>; readonly acceptedAt: Attribute<Datatype, Multiplicity>; readonly message: Attribute<Datatype, Multiplicity>; }, { readonly tenant: Relationship<"one", AnyConcept | (() => AnyConcept)>; readonly invitedBy: Relationship<"one", AnyConcept | (() => AnyConcept)>; readonly acceptedBy: Relationship<"optional", AnyConcept | (() => AnyConcept)>; }, "invitationId">
An invitation to join a tenant, with the roles to grant on acceptance.
domainClaimconstno test imports itconst domainClaim: Concept<"domainClaim", { readonly domainClaimId: Attribute<Datatype, Multiplicity>; readonly domain: … (526 characters)
const domainClaim: Concept<"domainClaim", { readonly domainClaimId: Attribute<Datatype, Multiplicity>; readonly domain: Attribute<Datatype, Multiplicity>; readonly challengeValue: Attribute<Datatype, Multiplicity>; readonly method: Attribute<Datatype, Multiplicity>; readonly status: Attribute<Datatype, Multiplicity>; readonly requestedAt: Attribute<Datatype, Multiplicity>; readonly expiresAt: Attribute<Datatype, Multiplicity>; }, { readonly tenant: Relationship<"one", AnyConcept | (() => AnyConcept)>; }, "domainClaimId">
A claim on a domain, waiting to be proved.
verifiedDomainconstno test imports itconst verifiedDomain: Concept<"verifiedDomain", { readonly verifiedDomainId: Attribute<Datatype, Multiplicity>; readonly… (429 characters)
const verifiedDomain: Concept<"verifiedDomain", { readonly verifiedDomainId: Attribute<Datatype, Multiplicity>; readonly domain: Attribute<Datatype, Multiplicity>; readonly verifiedAt: Attribute<Datatype, Multiplicity>; readonly policy: Attribute<Datatype, Multiplicity>; readonly lastCheckedAt: Attribute<Datatype, Multiplicity>; }, { readonly tenant: Relationship<"one", AnyConcept | (() => AnyConcept)>; }, "verifiedDomainId">
A domain that a tenant has proved to be its own: one tenant only.
passwordPolicyconstno test imports itconst passwordPolicy: Concept<"passwordPolicy", { readonly passwordPolicyId: Attribute<Datatype, Multiplicity>; readonly… (557 characters)
const passwordPolicy: Concept<"passwordPolicy", { readonly passwordPolicyId: Attribute<Datatype, Multiplicity>; readonly minLength: Attribute<Datatype, Multiplicity>; readonly maxLength: Attribute<Datatype, Multiplicity>; readonly requireBreachCheck: Attribute<Datatype, Multiplicity>; readonly historyCount: Attribute<Datatype, Multiplicity>; readonly maxAgeDays: Attribute<Datatype, Multiplicity>; readonly allowedAlgorithms: Attribute<Datatype, Multiplicity>; }, { tenant: Relationship<"optional", AnyConcept | (() => AnyConcept)>; }, "passwordPolicyId">
lockoutPolicyconstno test imports itconst lockoutPolicy: Concept<"lockoutPolicy", { readonly lockoutPolicyId: Attribute<Datatype, Multiplicity>; readonly fa… (434 characters)
const lockoutPolicy: Concept<"lockoutPolicy", { readonly lockoutPolicyId: Attribute<Datatype, Multiplicity>; readonly failedAttempts: Attribute<Datatype, Multiplicity>; readonly windowMinutes: Attribute<Datatype, Multiplicity>; readonly lockMinutes: Attribute<Datatype, Multiplicity>; readonly unlockMode: Attribute<Datatype, Multiplicity>; }, { tenant: Relationship<"optional", AnyConcept | (() => AnyConcept)>; }, "lockoutPolicyId">
The rules for locking an account.
sessionPolicyconstno test imports itconst sessionPolicy: Concept<"sessionPolicy", { readonly sessionPolicyId: Attribute<Datatype, Multiplicity>; readonly id… (505 characters)
const sessionPolicy: Concept<"sessionPolicy", { readonly sessionPolicyId: Attribute<Datatype, Multiplicity>; readonly idleMinutes: Attribute<Datatype, Multiplicity>; readonly absoluteMinutes: Attribute<Datatype, Multiplicity>; readonly concurrentSessionLimit: Attribute<Datatype, Multiplicity>; readonly bindToDevice: Attribute<Datatype, Multiplicity>; readonly stepUpMinutes: Attribute<Datatype, Multiplicity>; }, { tenant: Relationship<"optional", AnyConcept | (() => AnyConcept)>; }, "sessionPolicyId">
mfaPolicyconstno test imports itconst mfaPolicy: Concept<"mfaPolicy", { readonly mfaPolicyId: Attribute<Datatype, Multiplicity>; readonly requirement: A… (482 characters)
const mfaPolicy: Concept<"mfaPolicy", { readonly mfaPolicyId: Attribute<Datatype, Multiplicity>; readonly requirement: Attribute<Datatype, Multiplicity>; readonly allowedKinds: Attribute<Datatype, Multiplicity>; readonly graceDays: Attribute<Datatype, Multiplicity>; readonly rememberDeviceDays: Attribute<Datatype, Multiplicity>; readonly requiredForRoles: Attribute<Datatype, Multiplicity>; }, { tenant: Relationship<"optional", AnyConcept | (() => AnyConcept)>; }, "mfaPolicyId">
The rules for second factors.
auditEventconstno test imports itconst auditEvent: Concept<"auditEvent", { readonly auditEventId: Attribute<Datatype, Multiplicity>; readonly sequence: A… (1494 characters)
const auditEvent: Concept<"auditEvent", { readonly auditEventId: Attribute<Datatype, Multiplicity>; readonly sequence: Attribute<Datatype, Multiplicity>; readonly occurredAt: Attribute<Datatype, Multiplicity>; readonly actorKind: Attribute<Datatype, Multiplicity>; readonly decision: Attribute<Datatype, Multiplicity>; readonly delegationKey: Attribute<Datatype, Multiplicity>; readonly runKey: Attribute<Datatype, Multiplicity>; readonly traceId: Attribute<Datatype, Multiplicity>; readonly chain: Attribute<Datatype, Multiplicity>; readonly policyRefs: Attribute<Datatype, Multiplicity>; readonly action: Attribute<Datatype, Multiplicity>; readonly outcome: Attribute<Datatype, Multiplicity>; readonly targetConcept: Attribute<Datatype, Multiplicity>; readonly targetKey: Attribute<Datatype, Multiplicity>; readonly sessionKey: Attribute<Datatype, Multiplicity>; readonly requestId: Attribute<Datatype, Multiplicity>; readonly ip: Attribute<Datatype, Multiplicity>; readonly userAgent: Attribute<Datatype, Multiplicity>; readonly reason: Attribute<Datatype, Multiplicity>; readonly detail: Attribute<Datatype, Multiplicity>; readonly previousHash: Attribute<Datatype, Multiplicity>; readonly eventHash: Attribute<Datatype, Multiplicity>; }, { readonly tenant: Relationship<"optional", AnyConcept | (() => AnyConcept)>; readonly actor: Relationship<"optional", AnyConcept | (() => AnyConcept)>; readonly onBehalfOf: Relationship<"optional", AnyConcept | (() => AnyConcept)>; }, "auditEventId">
Something that was done, or tried, kept in a chain of hashes so that it cannot be changed without showing.
conceptsconstno test imports itconst concepts: readonly AnyConcept[]
Every concept of the core, in the order they are written.