$user
Updated on Aug 19, 2025 4 minutes to readr Plugin** provides methods to manage application users, their roles, permissions, and personal profiles.
Methods
| Method | Description |
|---|---|
| can | Checks if a user has a specific permission. |
| create | Creates a new user account. |
| findById | Finds a user by ID. |
| update | Updates an existing user. |
| delete | Deletes a user by ID. |
| assignRoles | Assigns roles to a user. |
| revokeRoles | Revokes specific roles from a user. |
| revokeAllRoles | Revokes all roles from a user. |
| getAllRoles | Retrieves all roles assigned to a user. |
| block | Blocks a user account. |
| unblock | Unblocks a user account. |
| getProfile | Retrieves a user's profile information. |
| updateProfile | Updates a user's profile information. |
Methods Details
can()
• Type
(
id: string,
scriptAlias: E8ScriptAlias,
permission: string
) => boolean• Details
Expects a user ID, a script alias, and a permission string.
Returns true if the user has the specified permission, otherwise false.
create()
• Type
(
id: string,
scriptAlias: E8ScriptAlias,
permission: string
) => boolean• Details
Expects UserData
and optional UserParams (default: {sendWelcomeMessage: true, generateAccessToken: false}).
Returns the created User or false if creation failed.
findById()
• Type
(id: string) => User | false• Details
Expects a user ID.
Returns the User or false if not found.
update()
• Type
(
id: string,
data: UserData,
params?: UserParams
) => User | false• Details
Expects a user ID,
UserData,
and optional UserParams (default: {sendWelcomeMessage: false, generateAccessToken: false}).
Returns the updated User or false if update failed.
delete()
• Type
(id: string) => boolean• Details
Expects a user ID.
Returns true if deletion was successful, otherwise false.
assignRoles()
• Type
(id: string, roles: string[]) => boolean• Details
Expects a user ID and an array of role names.
Returns true if roles were successfully assigned, otherwise false.
revokeRoles()
• Type
(id: string, roles: string[]) => boolean• Details
Expects a user ID and an array of role names.
Returns true if roles were successfully revoked, otherwise false.
revokeAllRoles()
• Type
(id: string) => boolean• Details
Expects a user ID.
Returns true if all roles were revoked, otherwise false.
getAllRoles()
• Type
(id: string) => string[]• Details
Expects a user ID.
Returns an array of role names assigned to the user.
block()
• Type
(id: string) => boolean• Details
Expects a user ID.
Returns true if the account was successfully blocked, otherwise false.
unblock()
• Type
(id: string) => boolean• Details
Expects a user ID.
Returns true if the account was successfully unblocked, otherwise false.
getProfile()
• Type
(id: string) => Profile | false• Details
Expects a user ID.
Returns the Profile of the user or false if not found.
updateProfile()
• Type
(id: string, data: ProfileData) => Profile | false• Details
Expects a user ID and ProfileData.
Returns the updated profile or false if update failed.