Freeipa/user
@shrug/freeipa/userv2026.07.11.2
01README
Manage FreeIPA users over the JSON-RPC API: find/show read-only snapshots plus add/mod/del/setEnabled writes and a desired-state sync reconcile, each with an audit trail and a confirm-guarded delete. add/del take an optional idempotent flag.
02Models
@shrug/freeipa/userv2026.07.11.2user.ts
fn find()
Snapshot users matching an optional search criteria (read-only).
fn show(uid: string)
Snapshot a single user by uid (read-only).
| Argument | Type | Description |
|---|---|---|
| uid | string | User login (uid) to fetch |
fn add(uid: string, givenName: string, sn: string)
Create a user (user_add). Writes the created user state on success; audits both paths.
| Argument | Type | Description |
|---|---|---|
| uid | string | User login (uid) |
| givenName | string | First name (IPA `givenname`) |
| sn | string | Surname (IPA `sn`) |
fn mod(uid: string)
Modify a user (user_mod). Writes the updated user state on success; audits both paths.
| Argument | Type | Description |
|---|---|---|
| uid | string | User login (uid) to modify |
fn del(uid: string)
Delete or preserve a user (user_del). Requires confirm:true; audits both paths.
| Argument | Type | Description |
|---|---|---|
| uid | string | User login (uid) to delete |
fn setEnabled(uid: string)
Enable or disable a user (user_enable / user_disable). Writes the updated user state on success; audits both paths.
| Argument | Type | Description |
|---|---|---|
| uid | string | User login (uid) |
fn sync(uid: string, givenName: string, sn: string)
Reconcile a user to a desired spec: create it if absent (user_add), otherwise user_mod only the drifted attributes (givenName/sn/cn/mail + extra options) and user_enable/user_disable to match. Idempotent — a converged user issues no IPA writes. Group membership is out of scope (see @shrug/freeipa/group). Writes the converged user state on success; audits both paths, and the audit response lists the `changes` made.
| Argument | Type | Description |
|---|---|---|
| uid | string | User login (uid) to reconcile |
| givenName | string | Desired first name (IPA `givenname`) |
| sn | string | Desired surname (IPA `sn`) |
Resources
users(infinite)— Snapshot of users matching a find (array of parsed rows)
user(infinite)— Snapshot of a single user (parsed row + raw entry)
attempt(infinite)— Audit record of a mutation attempt (request + result/error + timestamp). Written on both success and failure.
03Previous Versions
2026.07.11.1Jul 11, 2026
2026.07.10.1Jul 11, 2026
04Stats
A
100 / 100
Downloads
0
Archive size
21.8 KB
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
Repository
https://github.com/shrugpw/swamp-freeipa05Platforms
06Labels