Skip to content

Users API #195

@mfriesen

Description

@mfriesen

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions