Skip to content

Fix Rocket.Chat API "users" endpoint #1031

@ear-dev

Description

@ear-dev

The users endpoint in the RC REST API is poorly designed and impossible to work with in automation contexts.

https://developer.rocket.chat/reference/api/rest-api/endpoints/team-collaboration-endpoints/users-endpoints

The current design includes things like: 'users.create', 'users.delete', 'users.get_info'....... for example. i.e. a unique endpoint for every action you would like to perform on a user resource.

We need an API that has a single endpoint for users, where we can POST, GET, DELETE etc.... based on the "_id".

for example, a delete should be a DELETE against /api/v1/users/"_id"

We can just start with a couple of things:

  • GET /users - return a list of all users
  • GET /users/{_id} - return the specific users info
  • POST /users - create a new user [EXTENSION]: we would like to be able to set the user "status":"online" at creation time.
  • DELETE /users/{_id} - delete the specified user.

Create an openAPI spect that represents the new endpoint

Metadata

Metadata

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions