Date: Fri, 29 Mar 2024 14:46:52 +0000 (UTC) Message-ID: <1981231413.12481.1711723612299@catch-kbase-p> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_12480_438572356.1711723612290" ------=_Part_12480_438572356.1711723612290 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html
Global Group Permissions resource - allows the retrieval of the collecti= on of global permissions directly associated with a group, or updating the = permissions associated with a group.
This resource supports the following methods: GET, PUT
Retrieves the global permissions for this group
These are the expected status codes returned by the service. In addition= , some other status codes may be returned if either an internal error occur= s or there is an authentication issue (such as an expired OAuth token).
Status | Description |
---|---|
200 - OK | Returned if the request was completed successful= ly. |
404 - NotFound | Returned if the group does not exist. |
Retrieve the global permissions associated with a group
Request Headers
Key | Value | Description |
---|---|---|
Accept | application/json |
Request Parameters
Key | Value | Description |
---|---|---|
{id} | 3a31a68a-9e51-4d87-91bb-aca0fa5c1fe9 | Unique ID of the group to retrieve global permis= sions for |
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=3Dutf-8 |
Response Body
[ { "Id": "e6a7d6d3-6b16-4e94-a768-54bdd8bb3b22", "Key": "/Administration", "Links": [ { "Href": "http://localhost/api/permission/e6a7d6d3-6b16-4e94-a768-54= bdd8bb3b22", "Rel": "Permission" } ] }, { "Id": "fad12035-4937-401a-881a-ea340050218e", "Key": "/Resources", "Links": [ { "Href": "http://localhost/api/permission/fad12035-4937-401a-881a-ea= 340050218e", "Rel": "Permission" } ] } ]
Status Code
200 - OK
Sets the global permissions for this group
These are the expected status codes returned by the service. In addition= , some other status codes may be returned if either an internal error occur= s or there is an authentication issue (such as an expired OAuth token).
Status | Description |
---|---|
200 - OK | Returned if the request was completed successful= ly. |
403 - Forbidden | Returned if one or more permissions could not be= resolved. |
404 - NotFound | Returned if the group does not exist. |
Set the global permissions for a group (using the unique ID for each per= mission)
Request Headers
Key | Value | Description |
---|---|---|
Accept | application/json |
Request Parameters
Key | Value | Description |
---|---|---|
{id} | 3a31a68a-9e51-4d87-91bb-aca0fa5c1fe9 | Unique ID of the group to retrieve global permis= sions for |
Request Body
[ { "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=3Dutf-8 |
Response Body
[ { "Id": "e6a7d6d3-6b16-4e94-a768-54bdd8bb3b22", "Key": "/Administration", "Links": [ { "Href": "http://localhost/api/permission/e6a7d6d3-6b16-4e94-a768-54= bdd8bb3b22", "Rel": "Permission" } ] }, { "Id": "fad12035-4937-401a-881a-ea340050218e", "Key": "/Resources", "Links": [ { "Href": "http://localhost/api/permission/fad12035-4937-401a-881a-ea= 340050218e", "Rel": "Permission" } ] } ]
Status Code
200 - OK
Set the global permissions for a group (using the unique Key for each pe= rmission)
Request Headers
Key | Value | Description |
---|---|---|
Accept | application/json |
Request Parameters
Key | Value | Description |
---|---|---|
{id} | 3a31a68a-9e51-4d87-91bb-aca0fa5c1fe9 | Unique ID of the group to retrieve global permis= sions for |
Request Body
[ { "Key": "/Administration", "Id": null }, { "Key": "/Resources", "Id": null } ]
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=3Dutf-8 |
Response Body
[ { "Id": "e6a7d6d3-6b16-4e94-a768-54bdd8bb3b22", "Key": "/Administration", "Links": [ { "Href": "http://localhost/api/permission/e6a7d6d3-6b16-4e94-a768-54= bdd8bb3b22", "Rel": "Permission" } ] }, { "Id": "fad12035-4937-401a-881a-ea340050218e", "Key": "/Resources", "Links": [ { "Href": "http://localhost/api/permission/fad12035-4937-401a-881a-ea= 340050218e", "Rel": "Permission" } ] } ]
Status Code
200 - OK