Returns a list of privileges for a specified security group.
Use this operation to find out which privileges are available to the specified security group.
Security groups are used to distinguish the privileges between multiple users. One security group can have different rights to access data of QAComplete's entities.
Authentication
Basic authentication using a user’s login and password. See Authentication for details.
Security Rights
The authenticating user must have administrator privileges.
Request Format
To get information on a security group, send a GET request to the following URL:
DeptId : integer, required
The Id of the needed department.
Name : integer, required
The name of the security group whose privileges you want to get.
A sample request:
GET http://yourserver.com/rest-api/service/api/v1/depts/8162/securitygroups/User HTTP/1.1
Host: yourserver.com
Connection: keep-alive
Accept: application/json
Authorization: Basic am9obkBleGFtcGxlLmNvbTpwQHNzd29yZA==
A sample request made by using cURL:
curl -u [email protected]:p@ssword -H "Accept: application/json" http://yourserver.com/service/api/v1/depts/8162/securitygroups/User
Response Format
If successful, the operation responds with HTTP status code 200 and returns a JSON object with the security group information.
If the operation fails, it returns the appropriate status code and (optionally) the error description in the response body.
A sample response:
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 210
{
"metadata": {
"result_set": {
"count": 1,
"offset": 0,
"total": 1
},
"permissions": {
"acl": 7
}
},
"results": [
{
"entity-code": "Folders",
"can_read": true,
"can_add": true,
"can_update": true,
"can_delete": false
}
]
}
Metadata about the security groups list.
Pagination information about the security groups list. (See Paging Through Results Using Offset and Limit.)
The number of returned security groups.
The offset of the first security group requested.
The maximum number of security groups requested.
The total number of security groups.
The authenticating user’s rights to access security groups.
Access rights:
- 0 - None
- 1 - Read
- 2 - Update
- 3 - Read and update
- 4 - Delete
- 5 - Read and delete
- 7 - Full access
An array of available security groups.
The department ID.
The department name.
The project name.
The unique identifier of the project.
The label of the QAComplete entity.
Specifies whether members of the security group can read contents of the entity.
Specifies whether members of the security group can add any data to the entity.
Specifies whether members of the security group can update contents of the entity.
Specifies whether members of the security group can delete contents of the entity.