Join Wintertainment 2021 to share your stories, have fun, earn community badges, and more!

GET/depts/{DeptId}/securitygroups/{Name}

Applies to QAComplete 12.94 SaaS, last modified on December 06, 2021

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:

http://{server}/rest-api/service/api/v1/depts/{DeptId}/securitygroups/{Name}

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 john@example.com: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
      }
  ]
}

See Also

Security Groups REST API Reference

Highlight search results