Skip to content
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.

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

Users API #195

Open
mfriesen opened this issue Nov 26, 2023 · 0 comments
Open

Users API #195

mfriesen opened this issue Nov 26, 2023 · 0 comments
Milestone

Comments

@mfriesen
Copy link
Member

mfriesen commented Nov 26, 2023

NOTE: only admins can use the POST/PATCH/PUT/DELETE, all users have access to GET

GET /users -> enabled is a boolean, status is the confirmationStatus
POST /users
GET /users/{username}/groups
PATCH /users/{username} -> used to update email or other user attributes, EXCLUDING groups
PUT /users/{username}/enabled -> body { "enabled": "true|false" } -> this is user enabled status, which is not the same as confirmation status, though both maybe sometimes be referred to as "user status"
DELETE /users/{username}
POST /groups -> creates a new group
POST /groups/users -> adds a user to a group
DELETE /groups/users/{username} -> delete user from group
DELETE /groups/{groupName}

Optional endpoints (good for users, more time to implement):
PUT /users/{username}/groups -> used to replace groups
GET /users/{username} -> I don't see a need for this one, unless people start actively using user attributes, so maybe a future enhancement

Future:
PUT /users/{username}/status -> body { "status": "CONFIRMED|RESET_PASSWORD|etc." } -> this is confirmation status, which will not be modifiable at this time

@mfriesen mfriesen added this to the v1.14.0 milestone Nov 26, 2023
@mfriesen mfriesen modified the milestones: v1.14.0, v1.15.0 Apr 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant