Web API for User Management: Difference between revisions

From QPR ProcessAnalyzer Wiki
Jump to navigation Jump to search
No edit summary
 
(10 intermediate revisions by the same user not shown)
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 ==
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.
* RoleId (integer): role id
* RoleId (integer): role id.


===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.
Line 35: Line 35:


==Methods==
==Methods==
Notes:
* 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>''.


=== User and group entities ===
<pre>
<pre>
GET api/users
GET api/users
Line 58: 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. 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>
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>
Line 92: 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]]

Latest revision as of 19:30, 11 December 2021

This page describes Web API operations for managing users, groups, roles and permissions. See more information how roles and permissions work in QPR ProcessAnalyzer.

Entities

The user management API uses the following entities.

User/group

User/group entity describes both users and groups. Properties:

  • Id (integer): user/group id.
  • IsGroup (boolean): false for users, true for groups.
  • LoginName (string): user login name. Empty/ignored for groups.
  • FullName (string): user/group full name.
  • Email (string): user/group email address.
  • Password (string): user password. Used only when creating or updating users.
  • IsActive (boolean): flag whether user/group is active.
  • Description (string): user/group description.

Role assignment

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.
  • ProjectId (integer): project id used in project-specific role assignments. Not used for global permissions.
  • RoleId (integer): role id.

Membership

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.
  • MemberId (integer): child (member) user/group id.
  • RoleName (string): Type of the membership. Supported types are Member, HiddenMember, Administrator.

Role

Role entity describes a role in the system. Properties:

  • Id (integer): role id.
  • Name (string): role name.
  • IsGlobal (boolean): true for global role, false for project-specific-only role. Note that a role can be both global and user-specific.
  • IsProject (boolean): true for project-specific role, false for global-only role. Note that a role can be both global and user-specific.

Methods

Notes:

  • 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>.

User and group entities

GET api/users

Gets a list of users/group entities. Can be an empty array if criteria specified by parameters is not matched. Supported query parameters:

  • isGroup (boolean): if false, only users are returned; if true, only groups are returned. If omitted, both users and groups are returned.
  • isActive (boolean): if false or omitted, all users/groups are returned; if true, only active users/groups are returned.
GET api/users/{id}

Gets information of the user/group with given id. Returns the user/group object. Can return null if a user/group is not found. 

POST api/users

Creates a new user/group. Takes a user/group object in the body. Note that the id property is ignored if specified. Returns the id of the created user/group. 

PUT api/users

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

GET api/users/memberships/{id}

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. 

PUT api/users/memberships

Adds a membership. Takes a membership object in the body. 

DELETE api/users/memberships

Deletes a membership. Takes a membership object in the body.

Roles assignments

GET api/users/roleassignments/{id}

Gets a list of role assignments of a user/group with the given id. Returns an array of role assignment objects. 

PUT api/users/roleassignments

Adds a role assignment. Takes a role assignment object in the body. 

DELETE api/users/roleassignments

Deletes a role assignment. Takes a role assignment object in the body. 

GET api/users/roles

Gets a list of all roles in the system. Returns an array of role objects.

Retrieved from "https://wiki.onqpr.com/pa/index.php?title=Web_API_for_User_Management&oldid=19561"