Resource: Project Group Permissions ( /api/group/{groupId}/permissions/project/{projectId} )
Project Group Permissions resource - allows the retrieval of the collection of permissions directly associated with a group for a project, or updating the permissions associated with a project group.
This resource supports the following methods: GET, PUT
Methods
GET
Retrieves the project permissions for this group
Required Permissions
- Administration/Organisation/ManageUserAndGroupSecurity
Status Codes
These are the expected status codes returned by the service. In addition, some other status codes may be returned if either an internal error occurs or there is an authentication issue (such as an expired OAuth token).
| Status | Description |
|---|---|
| 200 - OK | Returned if the request was completed successfully. |
| 404 - NotFound | Returned if the group does not exist. |
Retrieve the permissions assigned to this group for selected project.
Request Headers
| Key | Value | Description |
|---|---|---|
| Accept | application/json |
Request Parameters
| Key | Value | Description |
|---|---|---|
| {groupId} | 3a31a68a-9e51-4d87-91bb-aca0fa5c1fe9 | Unique ID of the group to retrieve permissions for |
| {projectId} | 9ee7ac7b-1fa9-4af6-91f2-cc59408b84d7 | Unique ID of the project to retrieve permissions for |
Response Headers
| Key | Value | Description |
|---|---|---|
| Content-Type | application/json; charset=utf-8 |
Response Body
| Code Block | ||
|---|---|---|
| ||
[
{
"Id": "e6a7d6d3-6b16-4e94-a768-54bdd8bb3b22",
"Key": "/Administration",
"Links": [
{
"Href": "http://localhost/api/permission/e6a7d6d3-6b16-4e94-a768-54bdd8bb3b22",
"Rel": "Permission"
}
]
},
{
"Id": "fad12035-4937-401a-881a-ea340050218e",
"Key": "/Resources",
"Links": [
{
"Href": "http://localhost/api/permission/fad12035-4937-401a-881a-ea340050218e",
"Rel": "Permission"
}
]
}
]
|
Status Code
200 - OK
PUT
Sets the project permissions for this group
Required Permissions
- Administration/Organisation/ManageUserAndGroupSecurity
Status Codes
These are the expected status codes returned by the service. In addition, some other status codes may be returned if either an internal error occurs or there is an authentication issue (such as an expired OAuth token).
| Status | Description |
|---|---|
| 200 - OK | Returned if the request was completed successfully. |
| 403 - Forbidden | Returned if one or more permissions could not be resolved. |
| 404 - NotFound | Returned if the group or project does not exist. |
Set the permissions to grant to the group for this project (using the ID for each permission)
Request Headers
| Key | Value | Description |
|---|---|---|
| Accept | application/json |
Request Parameters
| Key | Value | Description |
|---|---|---|
| {groupId} | 3a31a68a-9e51-4d87-91bb-aca0fa5c1fe9 | Unique ID of the group to set project permissions for |
| {projectId} | 9ee7ac7b-1fa9-4af6-91f2-cc59408b84d7 | Unique ID of the project to set group permissions for |
Request Body
| Code Block | ||
|---|---|---|
| ||
[
{
"Key": null,
"Id": "e6a7d6d3-6b16-4e94-a768-54bdd8bb3b22"
},
{
"Key": null,
"Id": "fad12035-4937-401a-881a-ea340050218e"
}
]
|
Response Headers
| Key | Value | Description |
|---|---|---|
| Content-Type | application/json; charset=utf-8 |
Response Body
| Code Block | ||
|---|---|---|
| ||
[
{
"Id": "e6a7d6d3-6b16-4e94-a768-54bdd8bb3b22",
"Key": "/Administration",
"Links": [
{
"Href": "http://localhost/api/permission/e6a7d6d3-6b16-4e94-a768-54bdd8bb3b22",
"Rel": "Permission"
}
]
},
{
"Id": "fad12035-4937-401a-881a-ea340050218e",
"Key": "/Resources",
"Links": [
{
"Href": "http://localhost/api/permission/fad12035-4937-401a-881a-ea340050218e",
"Rel": "Permission"
}
]
}
]
|
Status Code
200 - OK
Set the permissions to grant to the group for this project (using the unique Key for each permission)
Request Headers
| Key | Value | Description |
|---|---|---|
| Accept | application/json |
Request Parameters
| Key | Value | Description |
|---|---|---|
| {groupId} | 3a31a68a-9e51-4d87-91bb-aca0fa5c1fe9 | Unique ID of the group to set project permissions for |
| {projectId} | 9ee7ac7b-1fa9-4af6-91f2-cc59408b84d7 | Unique ID of the project to set group permissions for |
Request Body
| Code Block | ||
|---|---|---|
| ||
[
{
"Key": "/Administration",
"Id": null
},
{
"Key": "/Resources",
"Id": null
}
]
|
Response Headers
| Key | Value | Description |
|---|---|---|
| Content-Type | application/json; charset=utf-8 |
Response Body
| Code Block | ||
|---|---|---|
| ||
[
{
"Id": "e6a7d6d3-6b16-4e94-a768-54bdd8bb3b22",
"Key": "/Administration",
"Links": [
{
"Href": "http://localhost/api/permission/e6a7d6d3-6b16-4e94-a768-54bdd8bb3b22",
"Rel": "Permission"
}
]
},
{
"Id": "fad12035-4937-401a-881a-ea340050218e",
"Key": "/Resources",
"Links": [
{
"Href": "http://localhost/api/permission/fad12035-4937-401a-881a-ea340050218e",
"Rel": "Permission"
}
]
}
]
|
Status Code
200 - OK