`lib-user` 库参考

原文: https://finproducts.atlassian.net/wiki/spaces/JIDD3/pages/34793488762/FIN+5.3.1+lib-user 中文整理基于 FIN 5.3.1

导读： 用户管理模块

以下为 API 参考，保留英文以便对照源码；目录已列出（英文标题便于检索）；概述已尽量中译。

目录（导读）

lib
meta
tags
funcs
views
def
supertypes
userBackup()
userBackupCleanup(dateOrAge)
userBackupDelete(ts)
userBackups()
userCommit(diffs)
userCur()
userIsProjAccessible(user, projName)
userLastLogin(username)
userMfaStatus(userRefs)
userMfaTotpReset(userRefs)
userRead(filterExpr, checked: true)
userReadAll(filterExpr: null, optsExpr: null)
userReadById(id, checked: true)
userSetPassword(username, password)
- tags
- enum
- src

概述（中译）

用户管理模块

API 正文（英文）


appAccess	Restricts the set of accessible apps
arcAccessFilter	Restricts access to arc document records
arcUnassignable	Hides the user from `assignedTo` field on arc documents
arcWriteAccess	Defines write permissions for arc documents
defUri	Host relative URI to redirect the user upon login
defView	The name of the view that should be the default for a user or project
fileAccess	List of directory Uris that a non-su user has read-write access to
fileAccessReadOnly	List of directory Uris that a non-su user has read-only access to
notifications	The set of notifications a user is subscribed to
pointOverrideAccess	Defines levels which may be overridden by the user for writable points
projAccessFilter	Applied to users to defines access to projects
reportCanSave	Enables an operator user to save reports to the database
siteAccessFilter	Restricts access to sites
topicsEmailDigest	Classic legacy support
topicsEmailImmediate	Classic legacy support
user	User account
userAccessFilter	Restricts which users are visible
userAllow	List of function names to allow on this user
userAuth	Defines how a user authenticates
userFailedLogins	How many failed login attempts the user has made since last successful login
userLockOut	Indicates the user is locked out because of too many failed login attempts
userMfa	Indicates the user requires multifactor authentication and which multifactor authentication method is configured
userProto	A user prototype
userProtoName	User prototype name
userProtoRef	User prototype to apply to a user
userRef	Reference to user entity
userRole	Indicates what permissions and access rights the user has

funcs


userBackup	Asynchronously kick off a new backup for user database
userBackupCleanup	Delete all user database backups older than the given duration or date
userBackupDelete	Delete a user database backup file by its timestamp
userBackups	List all the user database backups
userCommit	Commit one or more diffs to the user database
userCur	Read user rec Dict for current session user
userIsProjAccessible	Return if the given user has access to the project as configured by `projAccessFilter`
userLastLogin	Get information about the last successful login for the user with the given `username`
userMfaStatus	Check if MFA is required and if user is enrolled
userMfaTotpReset	Clear the stored Totp MFA enrollment configuration
userRead	Read a rec Dict from the user db by filter
userReadAll	Read a Grid of recs from the user db by filter
userReadById	Read a rec Dict from the user db by id
userSetPassword	Update password of the given user

views


userBackups	Execute and manage backups of the local user database
userPrefs	Manage preferences for the current user
userProtos	Manage user prototypes in the local user database
userSettings	Settings for the user system module
users	Manage the local user database

appAccess

Restricts the set of accessible apps. This tag is formatted as a list of comma-separated app names.

meta


def	appAccess
is	str
lib	lib:user
tagOn	user, userProto
uiInput	ui::AppAccessInput

supertypes


val	Data value type
scalar	Scalar is an atomic value kind
str	Unicode string of characters

arcAccessFilter

Restricts access to arc document records.

meta


def	arcAccessFilter
is	filterStr
lib	lib:user
tagOn	user, userProto

supertypes


val	Data value type
scalar	Scalar is an atomic value kind
str	Unicode string of characters
filterStr	Haystack filter string

arcUnassignable

Hides the user from assignedTo field on arc documents.

meta


def	arcUnassignable
is	marker
lib	lib:user
tagOn	user, userProto

supertypes


marker	Marker labels a dict with typing information

arcWriteAccess

Defines write permissions for arc documents. This tag is formatted as a comma-separated list of the following permissions:

"new": can create a new arc document
"edit": can edit the record meta of an existing arc document
"move": can move an document to a new project based on arcOn
"remove": can trash or remove documents from database
"newPart": can add a new part/reply to an arc document
"editPart": can edit existing parts/replies of an arc document

