Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 42818cfca63bf2d3d257ff8859939dcf6839456e / . / docs / dyn / androidenterprise_v1.collectionviewers.html
blob: 908f915ee73796542330a5e0332c15245bc0131a [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
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]116 { # A Users resource represents an account associated with an enterprise. The account may be specific to a device or to an individual user (who can then use the account across multiple devices). The account may provide access to Google Play for Work only, or to other Google services, depending on the identity model:
117 # - Google managed domain identity model requires synchronization to Google account sources (via primaryEmail).
118 # - Android for Work Accounts identity model provides a dynamic means for enterprises to create user or device accounts as needed. These accounts provide access to Google Play for Work only.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]119 "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user".
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]120 "displayName": "A String", # The name that will appear in user interfaces. Setting this property is optional when creating EMM-managed users. If you do set this property, use something generic about the organization (such as "Example, Inc.") or your name (as EMM). Not used for Google-managed user accounts.
121 "accountIdentifier": "A String", # A unique identifier you create for this user, such as "user342" or "asset#44418". Do not use personally identifiable information (PII) for this property. Must always be set for EMM-managed users. Not set for Google-managed users.
122 "managementType": "A String", # The entity that manages the user. With googleManaged users, the source of truth is Google so EMMs have to make sure a Google Account exists for the user. With emmManaged users, the EMM is in charge.
123 "primaryEmail": "A String", # The user's primary email address, for example, "jsmith@example.com". Will always be set for Google managed users and not set for EMM managed users.
124 "accountType": "A String", # The type of account that this user represents. A userAccount can be installed on multiple devices, but a deviceAccount is specific to a single device. An EMM-managed user (emmManaged) can be either type (userAccount, deviceAccount), but a Google-managed user (googleManaged) is always a userAccount.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]125 "id": "A String", # The unique ID for the user.
126 }</pre>
127</div>
128
129<div class="method">
130 <code class="details" id="list">list(enterpriseId, collectionId)</code>
131 <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.
132
133Args:
134 enterpriseId: string, The ID of the enterprise. (required)
135 collectionId: string, The ID of the collection. (required)
136
137Returns:
138 An object of the form:
139
140 { # The user resources for the collection.
141 "kind": "androidenterprise#collectionViewersListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#collectionViewersListResponse".
142 "user": [ # A user of an enterprise.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]143 { # A Users resource represents an account associated with an enterprise. The account may be specific to a device or to an individual user (who can then use the account across multiple devices). The account may provide access to Google Play for Work only, or to other Google services, depending on the identity model:
144 # - Google managed domain identity model requires synchronization to Google account sources (via primaryEmail).
145 # - Android for Work Accounts identity model provides a dynamic means for enterprises to create user or device accounts as needed. These accounts provide access to Google Play for Work only.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]146 "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user".
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]147 "displayName": "A String", # The name that will appear in user interfaces. Setting this property is optional when creating EMM-managed users. If you do set this property, use something generic about the organization (such as "Example, Inc.") or your name (as EMM). Not used for Google-managed user accounts.
148 "accountIdentifier": "A String", # A unique identifier you create for this user, such as "user342" or "asset#44418". Do not use personally identifiable information (PII) for this property. Must always be set for EMM-managed users. Not set for Google-managed users.
149 "managementType": "A String", # The entity that manages the user. With googleManaged users, the source of truth is Google so EMMs have to make sure a Google Account exists for the user. With emmManaged users, the EMM is in charge.
150 "primaryEmail": "A String", # The user's primary email address, for example, "jsmith@example.com". Will always be set for Google managed users and not set for EMM managed users.
151 "accountType": "A String", # The type of account that this user represents. A userAccount can be installed on multiple devices, but a deviceAccount is specific to a single device. An EMM-managed user (emmManaged) can be either type (userAccount, deviceAccount), but a Google-managed user (googleManaged) is always a userAccount.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]152 "id": "A String", # The unique ID for the user.
153 },
154 ],
155 }</pre>
156</div>
157
158<div class="method">
159 <code class="details" id="patch">patch(enterpriseId, collectionId, userId, body)</code>
160 <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.
161
162Args:
163 enterpriseId: string, The ID of the enterprise. (required)
164 collectionId: string, The ID of the collection. (required)
165 userId: string, The ID of the user. (required)
166 body: object, The request body. (required)
167 The object takes the form of:
168
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]169{ # A Users resource represents an account associated with an enterprise. The account may be specific to a device or to an individual user (who can then use the account across multiple devices). The account may provide access to Google Play for Work only, or to other Google services, depending on the identity model:
170 # - Google managed domain identity model requires synchronization to Google account sources (via primaryEmail).
171 # - Android for Work Accounts identity model provides a dynamic means for enterprises to create user or device accounts as needed. These accounts provide access to Google Play for Work only.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]172 "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user".
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]173 "displayName": "A String", # The name that will appear in user interfaces. Setting this property is optional when creating EMM-managed users. If you do set this property, use something generic about the organization (such as "Example, Inc.") or your name (as EMM). Not used for Google-managed user accounts.
174 "accountIdentifier": "A String", # A unique identifier you create for this user, such as "user342" or "asset#44418". Do not use personally identifiable information (PII) for this property. Must always be set for EMM-managed users. Not set for Google-managed users.
175 "managementType": "A String", # The entity that manages the user. With googleManaged users, the source of truth is Google so EMMs have to make sure a Google Account exists for the user. With emmManaged users, the EMM is in charge.
176 "primaryEmail": "A String", # The user's primary email address, for example, "jsmith@example.com". Will always be set for Google managed users and not set for EMM managed users.
177 "accountType": "A String", # The type of account that this user represents. A userAccount can be installed on multiple devices, but a deviceAccount is specific to a single device. An EMM-managed user (emmManaged) can be either type (userAccount, deviceAccount), but a Google-managed user (googleManaged) is always a userAccount.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]178 "id": "A String", # The unique ID for the user.
179 }
180
181
182Returns:
183 An object of the form:
184
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]185 { # A Users resource represents an account associated with an enterprise. The account may be specific to a device or to an individual user (who can then use the account across multiple devices). The account may provide access to Google Play for Work only, or to other Google services, depending on the identity model:
186 # - Google managed domain identity model requires synchronization to Google account sources (via primaryEmail).
187 # - Android for Work Accounts identity model provides a dynamic means for enterprises to create user or device accounts as needed. These accounts provide access to Google Play for Work only.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]188 "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user".
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]189 "displayName": "A String", # The name that will appear in user interfaces. Setting this property is optional when creating EMM-managed users. If you do set this property, use something generic about the organization (such as "Example, Inc.") or your name (as EMM). Not used for Google-managed user accounts.
190 "accountIdentifier": "A String", # A unique identifier you create for this user, such as "user342" or "asset#44418". Do not use personally identifiable information (PII) for this property. Must always be set for EMM-managed users. Not set for Google-managed users.
191 "managementType": "A String", # The entity that manages the user. With googleManaged users, the source of truth is Google so EMMs have to make sure a Google Account exists for the user. With emmManaged users, the EMM is in charge.
192 "primaryEmail": "A String", # The user's primary email address, for example, "jsmith@example.com". Will always be set for Google managed users and not set for EMM managed users.
193 "accountType": "A String", # The type of account that this user represents. A userAccount can be installed on multiple devices, but a deviceAccount is specific to a single device. An EMM-managed user (emmManaged) can be either type (userAccount, deviceAccount), but a Google-managed user (googleManaged) is always a userAccount.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]194 "id": "A String", # The unique ID for the user.
195 }</pre>
196</div>
197
198<div class="method">
199 <code class="details" id="update">update(enterpriseId, collectionId, userId, body)</code>
200 <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.
201
202Args:
203 enterpriseId: string, The ID of the enterprise. (required)
204 collectionId: string, The ID of the collection. (required)
205 userId: string, The ID of the user. (required)
206 body: object, The request body. (required)
207 The object takes the form of:
208
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]209{ # A Users resource represents an account associated with an enterprise. The account may be specific to a device or to an individual user (who can then use the account across multiple devices). The account may provide access to Google Play for Work only, or to other Google services, depending on the identity model:
210 # - Google managed domain identity model requires synchronization to Google account sources (via primaryEmail).
211 # - Android for Work Accounts identity model provides a dynamic means for enterprises to create user or device accounts as needed. These accounts provide access to Google Play for Work only.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]212 "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user".
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]213 "displayName": "A String", # The name that will appear in user interfaces. Setting this property is optional when creating EMM-managed users. If you do set this property, use something generic about the organization (such as "Example, Inc.") or your name (as EMM). Not used for Google-managed user accounts.
214 "accountIdentifier": "A String", # A unique identifier you create for this user, such as "user342" or "asset#44418". Do not use personally identifiable information (PII) for this property. Must always be set for EMM-managed users. Not set for Google-managed users.
215 "managementType": "A String", # The entity that manages the user. With googleManaged users, the source of truth is Google so EMMs have to make sure a Google Account exists for the user. With emmManaged users, the EMM is in charge.
216 "primaryEmail": "A String", # The user's primary email address, for example, "jsmith@example.com". Will always be set for Google managed users and not set for EMM managed users.
217 "accountType": "A String", # The type of account that this user represents. A userAccount can be installed on multiple devices, but a deviceAccount is specific to a single device. An EMM-managed user (emmManaged) can be either type (userAccount, deviceAccount), but a Google-managed user (googleManaged) is always a userAccount.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]218 "id": "A String", # The unique ID for the user.
219 }
220
221
222Returns:
223 An object of the form:
224
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]225 { # A Users resource represents an account associated with an enterprise. The account may be specific to a device or to an individual user (who can then use the account across multiple devices). The account may provide access to Google Play for Work only, or to other Google services, depending on the identity model:
226 # - Google managed domain identity model requires synchronization to Google account sources (via primaryEmail).
227 # - Android for Work Accounts identity model provides a dynamic means for enterprises to create user or device accounts as needed. These accounts provide access to Google Play for Work only.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]228 "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user".
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]229 "displayName": "A String", # The name that will appear in user interfaces. Setting this property is optional when creating EMM-managed users. If you do set this property, use something generic about the organization (such as "Example, Inc.") or your name (as EMM). Not used for Google-managed user accounts.
230 "accountIdentifier": "A String", # A unique identifier you create for this user, such as "user342" or "asset#44418". Do not use personally identifiable information (PII) for this property. Must always be set for EMM-managed users. Not set for Google-managed users.
231 "managementType": "A String", # The entity that manages the user. With googleManaged users, the source of truth is Google so EMMs have to make sure a Google Account exists for the user. With emmManaged users, the EMM is in charge.
232 "primaryEmail": "A String", # The user's primary email address, for example, "jsmith@example.com". Will always be set for Google managed users and not set for EMM managed users.
233 "accountType": "A String", # The type of account that this user represents. A userAccount can be installed on multiple devices, but a deviceAccount is specific to a single device. An EMM-managed user (emmManaged) can be either type (userAccount, deviceAccount), but a Google-managed user (googleManaged) is always a userAccount.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]234 "id": "A String", # The unique ID for the user.
235 }</pre>
236</div>
237
238</body></html>