Web API for User Management - Revision history

Ollvihe at 12:54, 6 April 2025

2025-04-06T12:54:56Z

← Older revision		Revision as of 12:54, 6 April 2025
Line 61:		Line 61:
	</pre>		</pre>
	Updates an existing ''user/group''. Takes a user/group object in the body. Note that the ''isGroup'' property is ignored, because users cannot be changed to groups and vice versa.		Updates an existing ''user/group''. Takes a user/group object in the body. Note that the ''isGroup'' property is ignored, because users cannot be changed to groups and vice versa.

			<pre>
			DELETE api/users/{id}
			</pre>
			Deletes a group permanently, including is memberships and roles (both project and global). Only groups can be deleted, but not users.

	=== Group memberships ===		=== Group memberships ===

Ollvihe at 19:30, 11 December 2021

2021-12-11T19:30:59Z

← Older revision		Revision as of 19:30, 11 December 2021
Line 1:		Line 1:
	This page describes Web API operations for managing users, groups, roles and permissions. See [[~~Roles_and_Permissions_in_QPR_ProcessAnalyzer~~\|more information]] how roles and permissions work in QPR ProcessAnalyzer.		This page describes Web API operations for managing users, groups, roles and permissions. See [[Roles_and_Permissions\|more information]] how roles and permissions work in QPR ProcessAnalyzer.

	== Entities ==		== Entities ==

Ollvihe at 16:42, 1 November 2020

2020-11-01T16:42:22Z

← Older revision		Revision as of 16:42, 1 November 2020
Line 98:		Line 98:
	</pre>		</pre>
	Gets a list of all roles in the system. Returns an array of ''role'' objects.		Gets a list of all roles in the system. Returns an array of ''role'' objects.

			[[Category: QPR ProcessAnalyzer]]

Ollvihe: /* Group memberships */

2020-09-20T15:10:53Z

Group memberships

← Older revision		Revision as of 15:10, 20 September 2020
Line 66:		Line 66:
	GET api/users/memberships/{id}		GET api/users/memberships/{id}
	</pre>		</pre>
	Gets a list of ''memberships'' of the user/group with given id. Returns an array of membership objects, which can be empty if user/group is not a member of any group.		Gets a list of ''memberships'' of the user/group with given id. For a user, the method returns in which groups the user belongs to, and for a group the method returns users belonging to the group. Returns an array of membership objects, which can be empty if user/group is not a member of any group.

	<pre>		<pre>

Ollvihe: /* Methods */

2020-09-20T15:09:38Z

Methods

← Older revision		Revision as of 15:09, 20 September 2020
Line 39:		Line 39:
	* In requests, there needs to be a header ''Authorization'' for authentication containing syntax ''Bearer <access token>''.		* In requests, there needs to be a header ''Authorization'' for authentication containing syntax ''Bearer <access token>''.

			=== User and group entities ===
	<pre>		<pre>
	GET api/users		GET api/users
Line 62:		Line 62:
	Updates an existing ''user/group''. Takes a user/group object in the body. Note that the ''isGroup'' property is ignored, because users cannot be changed to groups and vice versa.		Updates an existing ''user/group''. Takes a user/group object in the body. Note that the ''isGroup'' property is ignored, because users cannot be changed to groups and vice versa.

			=== Group memberships ===
	<pre>		<pre>
	GET api/users/~~roleassignments~~/{id}		GET api/users/memberships/{id}
	</pre>		</pre>
	Gets a list of ''~~role assignments~~'' of a user/group with ~~the~~ given id. Returns an array of ~~role assignment~~ objects.		Gets a list of ''memberships'' of the user/group with given id. Returns an array of membership objects, which can be empty if user/group is not a member of any group.

	<pre>		<pre>
	PUT api/users/~~roleassignments~~		PUT api/users/memberships
	</pre>		</pre>
	Adds a ''~~role assignment~~''. Takes a ~~role assignment~~ object in the body.		Adds a ''membership''. Takes a membership object in the body.

	<pre>		<pre>
	DELETE api/users/~~roleassignments~~		DELETE api/users/memberships
	</pre>		</pre>
	Deletes a ''~~role assignment~~''. Takes a ~~role assignment~~ object in the body.		Deletes a ''membership''. Takes a membership object in the body.

			=== Roles assignments ===
	<pre>		<pre>
	GET api/users/~~memberships~~/{id}		GET api/users/roleassignments/{id}
	</pre>		</pre>
	Gets a list of ''~~memberships~~'' of ~~the~~ user/group with given id. Returns an array of ~~membership~~ objects~~, which can be empty if user/group is not a member of any group~~.		Gets a list of ''role assignments'' of a user/group with the given id. Returns an array of role assignment objects.

	<pre>		<pre>
	PUT api/users/~~memberships~~		PUT api/users/roleassignments
	</pre>		</pre>
	Adds a ''~~membership~~''. Takes a ~~membership~~ object in the body.		Adds a ''role assignment''. Takes a role assignment object in the body.

	<pre>		<pre>
	DELETE api/users/~~memberships~~		DELETE api/users/roleassignments
	</pre>		</pre>
	Deletes a ''~~membership~~''. Takes a ~~membership~~ object in the body.		Deletes a ''role assignment''. Takes a role assignment object in the body.

	<pre>		<pre>