If not configured, then users default as follows:

su: "new, edit, move, remove, newPart, editPart" (all permissions)
admin: "new, edit, move, remove, newPart" (no editPart)
op: "" (none)

meta


def	arcWriteAccess
is	str
lib	lib:user
tagOn	user, userProto
uiInput	uiMisc::ArcWriteAccessInput

supertypes


val	Data value type
scalar	Scalar is an atomic value kind
str	Unicode string of characters

defUri

Host relative URI to redirect the user upon login. This URI is used only if the user is logging into root at "/". Typically this tag is configured to a project home page such as "/ui/myProj".

meta


def	defUri
is	uri
lib	lib:user
tagOn	user, userProto

supertypes


val	Data value type
scalar	Scalar is an atomic value kind
uri	Universal resource identifier

defView

The name of the view that should be the default for a user or project. When a user opens a project, this will be the view that loads by default. You can configure project-specific default views by tagging a user with <projName>DefView instead; this will override any defView specified on the user or project. You can also set this tag on the project's uiMeta record and this will be used as the default view for the project if a user doesn't have one configured.

meta


def	defView
is	str
lib	lib:user
tagOn	user, userProto

supertypes


val	Data value type
scalar	Scalar is an atomic value kind
str	Unicode string of characters

def

fileAccess

List of directory Uris that a non-su user has read-write access to. If the path is relative, then the user has access to that path under every mount.

meta


def	fileAccess
is	list
lib	lib:user
of	uri
tagOn	user, userProto

supertypes


val	Data value type
list	Ordered list of zero or more values

def

fileAccessReadOnly

List of directory Uris that a non-su user has read-only access to. If the path is relative, then the user has read access to that path under every mount.

meta


def	fileAccessReadOnly
is	list
lib	lib:user
of	uri
tagOn	user, userProto

supertypes


val	Data value type
list	Ordered list of zero or more values

def

func:userBackup

userBackup()

Asynchronously kick off a new backup for user database. Return a future to track completion of the backup. The future's result value is subject to change.

meta


confirm
def	func:userBackup
disKey	ui::backup
is	func
lib	lib:user
name	userBackup
su	✓

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

func:userBackupCleanup

userBackupCleanup(dateOrAge)

Delete all user database backups older than the given duration or date.

meta


admin	✓
def	func:userBackupCleanup
is	func
lib	lib:user
name	userBackupCleanup

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

func:userBackupDelete

userBackupDelete(ts)

Delete a user database backup file by its timestamp.

meta


admin	✓
confirm
def	func:userBackupDelete
disKey	ui::delete
is	func
lib	lib:user
multi	✓
name	userBackupDelete
select	✓

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

func:userBackups

userBackups()

List all the user database backups

meta


def	func:userBackups
is	func
lib	lib:user
name	userBackups
su	✓

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

func:userCommit

userCommit(diffs)

Commit one or more diffs to the user database. The argument may be one of the following:

result of diff()
list of diff() to commit multiple diffs at once

If one diff is passed, return the new record. If a list of diffs is passed, return a list of new records.

When creating a new user the following tags must be specified:

id - Must be @<username>
user
username - Must match the id.
tz
userRole

If the userAuth tag is not specified, a "dummy" SCRAM configuration will be be generated, but the user will not be able to log in until a password is set. This can be done in Axon using userSetPassword(). Otherwise, you will need to reset their password in the user manager, or if email reset is enabled the user can do it from the login page using the forgot my password feature.

Examples:

// add a new user
userTags: {id:@bach, user, username:"bach", userRole:"op", tz:"New_York"}
newRec: userCommit(diff(null, userTags, {add}))

// update the appAccess tag on all operator users
userReadAll(user and userRole=="op")
  .toRecList
  .map(r => diff(r, {appAccess:"energy,his"}))
  .userCommit

// remove all disabled users
userReadAll(user and disabled)
  .toRecList
  .map(r => diff(r, null, {remove}))
  .userCommit

meta


def	func:userCommit
is	func
lib	lib:user
name	userCommit
su	✓

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

func:userCur

userCur()

Read user rec Dict for current session user

meta


def	func:userCur
is	func
lib	lib:user
name	userCur

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

func:userIsProjAccessible

userIsProjAccessible(user, projName)

Return if the given user has access to the project as configured by projAccessFilter. The user must be a Dict and the projName must be a Str name. Also see User.isProjAccessible. Requires su permission.

meta


