Skip to content
This repository was archived by the owner on Jun 2, 2021. It is now read-only.

Commit 8385fee

Browse files
belinda-liureidmit
andcommitted
v3: Document app permissions endpoint
[#169770887] Co-authored-by: Belinda Liu <bliu@pivotal.io> Co-authored-by: Reid Mitchell <rmitchell@pivotal.io>
1 parent 8428a74 commit 8385fee

2 files changed

Lines changed: 44 additions & 0 deletions

File tree

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
### Get permissions
2+
3+
```
4+
Example Request
5+
```
6+
7+
```shell
8+
curl "https://api.example.org/v3/apps/[guid]/permissions" \
9+
-X GET \
10+
-H "Authorization: bearer [token]"
11+
```
12+
13+
```
14+
Example Response
15+
```
16+
17+
```http
18+
HTTP/1.1 200 OK
19+
Content-Type: application/json
20+
21+
{
22+
"read_basic_data": true,
23+
"read_sensitive_data": false
24+
}
25+
```
26+
27+
Get the current user's permissions for the given app. If a user can see an app,
28+
then they can see its basic data. Only admin and read-only admins can read sensitive
29+
data.
30+
31+
#### Definition
32+
`GET /v3/apps/:guid/permissions`
33+
34+
#### Permitted roles
35+
|
36+
--- | ---
37+
Admin |
38+
Admin Read-Only |
39+
Global Auditor |
40+
Org Manager |
41+
Space Auditor |
42+
Space Developer |
43+
Space Manager |

docs/v3/source/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,7 @@ includes:
6868
- resources/apps/get_current_droplet_relationship
6969
- resources/apps/env
7070
- resources/apps/environment_variables
71+
- resources/apps/permissions
7172
- resources/apps/current_droplet
7273
- resources/apps/ssh_enabled
7374
- resources/apps/start

0 commit comments

Comments
 (0)