You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/api/cli-commands.md
+23-1Lines changed: 23 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,7 @@
2
2
sidebar_position: 3
3
3
---
4
4
# CLI commands
5
+
5
6
:::tip Instance notice
6
7
7
8
Please note that in order to use CLI commands, you will need **SSH Access to the server as well as an Astrakit admin acount on your Instance** and when prompted, you will need to **log in using your account data such as email, pasword and 2FA token**
@@ -25,6 +26,7 @@ You can access a variety of commands using the Admin-CLI that's provided with th
25
26
## Authentication
26
27
27
28
The Admin CLI requires secure authentication with:
29
+
28
30
- Admin email address
29
31
- Account password
30
32
- 2FA code from authenticator app
@@ -40,6 +42,7 @@ user find <username/email/uuid>
40
42
```
41
43
42
44
Displays detailed information about a specific user, including:
45
+
43
46
- UUID, username, email address
44
47
- Account status and creation date
45
48
- Last seen timestamp
@@ -56,6 +59,7 @@ user list [limit] [offset]
56
59
```
57
60
58
61
Lists users in the system with pagination:
62
+
59
63
-`limit`: Maximum number of users to display (default: 10)
60
64
-`offset`: Number of users to skip (default: 0)
61
65
@@ -70,6 +74,7 @@ delete <username/email/uuid>
70
74
```
71
75
72
76
Permanently deletes a user account. This:
77
+
73
78
- Removes the account from the database
74
79
- Deletes all user sessions
75
80
- Removes user files from storage
@@ -82,12 +87,15 @@ Permanently deletes a user account. This:
82
87
```
83
88
block <username/email/uuid>
84
89
```
90
+
85
91
or
92
+
86
93
```
87
94
ban <username/email/uuid>
88
95
```
89
96
90
97
Bans a user from the platform. This:
98
+
91
99
- Sets their account status to "banned"
92
100
- Invalidates all active sessions
93
101
- Prevents future logins
@@ -98,12 +106,15 @@ Bans a user from the platform. This:
98
106
```
99
107
unblock <username/email/uuid>
100
108
```
109
+
101
110
or
111
+
102
112
```
103
113
unban <username/email/uuid>
104
114
```
105
115
106
116
Unbans a previously banned user. This:
117
+
107
118
- Sets their account status back to "active"
108
119
- Allows them to log in again
109
120
- Sends notification email to the user
@@ -117,6 +128,7 @@ admin grant <username/email/uuid>
0 commit comments