def	func:userIsProjAccessible
is	func
lib	lib:user
name	userIsProjAccessible
su	✓

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

func:userLastLogin

userLastLogin(username)

Get information about the last successful login for the user with the given username. The Dict will contains the following tags:

ts: the timestamp of the last login
remoteAddr: the remote IP address the user logged in from
userAgent: the user-agent used to login (if known)

Return null if no login information is found.

meta


def	func:userLastLogin
is	func
lib	lib:user
name	userLastLogin
su	✓

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

func:userMfaStatus

userMfaStatus(userRefs)

Check if MFA is required and if user is enrolled.

Examples:

// check a user MFA status
userMfaStatus(@userId)

userReadAll(<filter>).userMfaStatus

meta


def	func:userMfaStatus
is	func
lib	lib:user
name	userMfaStatus
su	✓

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

func:userMfaTotpReset

userMfaTotpReset(userRefs)

Clear the stored Totp MFA enrollment configuration. This will force the user to re-enroll their authenticator app.

Examples:

// reset a user totp enrollment
userMfaTotpReset(@userId)
userReadById(@userID).userMfaTotpReset

// reset multiple user's totp enrollment
userReadAll(<filter>).userMfaTotpReset

meta


def	func:userMfaTotpReset
is	func
lib	lib:user
name	userMfaTotpReset
su	✓

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

func:userRead

userRead(filterExpr, checked: true)

Read a rec Dict from the user db by filter. If context user is not su, then the user being read must be accessible to the current context project.

meta


admin	✓
def	func:userRead
is	func
lib	lib:user
name	userRead

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

func:userReadAll

userReadAll(filterExpr: null, optsExpr: null)

Read a Grid of recs from the user db by filter. If the context user is not su, then only users with access to the to the current context project are returned.

meta


admin	✓
def	func:userReadAll
is	func
lib	lib:user
name	userReadAll

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

func:userReadById

userReadById(id, checked: true)

Read a rec Dict from the user db by id. If context user is not su, then the user being read must be accessible to the current context project.

meta


admin	✓
def	func:userReadById
is	func
lib	lib:user
name	userReadById

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

func:userSetPassword

userSetPassword(username, password)

Update password of the given user.

meta


def	func:userSetPassword
is	func
lib	lib:user
name	userSetPassword
su	✓

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

notifications

The set of notifications a user is subscribed to

meta


def	notifications
is	list
lib	lib:user
of	str
tagOn	user
uiInput	ui::NotificationsInput

supertypes


val	Data value type
list	Ordered list of zero or more values

def

pointOverrideAccess

Defines levels which may be overridden by the user for writable points. This value is a comma separated string 1, 8, and def. For example to allow writes to level 8 and default then set to "8,def". If not configured, then users default as follows:

su: "1, 8, def"
admin: "8, def"
op: ""

meta


def	pointOverrideAccess
is	str
lib	lib:user
tagOn	user, userProto
uiInput	uiMisc::PointOverrideAccessInput

supertypes


val	Data value type
scalar	Scalar is an atomic value kind
str	Unicode string of characters

def

projAccessFilter

Applied to users to defines access to projects. See Security.

meta


def	projAccessFilter
is	filterStr
lib	lib:user
tagOn	user, userProto
uiInput	ui::ProjAccessFilterInput

supertypes


val	Data value type
scalar	Scalar is an atomic value kind
str	Unicode string of characters
filterStr	Haystack filter string

def

reportCanSave

Enables an operator user to save reports to the database. Admin users always have permission to save reports.

meta


def	reportCanSave
is	marker
lib	lib:user
tagOn	user, userProto

supertypes


marker	Marker labels a dict with typing information

def

siteAccessFilter

Restricts access to sites.

meta


def	siteAccessFilter
is	filterStr
lib	lib:user
tagOn	user, userProto

supertypes


val	Data value type
scalar	Scalar is an atomic value kind
str	Unicode string of characters
filterStr	Haystack filter string

def

topicsEmailDigest

Classic legacy support. Applied to indicate which topics the user is subscribed to for daily digest email delivery. The value must be a comma separated list of topic record ids such as "@a-1,@b-2".

meta


def	topicsEmailDigest
is	str
lib	lib:user
tagOn	user, userProto
uiInput	ui::TopicsEmailInput

supertypes


val	Data value type
scalar	Scalar is an atomic value kind
str	Unicode string of characters

def

topicsEmailImmediate