Ollvihe: /* Methods */

2020-08-27T15:30:54Z

Methods

← Older revision		Revision as of 15:30, 27 August 2020
Line 35:		Line 35:

	==Methods==		==Methods==

	Notes:		Notes:
	* For all methods, both the request and response ''Content-Type'' header is ''application/json;charset=UTF-8''.		* For all methods, both the request and response ''Content-Type'' header is ''application/json;charset=UTF-8''.
	* In requests, there needs to be a header ''Authorization'' for authentication containing syntax ''Bearer <access token>''.		* In requests, there needs to be a header ''Authorization'' for authentication containing syntax ''Bearer <access token>''.


	<pre>		<pre>

Ollvihe: Ollvihe moved page Web API: User Management to Web API for User Management without leaving a redirect

2020-08-13T17:46:32Z

Ollvihe moved page Web API: User Management to Web API for User Management without leaving a redirect

← Older revision	Revision as of 17:46, 13 August 2020
(No difference)

Ollvihe: /* Role assignment */

2020-08-13T17:43:28Z

Role assignment

← Older revision		Revision as of 17:43, 13 August 2020
Line 16:		Line 16:

	===Role assignment===		===Role assignment===
	''Role assignment'' entity describes that a role is given to a certain user/group. Properties:		''Role assignment'' entity describes that a role is given to a certain user/group. Note that role assignments don't have own id's, but they are identified by the combinations of all their property values. Properties:
	* Id (integer): user/group id.		* Id (integer): user/group id.
	* ProjectId (integer): project id used in project-specific role assignments. Not used for global permissions.		* ProjectId (integer): project id used in project-specific role assignments. Not used for global permissions.

Ollvihe: /* Membership */

2020-08-13T17:42:31Z

Membership

← Older revision		Revision as of 17:42, 13 August 2020
Line 22:		Line 22:

	===Membership===		===Membership===
	''Membership'' entity describes that a user belongs to a group. Properties:		''Membership'' entity describes that a user belongs to a group. Note that memberships don't have own id's, but memberships are identified by the combinations of all their property values. Properties:
	* GroupId (integer): parent (container) group id.		* GroupId (integer): parent (container) group id.
	* MemberId (integer): child (member) user/group id.		* MemberId (integer): child (member) user/group id.

Ollvihe: /* Role assignment */

2020-08-13T17:41:21Z

Role assignment

← Older revision		Revision as of 17:41, 13 August 2020
Line 17:		Line 17:
	===Role assignment===		===Role assignment===
	''Role assignment'' entity describes that a role is given to a certain user/group. Properties:		''Role assignment'' entity describes that a role is given to a certain user/group. Properties:
	* Id (integer): user/group id		* Id (integer): user/group id.
	* ProjectId (integer): project id used in project-specific role assignments. Not used for global permissions.		* ProjectId (integer): project id used in project-specific role assignments. Not used for global permissions.
	* RoleId (integer): role id		* RoleId (integer): role id.

	===Membership===		===Membership===