Skip to main content

Module offboarding

Module offboarding 

Source
Expand description

What a user still holds (issue #173, step 1): the report an administrator or a group manager reads before somebody leaves – check-outs, change orders they wrote that are still open, pending reviews, change requests assigned to or raised by them, items they own, their memberships (and the groups in which they are the only active manager) and their API tokens.

The report is filtered by the viewer’s rights, never the leaver’s: a lock in a group the leaver was removed from is still listed, which is the lock nobody else would find. Administrators see every group they may read; for a group that hides its content from them (need-to-know policy) only the number of check-outs per group. A manager who is no administrator sees what lies in the groups they manage, and no tokens.

Read-only; every list is bounded by MAX_LIST with the full count next to it.

Structs§

GroupCount
Check-outs in a group whose content the viewer may not read: the count.
HeldChange
A change order (authored and still open, or waiting for the user’s review).
HeldItem
An item the user owns.
HeldMembership
A membership of the user.
HeldRequest
A change request assigned to or raised by the user.
HeldRevision
A revision the user has checked out.
Holdings
Everything the viewer may know about what a user still holds.
IdleSsoUser
An active single sign-on user who stopped signing in but still holds something (issue #173, step 9): typically removed at the identity provider and never offboarded in TeamCraft.
Listed
A bounded list with the number of entries there are in all.

Constants§

IDLE_SSO_DAYS
Single sign-on users without activity for this many days are reported by idle_sso_users (the stale threshold of the access review).
MAX_LIST
Most entries of one kind in a report.

Functions§

holdings
The holdings of a user as actor may see them.
idle_sso_users
Active single sign-on users without a sign-in or token use for IDLE_SSO_DAYS who still hold memberships, tokens or check-outs – candidates for Offboard and deactivate. Bounded by MAX_LIST.
to_text
The report as plain text lines (the teamcraft user holdings command).