Classic legacy support. Applied to indicate which topics the user is subscribed to for immediate email delivery. The value must be a comma separated list of topic record ids such as "@a-1,@b-2".

meta


def	topicsEmailImmediate
is	str
lib	lib:user
tagOn	user, userProto
uiInput	ui::TopicsEmailInput

supertypes


val	Data value type
scalar	Scalar is an atomic value kind
str	Unicode string of characters

def

user

User account. Users are managed at the host level in the user database.

meta


def	user
icon	user
is	entity
lib	lib:user
mandatory	✓

supertypes


marker	Marker labels a dict with typing information
entity	Top-level dicts with a unique identifier

def

userAccessFilter

Restricts which users are visible.

meta


def	userAccessFilter
is	filterStr
lib	lib:user
tagOn	user, userProto

supertypes


val	Data value type
scalar	Scalar is an atomic value kind
str	Unicode string of characters
filterStr	Haystack filter string

def

userAllow

List of function names to allow on this user. This tag grants functions marked su or admin to users who would normally not have permission to call those functions.

meta


def	userAllow
is	list
lib	lib:user
of	str
tagOn	user, userProto
uiInput	uiDev::AdminFuncNameListInput

supertypes


val	Data value type
list	Ordered list of zero or more values

def

userAuth

Defines how a user authenticates.

See docSkySpark

meta


def	userAuth
is	dict
lib	lib:user
tagOn	user
uiInput	ui::UserAuthInput

supertypes


val	Data value type
dict	Map of name/value tag pairs

def

userFailedLogins

How many failed login attempts the user has made since last successful login.

meta


def	userFailedLogins
is	number
lib	lib:user
tagOn	user
transient	✓

supertypes


val	Data value type
scalar	Scalar is an atomic value kind
number	Integer or floating point numbers annotated with an optional unit

def

userLockOut

Indicates the user is locked out because of too many failed login attempts. When this tag is present, the user cannot login.

meta


def	userLockOut
is	marker
lib	lib:user
tagOn	user

supertypes


marker	Marker labels a dict with typing information

def

userMfa

Indicates the user requires multifactor authentication and which multifactor authentication method is configured.

meta


def	userMfa
is	dict
lib	lib:user
tagOn	user, userProto
uiInput	ui::UserMfaInput

supertypes


val	Data value type
dict	Map of name/value tag pairs

def

userProto

A user prototype. These tags can be used to organize common tags that should be used across multiple users. The tags will be merged into the user record.

meta


def	userProto
icon	user
is	entity
lib	lib:user
mandatory	✓

supertypes


marker	Marker labels a dict with typing information
entity	Top-level dicts with a unique identifier

def

userProtoName

User prototype name.

meta


def	userProtoName
is	str
lib	lib:user
tagOn	userProto

supertypes


val	Data value type
scalar	Scalar is an atomic value kind
str	Unicode string of characters

def

userProtoRef

User prototype to apply to a user

meta


def	userProtoRef
is	ref
lib	lib:user
of	userProto
tagOn	user

supertypes


val	Data value type
scalar	Scalar is an atomic value kind
ref	Reference to an entity

def

userRef

Reference to user entity

meta


def	userRef
is	ref
lib	lib:user
of	user
tagOn	userCertificate

supertypes


val	Data value type
scalar	Scalar is an atomic value kind
ref	Reference to an entity

def

userRole

Indicates what permissions and access rights the user has. See docSkySpark

meta


def	userRole
enum	See below
is	str
lib	lib:user
tagOn	user, userProto

enum


op	the user is an operator
admin	the user is an administrator
su	the user is a super user

supertypes


val	Data value type
scalar	Scalar is an atomic value kind
str	Unicode string of characters

def

view:userBackups

Execute and manage backups of the local user database

meta


appName	users
def	view:userBackups
disKey	ui::backups
icon	view
is	view
lib	lib:user
order	800
su	✓

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
view	Fresco UI view

src

view:   {inherit:"table"}
backup: {action:"userBackup"}
delete: {action:"userBackupDelete"}
data:   {expr:"userBackups()"}

def

view:userPrefs

Manage preferences for the current user

meta


def	view:userPrefs
disKey	ui::preferences
icon	view
is	view
lib	lib:user

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
view	Fresco UI view

src

view:   {inherit:"form"}
submit: {action:"userPrefsFormSave" refresh}
reset:  {action:"userPrefsFormReset" refresh confirm:{icon:"warn" disKey:"ui::userPrefsResetConfirm" detailsKey:"ui::userPrefsResetConfirmDetails"} }
data:   {expr:"userPrefsFormLoad()"}

