Skip to content

Add the user deactivation state in the admin API #4603

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 2, 2025
Merged

Add the user deactivation state in the admin API #4603

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions crates/handlers/src/admin/model.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,9 @@ pub struct User {
/// When the user was locked. If null, the user is not locked.
locked_at: Option<DateTime<Utc>>,

/// When the user was deactivated. If null, the user is not deactivated.
deactivated_at: Option<DateTime<Utc>>,

/// Whether the user can request admin privileges.
admin: bool,
}
Expand All @@ -60,20 +63,23 @@ impl User {
username: "alice".to_owned(),
created_at: DateTime::default(),
locked_at: None,
deactivated_at: None,
admin: false,
},
Self {
id: Ulid::from_bytes([0x02; 16]),
username: "bob".to_owned(),
created_at: DateTime::default(),
locked_at: None,
deactivated_at: None,
admin: true,
},
Self {
id: Ulid::from_bytes([0x03; 16]),
username: "charlie".to_owned(),
created_at: DateTime::default(),
locked_at: Some(DateTime::default()),
deactivated_at: None,
admin: false,
},
]
Expand All @@ -87,6 +93,7 @@ impl From<mas_data_model::User> for User {
username: user.username,
created_at: user.created_at,
locked_at: user.locked_at,
deactivated_at: user.deactivated_at,
admin: user.can_request_admin,
}
}
Expand Down
7 changes: 6 additions & 1 deletion crates/handlers/src/admin/v1/users/list.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,15 @@ use crate::{
enum UserStatus {
Active,
Locked,
Deactivated,
}

impl std::fmt::Display for UserStatus {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
Self::Active => write!(f, "active"),
Self::Locked => write!(f, "locked"),
Self::Deactivated => write!(f, "deactivated"),
}
}
}
Expand All @@ -58,7 +60,9 @@ pub struct FilterParams {
///
/// * `active`: Only retrieve active users
///
/// * `locked`: Only retrieve locked users
/// * `locked`: Only retrieve locked users (includes deactivated users)
///
/// * `deactivated`: Only retrieve deactivated users
#[serde(rename = "filter[status]")]
status: Option<UserStatus>,
}
Expand Down Expand Up @@ -142,6 +146,7 @@ pub async fn handler(
let filter = match params.status {
Some(UserStatus::Active) => filter.active_only(),
Some(UserStatus::Locked) => filter.locked_only(),
Some(UserStatus::Deactivated) => filter.deactivated_only(),
None => filter,
};

Expand Down
25 changes: 21 additions & 4 deletions docs/api/spec.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -873,9 +873,9 @@
{
"in": "query",
"name": "filter[status]",
"description": "Retrieve the items with the given status\n\nDefaults to retrieve all users, including locked ones.\n\n* `active`: Only retrieve active users\n\n* `locked`: Only retrieve locked users",
"description": "Retrieve the items with the given status\n\nDefaults to retrieve all users, including locked ones.\n\n* `active`: Only retrieve active users\n\n* `locked`: Only retrieve locked users (includes deactivated users)\n\n* `deactivated`: Only retrieve deactivated users",
"schema": {
"description": "Retrieve the items with the given status\n\nDefaults to retrieve all users, including locked ones.\n\n* `active`: Only retrieve active users\n\n* `locked`: Only retrieve locked users",
"description": "Retrieve the items with the given status\n\nDefaults to retrieve all users, including locked ones.\n\n* `active`: Only retrieve active users\n\n* `locked`: Only retrieve locked users (includes deactivated users)\n\n* `deactivated`: Only retrieve deactivated users",
"$ref": "#/components/schemas/UserStatus",
"nullable": true
},
Expand All @@ -902,6 +902,7 @@
"username": "alice",
"created_at": "1970-01-01T00:00:00Z",
"locked_at": null,
"deactivated_at": null,
"admin": false
},
"links": {
Expand All @@ -915,6 +916,7 @@
"username": "bob",
"created_at": "1970-01-01T00:00:00Z",
"locked_at": null,
"deactivated_at": null,
"admin": true
},
"links": {
Expand All @@ -928,6 +930,7 @@
"username": "charlie",
"created_at": "1970-01-01T00:00:00Z",
"locked_at": "1970-01-01T00:00:00Z",
"deactivated_at": null,
"admin": false
},
"links": {
Expand Down Expand Up @@ -979,6 +982,7 @@
"username": "alice",
"created_at": "1970-01-01T00:00:00Z",
"locked_at": null,
"deactivated_at": null,
"admin": false
},
"links": {
Expand Down Expand Up @@ -1064,6 +1068,7 @@
"username": "alice",
"created_at": "1970-01-01T00:00:00Z",
"locked_at": null,
"deactivated_at": null,
"admin": false
},
"links": {
Expand Down Expand Up @@ -1220,6 +1225,7 @@
"username": "alice",
"created_at": "1970-01-01T00:00:00Z",
"locked_at": null,
"deactivated_at": null,
"admin": false
},
"links": {
Expand Down Expand Up @@ -1299,6 +1305,7 @@
"username": "bob",
"created_at": "1970-01-01T00:00:00Z",
"locked_at": null,
"deactivated_at": null,
"admin": true
},
"links": {
Expand Down Expand Up @@ -1368,6 +1375,7 @@
"username": "charlie",
"created_at": "1970-01-01T00:00:00Z",
"locked_at": "1970-01-01T00:00:00Z",
"deactivated_at": null,
"admin": false
},
"links": {
Expand Down Expand Up @@ -1437,6 +1445,7 @@
"username": "charlie",
"created_at": "1970-01-01T00:00:00Z",
"locked_at": "1970-01-01T00:00:00Z",
"deactivated_at": null,
"admin": false
},
"links": {
Expand Down Expand Up @@ -1505,6 +1514,7 @@
"username": "alice",
"created_at": "1970-01-01T00:00:00Z",
"locked_at": null,
"deactivated_at": null,
"admin": false
},
"links": {
Expand Down Expand Up @@ -3132,7 +3142,7 @@
"nullable": true
},
"filter[status]": {
"description": "Retrieve the items with the given status\n\nDefaults to retrieve all users, including locked ones.\n\n* `active`: Only retrieve active users\n\n* `locked`: Only retrieve locked users",
"description": "Retrieve the items with the given status\n\nDefaults to retrieve all users, including locked ones.\n\n* `active`: Only retrieve active users\n\n* `locked`: Only retrieve locked users (includes deactivated users)\n\n* `deactivated`: Only retrieve deactivated users",
"$ref": "#/components/schemas/UserStatus",
"nullable": true
}
Expand All @@ -3142,7 +3152,8 @@
"type": "string",
"enum": [
"active",
"locked"
"locked",
"deactivated"
]
},
"PaginatedResponse_for_User": {
Expand Down Expand Up @@ -3223,6 +3234,12 @@
"format": "date-time",
"nullable": true
},
"deactivated_at": {
"description": "When the user was deactivated. If null, the user is not deactivated.",
"type": "string",
"format": "date-time",
"nullable": true
},
"admin": {
"description": "Whether the user can request admin privileges.",
"type": "boolean"
Expand Down
Loading