Skip to content

Commit 51e0416

Browse files
jreadeyjreadey
committed
converted rst to md
1 parent f155fb7 commit 51e0416

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+6358
-0
lines changed

‎AclOps/GET_ACL.md‎

Lines changed: 156 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,156 @@
1+
GET ACL
2+
=======
3+
4+
Description
5+
-----------
6+
7+
Returns access information for the given user for the object with the UUID provided in the URI.
8+
9+
Requests
10+
--------
11+
12+
### Syntax
13+
14+
To get a user's default access for a domain:
15+
16+
``` sourceCode
17+
GET /acls/<userid> HTTP/1.1
18+
Host: DOMAIN
19+
Authorization: <authorization_string>
20+
```
21+
22+
To get a user's access information for a group:
23+
24+
``` sourceCode
25+
GET /groups/<id>/acls/<userid> HTTP/1.1
26+
Host: DOMAIN
27+
Authorization: <authorization_string>
28+
```
29+
30+
To get a user's access information for a dataset:
31+
32+
``` sourceCode
33+
GET /datasets/<id>/acls/<userid> HTTP/1.1
34+
Host: DOMAIN
35+
Authorization: <authorization_string>
36+
```
37+
38+
To get a user's access information for a committed datatype:
39+
40+
``` sourceCode
41+
GET /datatypes/<id>/acls/<userid> HTTP/1.1
42+
Host: DOMAIN
43+
Authorization: <authorization_string>
44+
```
45+
46+
where:
47+
48+
- &lt;id&gt; is the UUID of the requested dataset/group/committed datatype
49+
- &lt;userid&gt; is the userid for the requested user. Use the special userid "default" to get the default access permisions for the object
50+
51+
### Request Parameters
52+
53+
This implementation of the operation does not use request parameters.
54+
55+
### Request Headers
56+
57+
This implementation of the operation uses only the request headers that are common to most requests. See ../CommonRequestHeaders
58+
59+
Responses
60+
---------
61+
62+
### Response Headers
63+
64+
This implementation of the operation uses only response headers that are common to most responses. See ../CommonResponseHeaders.
65+
66+
### Response Elements
67+
68+
On success, a JSON response will be returned with the following elements:
69+
70+
#### acl
71+
72+
A JSON object that describes a user's access permissions. Subkeys of acl are:
73+
74+
userName: the userid of the requested user
75+
76+
create: A boolean flag that indicates if the user is authorized to create new resources
77+
78+
delete: A boolean flag that indicates if the user is authorized to delete resources
79+
80+
read: A boolean flag that indicates if the user is authorized to read (GET) resources
81+
82+
update: A boolean flag that indicates if the user is authorized to update resources
83+
84+
readACL: A boolean flag that indicates if the user is authorized to read the object's ACL
85+
86+
updateACL: A boolean flag that indicates if the user is authorized to update the object's ACL
87+
88+
#### hrefs
89+
90+
An array of hypertext links to related resources. See ../Hypermedia.
91+
92+
### Special Errors
93+
94+
This implementation of the operation does not return special errors. For general information on standard error codes, see ../CommonErrorResponses.
95+
96+
Examples
97+
--------
98+
99+
### Sample Request
100+
101+
``` sourceCode
102+
GET /groups/052dcbbd-9d33-11e4-86ce-3c15c2da029e/acls/test_user1 HTTP/1.1
103+
host: tall.test.hdfgroup.org
104+
Accept-Encoding: gzip, deflate
105+
Accept: */*
106+
User-Agent: python-requests/2.3.0 CPython/2.7.8 Darwin/14.0.0
107+
```
108+
109+
### Sample Response
110+
111+
``` sourceCode
112+
HTTP/1.1 200 OK
113+
Date: Fri, 16 Jan 2015 20:06:08 GMT
114+
Content-Length: 660
115+
Etag: "2c410d1c469786f25ed0075571a8e7a3f313cec1"
116+
Content-Type: application/json
117+
Server: TornadoServer/3.2.2
118+
```
119+
120+
``` sourceCode
121+
{
122+
"acl": {
123+
"create": false,
124+
"delete": false,
125+
"read": true,
126+
"readACL": false,
127+
"update": false,
128+
"updateACL": false,
129+
"userName": "test_user1"
130+
},
131+
"hrefs": [
132+
{
133+
"href": "http://tall_acl.test.hdfgroup.org/groups/eb8f6959-8775-11e5-96b6-3c15c2da029e/acls/test_user1",
134+
"rel": "self"
135+
},
136+
{
137+
"href": "http://tall_acl.test.hdfgroup.org/groups/eb8f6959-8775-11e5-96b6-3c15c2da029e",
138+
"rel": "root"
139+
},
140+
{
141+
"href": "http://tall_acl.test.hdfgroup.org/",
142+
"rel": "home"
143+
},
144+
{
145+
"href": "http://tall_acl.test.hdfgroup.org/groups/eb8f6959-8775-11e5-96b6-3c15c2da029e",
146+
"rel": "owner"
147+
}
148+
]
149+
```
150+
151+
Related Resources
152+
-----------------
153+
154+
- PUT\_ACL
155+
- GET\_ACLs
156+

‎AclOps/GET_ACLs.md‎