def

view:userProtos

Manage user prototypes in the local user database

meta


appName	users
def	view:userProtos
defName	userProto
disKey	ui::protos
icon	view
is	view
lib	lib:user
order	120
su	✓

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
view	Fresco UI view

src

view:     {inherit:"table"}
search:   {input var kind:"Str" defVal:""}
new:      {action:"userProtoNew"}
edit:     {action:"userProtoEdit" select multi}
dup:      {action:"userProtoDup"}
delete:   {action:"userProtoDelete"}
data:     {expr:"userProtoReadAll(userProto, { search:{{search}} })"}

def

view:userSettings

Settings for the user system module

meta


appName	settings
def	view:userSettings
disKey	ui::user
icon	view
is	view
lib	lib:user
su	✓

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
view	Fresco UI view

src

view:   {inherit:"form"}
submit: {action:"hostCommit"}
data:   {expr:"hostSettings(\"user\")"}

def

view:users

Manage the local user database

meta


appName	users
def	view:users
defName	user
disKey	ui::users
icon	view
is	view
lib	lib:user
order	100
su	✓

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
view	Fresco UI view

src

view:       {inherit:"table"}
search:     {input var kind:"Str" defVal:""}
new:        {action:"userNew" onCommit:"uiMisc::UserWizard.onCommit"}
edit:       {action:"userEdit" select multi onCommit:"uiMisc::UserWizard.onCommit"}
reset:      {disKey:"ui::resetPass" action:"uiMisc::UserWizard.openReset" select}
forceReset: {action:"userForceReset" disKey:"ui::forceResetPass" select multi}
unlock:     {action:"userUnlock" disKey:"ui::unlock" select multi}
delete:     {action:"userDelete"}
apply:      {action:"userEffective"}
activity:   {action:"userActivity"}
data:       {expr:"userReadAll(user, { search:{{search}} })"}

lib-user 库参考 ​

目录（导读） ​

概述（中译） ​

API 正文（英文） ​

funcs ​

views ​

appAccess ​

arcAccessFilter ​

arcUnassignable ​

arcWriteAccess ​

defUri ​

defView ​

fileAccess ​

fileAccessReadOnly ​

func:userBackup ​

userBackup() ​

func:userBackupCleanup ​

userBackupCleanup(dateOrAge) ​

func:userBackupDelete ​

userBackupDelete(ts) ​

func:userBackups ​

userBackups() ​

func:userCommit ​

userCommit(diffs) ​

func:userCur ​

userCur() ​

func:userIsProjAccessible ​

userIsProjAccessible(user, projName) ​

func:userLastLogin ​

userLastLogin(username) ​

func:userMfaStatus ​

userMfaStatus(userRefs) ​

func:userMfaTotpReset ​

userMfaTotpReset(userRefs) ​

func:userRead ​

userRead(filterExpr, checked: true) ​

func:userReadAll ​

userReadAll(filterExpr: null, optsExpr: null) ​

func:userReadById ​

userReadById(id, checked: true) ​

func:userSetPassword ​

userSetPassword(username, password) ​

notifications ​

pointOverrideAccess ​

projAccessFilter ​

reportCanSave ​

siteAccessFilter ​

topicsEmailDigest ​

topicsEmailImmediate ​

user ​

`lib-user` 库参考

目录（导读）

概述（中译）

API 正文（英文）

funcs

views

appAccess

arcAccessFilter

arcUnassignable

arcWriteAccess

defUri

defView

fileAccess

fileAccessReadOnly

func:userBackup

userBackup()

func:userBackupCleanup

userBackupCleanup(dateOrAge)

func:userBackupDelete

userBackupDelete(ts)

func:userBackups

userBackups()

func:userCommit

userCommit(diffs)

func:userCur

userCur()

func:userIsProjAccessible

userIsProjAccessible(user, projName)

func:userLastLogin

userLastLogin(username)

func:userMfaStatus

userMfaStatus(userRefs)

func:userMfaTotpReset

userMfaTotpReset(userRefs)

func:userRead

userRead(filterExpr, checked: true)

func:userReadAll

userReadAll(filterExpr: null, optsExpr: null)

func:userReadById

userReadById(id, checked: true)

func:userSetPassword

userSetPassword(username, password)

notifications

pointOverrideAccess

projAccessFilter

reportCanSave

siteAccessFilter

topicsEmailDigest

topicsEmailImmediate

user