Users
This chapter focuses on additional services for the users. These services extend driven-by-id methods implemented in the Rest Services API by allowing search by User login.
Get all users
A GET
to /users
returns all the users.
HTTP request
Snippet http-request not found for operation::RestAdminUserControllerIT/browse-users
Request parameters
Snippet request-parameters not found for operation::RestAdminUserControllerIT/browse-users
HTTP response
Snippet http-response not found for operation::RestAdminUserControllerIT/browse-users
Response fields
Snippet response-fields not found for operation::RestAdminUserControllerIT/browse-users
Links
Snippet links not found for operation::RestAdminUserControllerIT/browse-users
Get user
A GET
to /users/login/{login}
returns the user with the given login.
Path parameters
Snippet path-parameters not found for operation::RestAdminUserControllerIT/get-user
HTTP request
Snippet http-request not found for operation::RestAdminUserControllerIT/get-user
Request parameters
Snippet request-parameters not found for operation::RestAdminUserControllerIT/get-user
HTTP response
Snippet http-response not found for operation::RestAdminUserControllerIT/get-user
Response fields
Snippet response-fields not found for operation::RestAdminUserControllerIT/get-user
Links
Snippet links not found for operation::RestAdminUserControllerIT/get-user
Create user
A POST
to /users
creates a new user.
HTTP request
Snippet http-request not found for operation::RestAdminUserControllerIT/post-user
Request fields
Snippet request-fields not found for operation::RestAdminUserControllerIT/post-user
Request parameters
Snippet request-parameters not found for operation::RestAdminUserControllerIT/post-user
HTTP response
Snippet http-response not found for operation::RestAdminUserControllerIT/post-user
Response fields
Snippet response-fields not found for operation::RestAdminUserControllerIT/post-user
Links
Snippet links not found for operation::RestAdminUserControllerIT/post-user
Modify user
A PATCH
to /users/{id}
modifies the user with the given id.
Path parameters
Snippet path-parameters not found for operation::RestAdminUserControllerIT/patch-user
HTTP request
Snippet http-request not found for operation::RestAdminUserControllerIT/patch-user
Request fields
Snippet request-fields not found for operation::RestAdminUserControllerIT/patch-user
Request parameters
Snippet request-parameters not found for operation::RestAdminUserControllerIT/patch-user
HTTP response
Snippet http-response not found for operation::RestAdminUserControllerIT/patch-user
Response fields
Snippet response-fields not found for operation::RestAdminUserControllerIT/patch-user
Links
Snippet links not found for operation::RestAdminUserControllerIT/patch-user
Delete user
A DELETE
to /users/{ids}
deletes one or several user(s) with the given id(s).
Path parameters
Snippet path-parameters not found for operation::RestAdminUserControllerIT/delete-user
HTTP request
Snippet http-request not found for operation::RestAdminUserControllerIT/delete-user
Get user subscribed teams
A GET
to /users/login/{login}/teams
returns all the subscribed teams of the user with the given login.
Path parameters
Snippet path-parameters not found for operation::RestAdminUserControllerIT/get-teams
HTTP request
Snippet http-request not found for operation::RestAdminUserControllerIT/get-teams
Request parameters
Snippet request-parameters not found for operation::RestAdminUserControllerIT/get-teams
HTTP response
Snippet http-response not found for operation::RestAdminUserControllerIT/get-teams
Response fields
Snippet response-fields not found for operation::RestAdminUserControllerIT/get-teams
Links
Snippet links not found for operation::RestAdminUserControllerIT/get-teams
Subscribe to teams
A POST
to /users/login/{login}/teams
with teamNames in request parameters subscribes the user with the given login to these teams.
Path parameters
Snippet path-parameters not found for operation::RestAdminUserControllerIT/add-teams
HTTP request
Snippet http-request not found for operation::RestAdminUserControllerIT/add-teams
Request parameters
Snippet request-parameters not found for operation::RestAdminUserControllerIT/add-teams
Unsubscribe from teams
A DELETE
to /users/login/{loginId}/teams
with teamNames in request parameters unsubscribes the user with the given login from these teams.
Path parameters
Snippet path-parameters not found for operation::RestAdminUserControllerIT/disassociate-teams
HTTP request
Snippet http-request not found for operation::RestAdminUserControllerIT/disassociate-teams
Request parameters
Snippet request-parameters not found for operation::RestAdminUserControllerIT/disassociate-teams