Gets information on security groups in a specified department.
Use this operation to get information on security groups within a department specified by its ID.
To get information on a specific security group, use the /depts/{DeptId}/securitygroups/{Name} (GET) operation.
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 security groups, send a GET request to the following URL:
DeptId : integer, required
The ID of the needed department.
offset : integer, default: 0
The number of security groups to skip before counting the returned security groups.The default value is 0, which is the offset of the first item. For details, see Paging Through Results Using Offset and Limit.
limit : integer, default: 25
The maximum number of security groups to return in the response.
filter : string
The filter expression to apply to the returned list. See Search Filters.
A sample request:
GET http://yourserver.com/rest-api/service/api/v1/depts/8162/securitygroups 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
Response Format
If successful, the operation responds with HTTP status code 200 and returns a JSON object with the security groups information.
A sample response:
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 172
{
"metadata": {
"result_set": {
"count": 1,
"offset": 0,
"limit": 25,
"total": 1
},
"permissions": {
"acl": 7
}
},
"results": [
{
"name": "Administator"
},
{
"name": "User"
},
{
]
}
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
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.
An array of available security group pairs.
The department ID of the project.
The department name.
The project name.
The unique identifier of the project.
The name of the security group.
Error responses
If the operation fails, it returns the appropriate status code and (optionally) the error description in the response body.