• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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
75<h1><a href="androidenterprise_v1.html">Google Play EMM API</a> . <a href="androidenterprise_v1.managedconfigurationsforuser.html">managedconfigurationsforuser</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#delete">delete(enterpriseId, userId, managedConfigurationForUserId)</a></code></p>
79<p class="firstline">Removes a per-user managed configuration for an app for the specified user.</p>
80<p class="toc_element">
81  <code><a href="#get">get(enterpriseId, userId, managedConfigurationForUserId)</a></code></p>
82<p class="firstline">Retrieves details of a per-user managed configuration for an app for the specified user.</p>
83<p class="toc_element">
84  <code><a href="#list">list(enterpriseId, userId)</a></code></p>
85<p class="firstline">Lists all the per-user managed configurations for the specified user. Only the ID is set.</p>
86<p class="toc_element">
87  <code><a href="#patch">patch(enterpriseId, userId, managedConfigurationForUserId, body)</a></code></p>
88<p class="firstline">Adds or updates the managed configuration settings for an app for the specified user. If you support the Managed configurations iframe, you can apply managed configurations to a user by specifying an mcmId and its associated configuration variables (if any) in the request. Alternatively, all EMMs can apply managed configurations by passing a list of managed properties. This method supports patch semantics.</p>
89<p class="toc_element">
90  <code><a href="#update">update(enterpriseId, userId, managedConfigurationForUserId, body)</a></code></p>
91<p class="firstline">Adds or updates the managed configuration settings for an app for the specified user. If you support the Managed configurations iframe, you can apply managed configurations to a user by specifying an mcmId and its associated configuration variables (if any) in the request. Alternatively, all EMMs can apply managed configurations by passing a list of managed properties.</p>
92<h3>Method Details</h3>
93<div class="method">
94    <code class="details" id="delete">delete(enterpriseId, userId, managedConfigurationForUserId)</code>
95  <pre>Removes a per-user managed configuration for an app for the specified user.
96
97Args:
98  enterpriseId: string, The ID of the enterprise. (required)
99  userId: string, The ID of the user. (required)
100  managedConfigurationForUserId: string, The ID of the managed configuration (a product ID), e.g. "app:com.google.android.gm". (required)
101</pre>
102</div>
103
104<div class="method">
105    <code class="details" id="get">get(enterpriseId, userId, managedConfigurationForUserId)</code>
106  <pre>Retrieves details of a per-user managed configuration for an app for the specified user.
107
108Args:
109  enterpriseId: string, The ID of the enterprise. (required)
110  userId: string, The ID of the user. (required)
111  managedConfigurationForUserId: string, The ID of the managed configuration (a product ID), e.g. "app:com.google.android.gm". (required)
112
113Returns:
114  An object of the form:
115
116    { # A managed configuration resource contains the set of managed properties defined by the app developer in the app's managed configurations schema, as well as any configuration variables defined for the user.
117    "kind": "androidenterprise#managedConfiguration", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#managedConfiguration".
118    "configurationVariables": { # A configuration variables resource contains the managed configuration settings ID to be applied to a single user, as well as the variable set that is attributed to the user. The variable set will be used to replace placeholders in the managed configuration settings. # Contains the ID of the managed configuration profile and the set of configuration variables (if any) defined for the user.
119      "kind": "androidenterprise#configurationVariables", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#configurationVariables".
120      "variableSet": [ # The variable set that is attributed to the user.
121        { # A variable set is a key-value pair of EMM-provided placeholders and its corresponding value, which is attributed to a user. For example, $FIRSTNAME could be a placeholder, and its value could be Alice. Placeholders should start with a '$' sign and should be alphanumeric only.
122          "userValue": "A String", # The value of the placeholder, specific to the user.
123          "kind": "androidenterprise#variableSet", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#variableSet".
124          "placeholder": "A String", # The placeholder string; defined by EMM.
125        },
126      ],
127      "mcmId": "A String", # The ID of the managed configurations settings.
128    },
129    "managedProperty": [ # The set of managed properties for this configuration.
130      { # A managed property of a managed configuration. The property must match one of the properties in the app restrictions schema of the product. Exactly one of the value fields must be populated, and it must match the property's type in the app restrictions schema.
131        "key": "A String", # The unique key that identifies the property.
132        "valueInteger": 42, # The integer value - this will only be present if type of the property is integer.
133        "valueStringArray": [ # The list of string values - this will only be present if type of the property is multiselect.
134          "A String",
135        ],
136        "valueBool": True or False, # The boolean value - this will only be present if type of the property is bool.
137        "valueBundleArray": [ # The list of bundles of properties - this will only be present if type of the property is bundle_array.
138          { # A bundle of managed properties.
139            "managedProperty": [ # The list of managed properties.
140              # Object with schema name: ManagedProperty
141            ],
142          },
143        ],
144        "valueBundle": { # A bundle of managed properties. # The bundle of managed properties - this will only be present if type of the property is bundle.
145          "managedProperty": [ # The list of managed properties.
146            # Object with schema name: ManagedProperty
147          ],
148        },
149        "valueString": "A String", # The string value - this will only be present if type of the property is string, choice or hidden.
150      },
151    ],
152    "productId": "A String", # The ID of the product that the managed configuration is for, e.g. "app:com.google.android.gm".
153  }</pre>
154</div>
155
156<div class="method">
157    <code class="details" id="list">list(enterpriseId, userId)</code>
158  <pre>Lists all the per-user managed configurations for the specified user. Only the ID is set.
159
160Args:
161  enterpriseId: string, The ID of the enterprise. (required)
162  userId: string, The ID of the user. (required)
163
164Returns:
165  An object of the form:
166
167    { # The managed configuration resources for the user.
168    "kind": "androidenterprise#managedConfigurationsForUserListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#managedConfigurationsForUserListResponse".
169    "managedConfigurationForUser": [ # A managed configuration for an app for a specific user.
170      { # A managed configuration resource contains the set of managed properties defined by the app developer in the app's managed configurations schema, as well as any configuration variables defined for the user.
171        "kind": "androidenterprise#managedConfiguration", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#managedConfiguration".
172        "configurationVariables": { # A configuration variables resource contains the managed configuration settings ID to be applied to a single user, as well as the variable set that is attributed to the user. The variable set will be used to replace placeholders in the managed configuration settings. # Contains the ID of the managed configuration profile and the set of configuration variables (if any) defined for the user.
173          "kind": "androidenterprise#configurationVariables", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#configurationVariables".
174          "variableSet": [ # The variable set that is attributed to the user.
175            { # A variable set is a key-value pair of EMM-provided placeholders and its corresponding value, which is attributed to a user. For example, $FIRSTNAME could be a placeholder, and its value could be Alice. Placeholders should start with a '$' sign and should be alphanumeric only.
176              "userValue": "A String", # The value of the placeholder, specific to the user.
177              "kind": "androidenterprise#variableSet", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#variableSet".
178              "placeholder": "A String", # The placeholder string; defined by EMM.
179            },
180          ],
181          "mcmId": "A String", # The ID of the managed configurations settings.
182        },
183        "managedProperty": [ # The set of managed properties for this configuration.
184          { # A managed property of a managed configuration. The property must match one of the properties in the app restrictions schema of the product. Exactly one of the value fields must be populated, and it must match the property's type in the app restrictions schema.
185            "key": "A String", # The unique key that identifies the property.
186            "valueInteger": 42, # The integer value - this will only be present if type of the property is integer.
187            "valueStringArray": [ # The list of string values - this will only be present if type of the property is multiselect.
188              "A String",
189            ],
190            "valueBool": True or False, # The boolean value - this will only be present if type of the property is bool.
191            "valueBundleArray": [ # The list of bundles of properties - this will only be present if type of the property is bundle_array.
192              { # A bundle of managed properties.
193                "managedProperty": [ # The list of managed properties.
194                  # Object with schema name: ManagedProperty
195                ],
196              },
197            ],
198            "valueBundle": { # A bundle of managed properties. # The bundle of managed properties - this will only be present if type of the property is bundle.
199              "managedProperty": [ # The list of managed properties.
200                # Object with schema name: ManagedProperty
201              ],
202            },
203            "valueString": "A String", # The string value - this will only be present if type of the property is string, choice or hidden.
204          },
205        ],
206        "productId": "A String", # The ID of the product that the managed configuration is for, e.g. "app:com.google.android.gm".
207      },
208    ],
209  }</pre>
210</div>
211
212<div class="method">
213    <code class="details" id="patch">patch(enterpriseId, userId, managedConfigurationForUserId, body)</code>
214  <pre>Adds or updates the managed configuration settings for an app for the specified user. If you support the Managed configurations iframe, you can apply managed configurations to a user by specifying an mcmId and its associated configuration variables (if any) in the request. Alternatively, all EMMs can apply managed configurations by passing a list of managed properties. This method supports patch semantics.
215
216Args:
217  enterpriseId: string, The ID of the enterprise. (required)
218  userId: string, The ID of the user. (required)
219  managedConfigurationForUserId: string, The ID of the managed configuration (a product ID), e.g. "app:com.google.android.gm". (required)
220  body: object, The request body. (required)
221    The object takes the form of:
222
223{ # A managed configuration resource contains the set of managed properties defined by the app developer in the app's managed configurations schema, as well as any configuration variables defined for the user.
224  "kind": "androidenterprise#managedConfiguration", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#managedConfiguration".
225  "configurationVariables": { # A configuration variables resource contains the managed configuration settings ID to be applied to a single user, as well as the variable set that is attributed to the user. The variable set will be used to replace placeholders in the managed configuration settings. # Contains the ID of the managed configuration profile and the set of configuration variables (if any) defined for the user.
226    "kind": "androidenterprise#configurationVariables", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#configurationVariables".
227    "variableSet": [ # The variable set that is attributed to the user.
228      { # A variable set is a key-value pair of EMM-provided placeholders and its corresponding value, which is attributed to a user. For example, $FIRSTNAME could be a placeholder, and its value could be Alice. Placeholders should start with a '$' sign and should be alphanumeric only.
229        "userValue": "A String", # The value of the placeholder, specific to the user.
230        "kind": "androidenterprise#variableSet", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#variableSet".
231        "placeholder": "A String", # The placeholder string; defined by EMM.
232      },
233    ],
234    "mcmId": "A String", # The ID of the managed configurations settings.
235  },
236  "managedProperty": [ # The set of managed properties for this configuration.
237    { # A managed property of a managed configuration. The property must match one of the properties in the app restrictions schema of the product. Exactly one of the value fields must be populated, and it must match the property's type in the app restrictions schema.
238      "key": "A String", # The unique key that identifies the property.
239      "valueInteger": 42, # The integer value - this will only be present if type of the property is integer.
240      "valueStringArray": [ # The list of string values - this will only be present if type of the property is multiselect.
241        "A String",
242      ],
243      "valueBool": True or False, # The boolean value - this will only be present if type of the property is bool.
244      "valueBundleArray": [ # The list of bundles of properties - this will only be present if type of the property is bundle_array.
245        { # A bundle of managed properties.
246          "managedProperty": [ # The list of managed properties.
247            # Object with schema name: ManagedProperty
248          ],
249        },
250      ],
251      "valueBundle": { # A bundle of managed properties. # The bundle of managed properties - this will only be present if type of the property is bundle.
252        "managedProperty": [ # The list of managed properties.
253          # Object with schema name: ManagedProperty
254        ],
255      },
256      "valueString": "A String", # The string value - this will only be present if type of the property is string, choice or hidden.
257    },
258  ],
259  "productId": "A String", # The ID of the product that the managed configuration is for, e.g. "app:com.google.android.gm".
260}
261
262
263Returns:
264  An object of the form:
265
266    { # A managed configuration resource contains the set of managed properties defined by the app developer in the app's managed configurations schema, as well as any configuration variables defined for the user.
267    "kind": "androidenterprise#managedConfiguration", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#managedConfiguration".
268    "configurationVariables": { # A configuration variables resource contains the managed configuration settings ID to be applied to a single user, as well as the variable set that is attributed to the user. The variable set will be used to replace placeholders in the managed configuration settings. # Contains the ID of the managed configuration profile and the set of configuration variables (if any) defined for the user.
269      "kind": "androidenterprise#configurationVariables", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#configurationVariables".
270      "variableSet": [ # The variable set that is attributed to the user.
271        { # A variable set is a key-value pair of EMM-provided placeholders and its corresponding value, which is attributed to a user. For example, $FIRSTNAME could be a placeholder, and its value could be Alice. Placeholders should start with a '$' sign and should be alphanumeric only.
272          "userValue": "A String", # The value of the placeholder, specific to the user.
273          "kind": "androidenterprise#variableSet", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#variableSet".
274          "placeholder": "A String", # The placeholder string; defined by EMM.
275        },
276      ],
277      "mcmId": "A String", # The ID of the managed configurations settings.
278    },
279    "managedProperty": [ # The set of managed properties for this configuration.
280      { # A managed property of a managed configuration. The property must match one of the properties in the app restrictions schema of the product. Exactly one of the value fields must be populated, and it must match the property's type in the app restrictions schema.
281        "key": "A String", # The unique key that identifies the property.
282        "valueInteger": 42, # The integer value - this will only be present if type of the property is integer.
283        "valueStringArray": [ # The list of string values - this will only be present if type of the property is multiselect.
284          "A String",
285        ],
286        "valueBool": True or False, # The boolean value - this will only be present if type of the property is bool.
287        "valueBundleArray": [ # The list of bundles of properties - this will only be present if type of the property is bundle_array.
288          { # A bundle of managed properties.
289            "managedProperty": [ # The list of managed properties.
290              # Object with schema name: ManagedProperty
291            ],
292          },
293        ],
294        "valueBundle": { # A bundle of managed properties. # The bundle of managed properties - this will only be present if type of the property is bundle.
295          "managedProperty": [ # The list of managed properties.
296            # Object with schema name: ManagedProperty
297          ],
298        },
299        "valueString": "A String", # The string value - this will only be present if type of the property is string, choice or hidden.
300      },
301    ],
302    "productId": "A String", # The ID of the product that the managed configuration is for, e.g. "app:com.google.android.gm".
303  }</pre>
304</div>
305
306<div class="method">
307    <code class="details" id="update">update(enterpriseId, userId, managedConfigurationForUserId, body)</code>
308  <pre>Adds or updates the managed configuration settings for an app for the specified user. If you support the Managed configurations iframe, you can apply managed configurations to a user by specifying an mcmId and its associated configuration variables (if any) in the request. Alternatively, all EMMs can apply managed configurations by passing a list of managed properties.
309
310Args:
311  enterpriseId: string, The ID of the enterprise. (required)
312  userId: string, The ID of the user. (required)
313  managedConfigurationForUserId: string, The ID of the managed configuration (a product ID), e.g. "app:com.google.android.gm". (required)
314  body: object, The request body. (required)
315    The object takes the form of:
316
317{ # A managed configuration resource contains the set of managed properties defined by the app developer in the app's managed configurations schema, as well as any configuration variables defined for the user.
318  "kind": "androidenterprise#managedConfiguration", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#managedConfiguration".
319  "configurationVariables": { # A configuration variables resource contains the managed configuration settings ID to be applied to a single user, as well as the variable set that is attributed to the user. The variable set will be used to replace placeholders in the managed configuration settings. # Contains the ID of the managed configuration profile and the set of configuration variables (if any) defined for the user.
320    "kind": "androidenterprise#configurationVariables", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#configurationVariables".
321    "variableSet": [ # The variable set that is attributed to the user.
322      { # A variable set is a key-value pair of EMM-provided placeholders and its corresponding value, which is attributed to a user. For example, $FIRSTNAME could be a placeholder, and its value could be Alice. Placeholders should start with a '$' sign and should be alphanumeric only.
323        "userValue": "A String", # The value of the placeholder, specific to the user.
324        "kind": "androidenterprise#variableSet", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#variableSet".
325        "placeholder": "A String", # The placeholder string; defined by EMM.
326      },
327    ],
328    "mcmId": "A String", # The ID of the managed configurations settings.
329  },
330  "managedProperty": [ # The set of managed properties for this configuration.
331    { # A managed property of a managed configuration. The property must match one of the properties in the app restrictions schema of the product. Exactly one of the value fields must be populated, and it must match the property's type in the app restrictions schema.
332      "key": "A String", # The unique key that identifies the property.
333      "valueInteger": 42, # The integer value - this will only be present if type of the property is integer.
334      "valueStringArray": [ # The list of string values - this will only be present if type of the property is multiselect.
335        "A String",
336      ],
337      "valueBool": True or False, # The boolean value - this will only be present if type of the property is bool.
338      "valueBundleArray": [ # The list of bundles of properties - this will only be present if type of the property is bundle_array.
339        { # A bundle of managed properties.
340          "managedProperty": [ # The list of managed properties.
341            # Object with schema name: ManagedProperty
342          ],
343        },
344      ],
345      "valueBundle": { # A bundle of managed properties. # The bundle of managed properties - this will only be present if type of the property is bundle.
346        "managedProperty": [ # The list of managed properties.
347          # Object with schema name: ManagedProperty
348        ],
349      },
350      "valueString": "A String", # The string value - this will only be present if type of the property is string, choice or hidden.
351    },
352  ],
353  "productId": "A String", # The ID of the product that the managed configuration is for, e.g. "app:com.google.android.gm".
354}
355
356
357Returns:
358  An object of the form:
359
360    { # A managed configuration resource contains the set of managed properties defined by the app developer in the app's managed configurations schema, as well as any configuration variables defined for the user.
361    "kind": "androidenterprise#managedConfiguration", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#managedConfiguration".
362    "configurationVariables": { # A configuration variables resource contains the managed configuration settings ID to be applied to a single user, as well as the variable set that is attributed to the user. The variable set will be used to replace placeholders in the managed configuration settings. # Contains the ID of the managed configuration profile and the set of configuration variables (if any) defined for the user.
363      "kind": "androidenterprise#configurationVariables", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#configurationVariables".
364      "variableSet": [ # The variable set that is attributed to the user.
365        { # A variable set is a key-value pair of EMM-provided placeholders and its corresponding value, which is attributed to a user. For example, $FIRSTNAME could be a placeholder, and its value could be Alice. Placeholders should start with a '$' sign and should be alphanumeric only.
366          "userValue": "A String", # The value of the placeholder, specific to the user.
367          "kind": "androidenterprise#variableSet", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#variableSet".
368          "placeholder": "A String", # The placeholder string; defined by EMM.
369        },
370      ],
371      "mcmId": "A String", # The ID of the managed configurations settings.
372    },
373    "managedProperty": [ # The set of managed properties for this configuration.
374      { # A managed property of a managed configuration. The property must match one of the properties in the app restrictions schema of the product. Exactly one of the value fields must be populated, and it must match the property's type in the app restrictions schema.
375        "key": "A String", # The unique key that identifies the property.
376        "valueInteger": 42, # The integer value - this will only be present if type of the property is integer.
377        "valueStringArray": [ # The list of string values - this will only be present if type of the property is multiselect.
378          "A String",
379        ],
380        "valueBool": True or False, # The boolean value - this will only be present if type of the property is bool.
381        "valueBundleArray": [ # The list of bundles of properties - this will only be present if type of the property is bundle_array.
382          { # A bundle of managed properties.
383            "managedProperty": [ # The list of managed properties.
384              # Object with schema name: ManagedProperty
385            ],
386          },
387        ],
388        "valueBundle": { # A bundle of managed properties. # The bundle of managed properties - this will only be present if type of the property is bundle.
389          "managedProperty": [ # The list of managed properties.
390            # Object with schema name: ManagedProperty
391          ],
392        },
393        "valueString": "A String", # The string value - this will only be present if type of the property is string, choice or hidden.
394      },
395    ],
396    "productId": "A String", # The ID of the product that the managed configuration is for, e.g. "app:com.google.android.gm".
397  }</pre>
398</div>
399
400</body></html>