Resource: User Permission Projects ( /api/user/{id}/permissions/projects )
Returns links to the set of project user permissions resources
This resource supports the following methods: GET
Methods
GET
Retrieves a set of links, one for each project, which can be used to manage the project user permissions for this user.
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 user does not exist. |
Example - Retrieve project permission links
Retrieve a set of links for managing this users permissions associated with each project
Request Headers
| Key | Value | Description |
|---|---|---|
| Accept | application/json |
Request Parameters
| Key | Value | Description |
|---|---|---|
| {id} | 3a31a68a-9e51-4d87-91bb-aca0fa5c1fe9 | Unique ID of the user to retrieve project permission links for |
Response Headers
| Key | Value | Description |
|---|---|---|
| Content-Type | application/json; charset=utf-8 |
Response Body
| Code Block | ||
|---|---|---|
| ||
{
"Projects": [
{
"ProjectId": "4feb1531-77eb-4393-918f-ed17bc5e12d7",
"Self": "http://localhost/api/user/3a31a68a-9e51-4d87-91bb-aca0fa5c1fe9/permissions/project/4feb1531-77eb-4393-918f-ed17bc5e12d7",
"Links": [
{
"Title": "Project X",
"Href": "http://localhost/api/project/4feb1531-77eb-4393-918f-ed17bc5e12d7",
"Rel": "Project"
}
]
},
{
"ProjectId": "121063fd-cca2-4bc5-804a-1bf5578beb83",
"Self": "http://localhost/api/user/3a31a68a-9e51-4d87-91bb-aca0fa5c1fe9/permissions/project/121063fd-cca2-4bc5-804a-1bf5578beb83",
"Links": [
{
"Title": "Project Y",
"Href": "http://localhost/api/project/121063fd-cca2-4bc5-804a-1bf5578beb83",
"Rel": "Project"
}
]
}
],
"Self": "http://localhost/api/user/3a31a68a-9e51-4d87-91bb-aca0fa5c1fe9/permissions/projects"
}
|
Status Code
200 - OK