File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 1+ ## authctl
2+
3+ CLI tool to interact with authd
4+
5+ ### Synopsis
6+
7+ authctl is a command-line tool to interact with the authd service for user and group management.
8+
9+ ```
10+ authctl [flags]
11+ ```
12+
13+ ### Options
14+
15+ ```
16+ -h, --help help for authctl
17+ ```
18+
19+ ### SEE ALSO
20+
21+ * [ authctl group] ( authctl_group.md ) - Commands related to groups
22+ * [ authctl user] ( authctl_user.md ) - Commands related to users
23+
Original file line number Diff line number Diff line change 1+ ## authctl group
2+
3+ Commands related to groups
4+
5+ ```
6+ authctl group [flags]
7+ ```
8+
9+ ### Options
10+
11+ ```
12+ -h, --help help for group
13+ ```
14+
15+ ### SEE ALSO
16+
17+ * [ authctl] ( authctl.md ) - CLI tool to interact with authd
18+ * [ authctl group set-gid] ( authctl_group_set-gid.md ) - Set the GID of a group managed by authd
19+
Original file line number Diff line number Diff line change 1+ ## authctl group set-gid
2+
3+ Set the GID of a group managed by authd
4+
5+ ### Synopsis
6+
7+ Set the GID of a group managed by authd to the specified value.
8+
9+ The new GID must be unique and non-negative. The command must be run as root.
10+
11+ When a group's GID is changed, any users whose primary group is set to this
12+ group will have the GID of their primary group updated. The home directories of
13+ these users, and any files within these directories that are owned by the group,
14+ will be updated to the new GID.
15+
16+ Files outside users' home directories are not updated and must be changed
17+ manually. Note that changing a GID can be unsafe if files on the system are
18+ still owned by the original GID: those files may become accessible to a
19+ different group that is later assigned that GID. To change group ownership of
20+ all files on the system from the old GID to the new GID, run:
21+
22+ sudo chown -R --from :OLD_GID :NEW_GID /
23+
24+
25+
26+ ```
27+ authctl group set-gid <name> <gid> [flags]
28+ ```
29+
30+ ### Examples
31+
32+ ```
33+ # Set the GID of group "staff" to 30000
34+ authctl group set-gid staff 30000
35+ ```
36+
37+ ### Options
38+
39+ ```
40+ -h, --help help for set-gid
41+ ```
42+
43+ ### SEE ALSO
44+
45+ * [ authctl group] ( authctl_group.md ) - Commands related to groups
46+
Original file line number Diff line number Diff line change 1+ ## authctl user
2+
3+ Commands related to users
4+
5+ ```
6+ authctl user [flags]
7+ ```
8+
9+ ### Options
10+
11+ ```
12+ -h, --help help for user
13+ ```
14+
15+ ### SEE ALSO
16+
17+ * [ authctl] ( authctl.md ) - CLI tool to interact with authd
18+ * [ authctl user lock] ( authctl_user_lock.md ) - Lock (disable) a user managed by authd
19+ * [ authctl user set-uid] ( authctl_user_set-uid.md ) - Set the UID of a user managed by authd
20+ * [ authctl user unlock] ( authctl_user_unlock.md ) - Unlock (enable) a user managed by authd
21+
Original file line number Diff line number Diff line change 1+ ## authctl user lock
2+
3+ Lock (disable) a user managed by authd
4+
5+ ### Synopsis
6+
7+ Lock a user so that they cannot log in.
8+
9+ ```
10+ authctl user lock <user> [flags]
11+ ```
12+
13+ ### Options
14+
15+ ```
16+ -h, --help help for lock
17+ ```
18+
19+ ### SEE ALSO
20+
21+ * [ authctl user] ( authctl_user.md ) - Commands related to users
22+
Original file line number Diff line number Diff line change 1+ ## authctl user set-uid
2+
3+ Set the UID of a user managed by authd
4+
5+ ### Synopsis
6+
7+ Set the UID of a user managed by authd to the specified value.
8+
9+ The new UID must be unique and non-negative. The command must be run as root.
10+
11+ The ownership of the user's home directory, and any files within the directory
12+ that the user owns, will automatically be updated to the new UID.
13+
14+ Files outside the user's home directory are not updated and must be changed
15+ manually. Note that changing a UID can be unsafe if files on the system are
16+ still owned by the original UID: those files may become accessible to a different
17+ account that is later assigned that UID. To change ownership of all files on the
18+ system from the old UID to the new UID, run:
19+
20+ sudo chown -R --from OLD_UID NEW_UID /
21+
22+
23+ ```
24+ authctl user set-uid <name> <uid> [flags]
25+ ```
26+
27+ ### Examples
28+
29+ ```
30+ # Set the UID of user "alice" to 15000
31+ authctl user set-uid alice 15000
32+ ```
33+
34+ ### Options
35+
36+ ```
37+ -h, --help help for set-uid
38+ ```
39+
40+ ### SEE ALSO
41+
42+ * [ authctl user] ( authctl_user.md ) - Commands related to users
43+
Original file line number Diff line number Diff line change 1+ ## authctl user unlock
2+
3+ Unlock (enable) a user managed by authd
4+
5+ ### Synopsis
6+
7+ Unlock a locked user so that they can log in again.
8+
9+ ```
10+ authctl user unlock <user> [flags]
11+ ```
12+
13+ ### Options
14+
15+ ```
16+ -h, --help help for unlock
17+ ```
18+
19+ ### SEE ALSO
20+
21+ * [ authctl user] ( authctl_user.md ) - Commands related to users
22+
You can’t perform that action at this time.
0 commit comments