File: androidenterprise_v1.managedconfigurationsforuser.html

package info (click to toggle)
python-googleapi 2.180.0-1
  • links: PTS
  • area: main
  • in suites: forky, sid
  • size: 527,124 kB
  • sloc: python: 11,076; javascript: 249; sh: 114; makefile: 59
file content (318 lines) | stat: -rw-r--r-- 18,283 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="androidenterprise_v1.html">Google Play EMM API</a> . <a href="androidenterprise_v1.managedconfigurationsforuser.html">managedconfigurationsforuser</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#delete">delete(enterpriseId, userId, managedConfigurationForUserId, x__xgafv=None)</a></code></p>
<p class="firstline">Removes a per-user managed configuration for an app for the specified user.</p>
<p class="toc_element">
  <code><a href="#get">get(enterpriseId, userId, managedConfigurationForUserId, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves details of a per-user managed configuration for an app for the specified user.</p>
<p class="toc_element">
  <code><a href="#list">list(enterpriseId, userId, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all the per-user managed configurations for the specified user. Only the ID is set.</p>
<p class="toc_element">
  <code><a href="#update">update(enterpriseId, userId, managedConfigurationForUserId, body=None, x__xgafv=None)</a></code></p>
<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>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="delete">delete(enterpriseId, userId, managedConfigurationForUserId, x__xgafv=None)</code>
  <pre>Removes a per-user managed configuration for an app for the specified user.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  userId: string, The ID of the user. (required)
  managedConfigurationForUserId: string, The ID of the managed configuration (a product ID), e.g. &quot;app:com.google.android.gm&quot;. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format
</pre>
</div>

<div class="method">
    <code class="details" id="get">get(enterpriseId, userId, managedConfigurationForUserId, x__xgafv=None)</code>
  <pre>Retrieves details of a per-user managed configuration for an app for the specified user.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  userId: string, The ID of the user. (required)
  managedConfigurationForUserId: string, The ID of the managed configuration (a product ID), e.g. &quot;app:com.google.android.gm&quot;. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { #  *Deprecated:* New integrations cannot use this method and can refer to our new recommendations
  &quot;configurationVariables&quot;: { # 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.
    &quot;mcmId&quot;: &quot;A String&quot;, # The ID of the managed configurations settings.
    &quot;variableSet&quot;: [ # The variable set that is attributed to the user.
      { # 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 &#x27;$&#x27; sign and should be alphanumeric only.
        &quot;placeholder&quot;: &quot;A String&quot;, # The placeholder string; defined by EMM.
        &quot;userValue&quot;: &quot;A String&quot;, # The value of the placeholder, specific to the user.
      },
    ],
  },
  &quot;kind&quot;: &quot;A String&quot;, # Deprecated.
  &quot;managedProperty&quot;: [ # The set of managed properties for this configuration.
    { # 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&#x27;s type in the app restrictions schema.
      &quot;key&quot;: &quot;A String&quot;, # The unique key that identifies the property.
      &quot;valueBool&quot;: True or False, # The boolean value - this will only be present if type of the property is bool.
      &quot;valueBundle&quot;: { # A bundle of managed properties. # The bundle of managed properties - this will only be present if type of the property is bundle.
        &quot;managedProperty&quot;: [ # The list of managed properties.
          # Object with schema name: ManagedProperty
        ],
      },
      &quot;valueBundleArray&quot;: [ # The list of bundles of properties - this will only be present if type of the property is bundle_array.
        { # A bundle of managed properties.
          &quot;managedProperty&quot;: [ # The list of managed properties.
            # Object with schema name: ManagedProperty
          ],
        },
      ],
      &quot;valueInteger&quot;: 42, # The integer value - this will only be present if type of the property is integer.
      &quot;valueString&quot;: &quot;A String&quot;, # The string value - this will only be present if type of the property is string, choice or hidden.
      &quot;valueStringArray&quot;: [ # The list of string values - this will only be present if type of the property is multiselect.
        &quot;A String&quot;,
      ],
    },
  ],
  &quot;productId&quot;: &quot;A String&quot;, # The ID of the product that the managed configuration is for, e.g. &quot;app:com.google.android.gm&quot;.
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(enterpriseId, userId, x__xgafv=None)</code>
  <pre>Lists all the per-user managed configurations for the specified user. Only the ID is set.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  userId: string, The ID of the user. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  &quot;managedConfigurationForUser&quot;: [ # A managed configuration for an app for a specific user.
    { #  *Deprecated:* New integrations cannot use this method and can refer to our new recommendations
      &quot;configurationVariables&quot;: { # 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.
        &quot;mcmId&quot;: &quot;A String&quot;, # The ID of the managed configurations settings.
        &quot;variableSet&quot;: [ # The variable set that is attributed to the user.
          { # 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 &#x27;$&#x27; sign and should be alphanumeric only.
            &quot;placeholder&quot;: &quot;A String&quot;, # The placeholder string; defined by EMM.
            &quot;userValue&quot;: &quot;A String&quot;, # The value of the placeholder, specific to the user.
          },
        ],
      },
      &quot;kind&quot;: &quot;A String&quot;, # Deprecated.
      &quot;managedProperty&quot;: [ # The set of managed properties for this configuration.
        { # 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&#x27;s type in the app restrictions schema.
          &quot;key&quot;: &quot;A String&quot;, # The unique key that identifies the property.
          &quot;valueBool&quot;: True or False, # The boolean value - this will only be present if type of the property is bool.
          &quot;valueBundle&quot;: { # A bundle of managed properties. # The bundle of managed properties - this will only be present if type of the property is bundle.
            &quot;managedProperty&quot;: [ # The list of managed properties.
              # Object with schema name: ManagedProperty
            ],
          },
          &quot;valueBundleArray&quot;: [ # The list of bundles of properties - this will only be present if type of the property is bundle_array.
            { # A bundle of managed properties.
              &quot;managedProperty&quot;: [ # The list of managed properties.
                # Object with schema name: ManagedProperty
              ],
            },
          ],
          &quot;valueInteger&quot;: 42, # The integer value - this will only be present if type of the property is integer.
          &quot;valueString&quot;: &quot;A String&quot;, # The string value - this will only be present if type of the property is string, choice or hidden.
          &quot;valueStringArray&quot;: [ # The list of string values - this will only be present if type of the property is multiselect.
            &quot;A String&quot;,
          ],
        },
      ],
      &quot;productId&quot;: &quot;A String&quot;, # The ID of the product that the managed configuration is for, e.g. &quot;app:com.google.android.gm&quot;.
    },
  ],
}</pre>
</div>

<div class="method">
    <code class="details" id="update">update(enterpriseId, userId, managedConfigurationForUserId, body=None, x__xgafv=None)</code>
  <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.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  userId: string, The ID of the user. (required)
  managedConfigurationForUserId: string, The ID of the managed configuration (a product ID), e.g. &quot;app:com.google.android.gm&quot;. (required)
  body: object, The request body.
    The object takes the form of:

{ #  *Deprecated:* New integrations cannot use this method and can refer to our new recommendations
  &quot;configurationVariables&quot;: { # 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.
    &quot;mcmId&quot;: &quot;A String&quot;, # The ID of the managed configurations settings.
    &quot;variableSet&quot;: [ # The variable set that is attributed to the user.
      { # 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 &#x27;$&#x27; sign and should be alphanumeric only.
        &quot;placeholder&quot;: &quot;A String&quot;, # The placeholder string; defined by EMM.
        &quot;userValue&quot;: &quot;A String&quot;, # The value of the placeholder, specific to the user.
      },
    ],
  },
  &quot;kind&quot;: &quot;A String&quot;, # Deprecated.
  &quot;managedProperty&quot;: [ # The set of managed properties for this configuration.
    { # 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&#x27;s type in the app restrictions schema.
      &quot;key&quot;: &quot;A String&quot;, # The unique key that identifies the property.
      &quot;valueBool&quot;: True or False, # The boolean value - this will only be present if type of the property is bool.
      &quot;valueBundle&quot;: { # A bundle of managed properties. # The bundle of managed properties - this will only be present if type of the property is bundle.
        &quot;managedProperty&quot;: [ # The list of managed properties.
          # Object with schema name: ManagedProperty
        ],
      },
      &quot;valueBundleArray&quot;: [ # The list of bundles of properties - this will only be present if type of the property is bundle_array.
        { # A bundle of managed properties.
          &quot;managedProperty&quot;: [ # The list of managed properties.
            # Object with schema name: ManagedProperty
          ],
        },
      ],
      &quot;valueInteger&quot;: 42, # The integer value - this will only be present if type of the property is integer.
      &quot;valueString&quot;: &quot;A String&quot;, # The string value - this will only be present if type of the property is string, choice or hidden.
      &quot;valueStringArray&quot;: [ # The list of string values - this will only be present if type of the property is multiselect.
        &quot;A String&quot;,
      ],
    },
  ],
  &quot;productId&quot;: &quot;A String&quot;, # The ID of the product that the managed configuration is for, e.g. &quot;app:com.google.android.gm&quot;.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { #  *Deprecated:* New integrations cannot use this method and can refer to our new recommendations
  &quot;configurationVariables&quot;: { # 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.
    &quot;mcmId&quot;: &quot;A String&quot;, # The ID of the managed configurations settings.
    &quot;variableSet&quot;: [ # The variable set that is attributed to the user.
      { # 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 &#x27;$&#x27; sign and should be alphanumeric only.
        &quot;placeholder&quot;: &quot;A String&quot;, # The placeholder string; defined by EMM.
        &quot;userValue&quot;: &quot;A String&quot;, # The value of the placeholder, specific to the user.
      },
    ],
  },
  &quot;kind&quot;: &quot;A String&quot;, # Deprecated.
  &quot;managedProperty&quot;: [ # The set of managed properties for this configuration.
    { # 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&#x27;s type in the app restrictions schema.
      &quot;key&quot;: &quot;A String&quot;, # The unique key that identifies the property.
      &quot;valueBool&quot;: True or False, # The boolean value - this will only be present if type of the property is bool.
      &quot;valueBundle&quot;: { # A bundle of managed properties. # The bundle of managed properties - this will only be present if type of the property is bundle.
        &quot;managedProperty&quot;: [ # The list of managed properties.
          # Object with schema name: ManagedProperty
        ],
      },
      &quot;valueBundleArray&quot;: [ # The list of bundles of properties - this will only be present if type of the property is bundle_array.
        { # A bundle of managed properties.
          &quot;managedProperty&quot;: [ # The list of managed properties.
            # Object with schema name: ManagedProperty
          ],
        },
      ],
      &quot;valueInteger&quot;: 42, # The integer value - this will only be present if type of the property is integer.
      &quot;valueString&quot;: &quot;A String&quot;, # The string value - this will only be present if type of the property is string, choice or hidden.
      &quot;valueStringArray&quot;: [ # The list of string values - this will only be present if type of the property is multiselect.
        &quot;A String&quot;,
      ],
    },
  ],
  &quot;productId&quot;: &quot;A String&quot;, # The ID of the product that the managed configuration is for, e.g. &quot;app:com.google.android.gm&quot;.
}</pre>
</div>

</body></html>