Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 4f877e562986034f25ea4246ad1256eabd339526 / . / docs / dyn / androidenterprise_v1.collectionviewers.html
blob: 97fa5b27a41c74d5f291d8b6c5c0bc2b068d601f [file] [log] [blame]
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame^]75<h1><a href="androidenterprise_v1.html">Google Play EMM API</a> . <a href="androidenterprise_v1.collectionviewers.html">collectionviewers</a></h1>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(enterpriseId, collectionId, userId)</a></code></p>
79<p class="firstline">Removes the user from the list of those specifically allowed to see the collection. If the collection's visibility is set to viewersOnly then only such users will see the collection.</p>
80<p class="toc_element">
81 <code><a href="#get">get(enterpriseId, collectionId, userId)</a></code></p>
82<p class="firstline">Retrieves the ID of the user if they have been specifically allowed to see the collection. If the collection's visibility is set to viewersOnly then only these users will see the collection.</p>
83<p class="toc_element">
84 <code><a href="#list">list(enterpriseId, collectionId)</a></code></p>
85<p class="firstline">Retrieves the IDs of the users who have been specifically allowed to see the collection. If the collection's visibility is set to viewersOnly then only these users will see the collection.</p>
86<p class="toc_element">
87 <code><a href="#patch">patch(enterpriseId, collectionId, userId, body)</a></code></p>
88<p class="firstline">Adds the user to the list of those specifically allowed to see the collection. If the collection's visibility is set to viewersOnly then only such users will see the collection. This method supports patch semantics.</p>
89<p class="toc_element">
90 <code><a href="#update">update(enterpriseId, collectionId, userId, body)</a></code></p>
91<p class="firstline">Adds the user to the list of those specifically allowed to see the collection. If the collection's visibility is set to viewersOnly then only such users will see the collection.</p>
92<h3>Method Details</h3>
93<div class="method">
94 <code class="details" id="delete">delete(enterpriseId, collectionId, userId)</code>
95 <pre>Removes the user from the list of those specifically allowed to see the collection. If the collection's visibility is set to viewersOnly then only such users will see the collection.
96
97Args:
98 enterpriseId: string, The ID of the enterprise. (required)
99 collectionId: string, The ID of the collection. (required)
100 userId: string, The ID of the user. (required)
101</pre>
102</div>
103
104<div class="method">
105 <code class="details" id="get">get(enterpriseId, collectionId, userId)</code>
106 <pre>Retrieves the ID of the user if they have been specifically allowed to see the collection. If the collection's visibility is set to viewersOnly then only these users will see the collection.
107
108Args:
109 enterpriseId: string, The ID of the enterprise. (required)
110 collectionId: string, The ID of the collection. (required)
111 userId: string, The ID of the user. (required)
112
113Returns:
114 An object of the form:
115
116 { # A user resource represents an individual user within the enterprise's domain.
117 #
118 # Note that each user is associated with a Google account based on the user's corporate email address (which must be in one of the enterprise's domains). As part of installing an MDM app to manage a device the Google account must be provisioned to the device, and so the user resource must be created before that. This can be done using the Google Admin SDK Directory API.
119 #
120 # The ID for a user is an opaque string. It can be retrieved using the list method queried by the user's primary email address.
121 "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user".
122 "primaryEmail": "A String", # The user's primary email, e.g. "jsmith@example.com".
123 "id": "A String", # The unique ID for the user.
124 }</pre>
125</div>
126
127<div class="method">
128 <code class="details" id="list">list(enterpriseId, collectionId)</code>
129 <pre>Retrieves the IDs of the users who have been specifically allowed to see the collection. If the collection's visibility is set to viewersOnly then only these users will see the collection.
130
131Args:
132 enterpriseId: string, The ID of the enterprise. (required)
133 collectionId: string, The ID of the collection. (required)
134
135Returns:
136 An object of the form:
137
138 { # The user resources for the collection.
139 "kind": "androidenterprise#collectionViewersListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#collectionViewersListResponse".
140 "user": [ # A user of an enterprise.
141 { # A user resource represents an individual user within the enterprise's domain.
142 #
143 # Note that each user is associated with a Google account based on the user's corporate email address (which must be in one of the enterprise's domains). As part of installing an MDM app to manage a device the Google account must be provisioned to the device, and so the user resource must be created before that. This can be done using the Google Admin SDK Directory API.
144 #
145 # The ID for a user is an opaque string. It can be retrieved using the list method queried by the user's primary email address.
146 "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user".
147 "primaryEmail": "A String", # The user's primary email, e.g. "jsmith@example.com".
148 "id": "A String", # The unique ID for the user.
149 },
150 ],
151 }</pre>
152</div>
153
154<div class="method">
155 <code class="details" id="patch">patch(enterpriseId, collectionId, userId, body)</code>
156 <pre>Adds the user to the list of those specifically allowed to see the collection. If the collection's visibility is set to viewersOnly then only such users will see the collection. This method supports patch semantics.
157
158Args:
159 enterpriseId: string, The ID of the enterprise. (required)
160 collectionId: string, The ID of the collection. (required)
161 userId: string, The ID of the user. (required)
162 body: object, The request body. (required)
163 The object takes the form of:
164
165{ # A user resource represents an individual user within the enterprise's domain.
166 #
167 # Note that each user is associated with a Google account based on the user's corporate email address (which must be in one of the enterprise's domains). As part of installing an MDM app to manage a device the Google account must be provisioned to the device, and so the user resource must be created before that. This can be done using the Google Admin SDK Directory API.
168 #
169 # The ID for a user is an opaque string. It can be retrieved using the list method queried by the user's primary email address.
170 "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user".
171 "primaryEmail": "A String", # The user's primary email, e.g. "jsmith@example.com".
172 "id": "A String", # The unique ID for the user.
173 }
174
175
176Returns:
177 An object of the form:
178
179 { # A user resource represents an individual user within the enterprise's domain.
180 #
181 # Note that each user is associated with a Google account based on the user's corporate email address (which must be in one of the enterprise's domains). As part of installing an MDM app to manage a device the Google account must be provisioned to the device, and so the user resource must be created before that. This can be done using the Google Admin SDK Directory API.
182 #
183 # The ID for a user is an opaque string. It can be retrieved using the list method queried by the user's primary email address.
184 "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user".
185 "primaryEmail": "A String", # The user's primary email, e.g. "jsmith@example.com".
186 "id": "A String", # The unique ID for the user.
187 }</pre>
188</div>
189
190<div class="method">
191 <code class="details" id="update">update(enterpriseId, collectionId, userId, body)</code>
192 <pre>Adds the user to the list of those specifically allowed to see the collection. If the collection's visibility is set to viewersOnly then only such users will see the collection.
193
194Args:
195 enterpriseId: string, The ID of the enterprise. (required)
196 collectionId: string, The ID of the collection. (required)
197 userId: string, The ID of the user. (required)
198 body: object, The request body. (required)
199 The object takes the form of:
200
201{ # A user resource represents an individual user within the enterprise's domain.
202 #
203 # Note that each user is associated with a Google account based on the user's corporate email address (which must be in one of the enterprise's domains). As part of installing an MDM app to manage a device the Google account must be provisioned to the device, and so the user resource must be created before that. This can be done using the Google Admin SDK Directory API.
204 #
205 # The ID for a user is an opaque string. It can be retrieved using the list method queried by the user's primary email address.
206 "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user".
207 "primaryEmail": "A String", # The user's primary email, e.g. "jsmith@example.com".
208 "id": "A String", # The unique ID for the user.
209 }
210
211
212Returns:
213 An object of the form:
214
215 { # A user resource represents an individual user within the enterprise's domain.
216 #
217 # Note that each user is associated with a Google account based on the user's corporate email address (which must be in one of the enterprise's domains). As part of installing an MDM app to manage a device the Google account must be provisioned to the device, and so the user resource must be created before that. This can be done using the Google Admin SDK Directory API.
218 #
219 # The ID for a user is an opaque string. It can be retrieved using the list method queried by the user's primary email address.
220 "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user".
221 "primaryEmail": "A String", # The user's primary email, e.g. "jsmith@example.com".
222 "id": "A String", # The unique ID for the user.
223 }</pre>
224</div>
225
226</body></html>