Lines changed: 175 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,175 @@
1+
GET ACLs
2+
========
3+
4+
Description
5+
-----------
6+
7+
Returns access information for all users defined in the ACL (Access Control List) for the object with the UUID provided in the URI.
8+
9+
Requests
10+
--------
11+
12+
### Syntax
13+
14+
To get the ACL for a domain:
15+
16+
``` sourceCode
17+
GET /acls HTTP/1.1
18+
Host: DOMAIN
19+
Authorization: <authorization_string>
20+
```
21+
22+
To get the ACL for a group:
23+
24+
``` sourceCode
25+
GET /groups/<id>/acls HTTP/1.1
26+
Host: DOMAIN
27+
Authorization: <authorization_string>
28+
```
29+
30+
To get the ACL for a dataset:
31+
32+
``` sourceCode
33+
GET /datasets/<id>/acls HTTP/1.1
34+
Host: DOMAIN
35+
Authorization: <authorization_string>
36+
```
37+
38+
To get the ACL for a committed datatype:
39+
40+
``` sourceCode
41+
GET /datatypes/<id>/acls HTTP/1.1
42+
Host: DOMAIN
43+
Authorization: <authorization_string>
44+
```
45+
46+
where:
47+
48+
- &lt;id&gt; is the UUID of the requested dataset/group/committed datatype
49+
50+
### Request Parameters
51+
52+
This implementation of the operation does not use request parameters.
53+
54+
### Request Headers
55+
56+
This implementation of the operation uses only the request headers that are common to most requests. See ../CommonRequestHeaders
57+
58+
Responses
59+
---------
60+
61+
### Response Headers
62+
63+
This implementation of the operation uses only response headers that are common to most responses. See ../CommonResponseHeaders.
64+
65+
### Response Elements
66+
67+
On success, a JSON response will be returned with the following elements:
68+
69+
#### acls
70+
71+
A JSON list that contains one element for each user specified in the ACL. The elements will be JSON objects that describe each user's access permissions. The subkeys of each element are:
72+
73+
userName: the userid of the user ('default' for the default access)
74+
75+
create: A boolean flag that indicates if the user is authorized to create new resources
76+
77+
delete: A boolean flag that indicates if the user is authorized to delete resources
78+
79+
read: A boolean flag that indicates if the user is authorized to read (GET) resources
80+
81+
update: A boolean flag that indicates if the user is authorized to update resources
82+
83+
readACL: A boolean flag that indicates if the user is authorized to read the object's ACL
84+
85+
updateACL: A boolean flag that indicates if the user is authorized to update the object's ACL
86+
87+
#### hrefs
88+
89+
An array of hypertext links to related resources. See ../Hypermedia.
90+
91+
### Special Errors
92+
93+
This implementation of the operation does not return special errors. For general information on standard error codes, see ../CommonErrorResponses.
94+
95+
Examples
96+
--------
97+
98+
### Sample Request
99+
100+
``` sourceCode
101+
GET /groups/052dcbbd-9d33-11e4-86ce-3c15c2da029e/acls HTTP/1.1
102+
host: tall.test.hdfgroup.org
103+
Accept-Encoding: gzip, deflate
104+
Accept: */*
105+
User-Agent: python-requests/2.3.0 CPython/2.7.8 Darwin/14.0.0
106+
```
107+
108+
### Sample Response
109+
110+
``` sourceCode
111+
HTTP/1.1 200 OK
112+
Date: Fri, 16 Jan 2015 20:06:08 GMT
113+
Content-Length: 660
114+
Etag: "2c410d1c469786f25ed0075571a8e7a3f313cec1"
115+
Content-Type: application/json
116+
Server: TornadoServer/3.2.2
117+
```
118+
119+
``` sourceCode
120+
{
121+
"acls": [
122+
{
123+
"create": true,
124+
"delete": true,
125+
"read": true,
126+
"readACL": true,
127+
"update": true,
128+
"updateACL": true,
129+
"userName": "test_user2"
130+
},
131+
{
132+
"create": false,
133+
"delete": false,
134+
"read": true,
135+
"readACL": false,
136+
"update": false,
137+
"updateACL": false,
138+
"userName": "test_user1"
139+
},
140+
{
141+
"create": false,
142+
"delete": false,
143+
"read": false,
144+
"readACL": false,
145+
"update": false,
146+
"updateACL": false,
147+
"userName": "default"
148+
}
149+
],
150+
"hrefs": [
151+
{
152+
"href": "http://tall_acl.test.hdfgroup.org/groups/eb8f6959-8775-11e5-96b6-3c15c2da029e/acls",
153+
"rel": "self"
154+
},
155+
{
156+
"href": "http://tall_acl.test.hdfgroup.org/groups/eb8f6959-8775-11e5-96b6-3c15c2da029e",
157+
"rel": "root"
158+
},
159+
{
160+
"href": "http://tall_acl.test.hdfgroup.org/",
161+
"rel": "home"
162+
},
163+
{
164+
"href": "http://tall_acl.test.hdfgroup.org/groups/eb8f6959-8775-11e5-96b6-3c15c2da029e",
165+
"rel": "owner"
166+
}
167+
]
168+
```
169+
170+
Related Resources
171+
-----------------
172+
173+
- PUT\_ACL
174+
- GET\_ACL
175+

0 commit comments

Comments
 (0)