Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 8045c4550a7f366dd071a6ffb27dba362e59bf95 / . / docs / dyn / androidenterprise_v1.entitlements.html
blob: f13e292139d7af3b7ffe6a516b71821f4c0d6cb7 [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.entitlements.html">entitlements</a></h1>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]81 <code><a href="#delete">delete(enterpriseId, userId, entitlementId, x__xgafv=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]82<p class="firstline">Removes an entitlement to an app for a user.</p>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]83<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]84 <code><a href="#get">get(enterpriseId, userId, entitlementId, x__xgafv=None)</a></code></p>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]85<p class="firstline">Retrieves details of an entitlement.</p>
86<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]87 <code><a href="#list">list(enterpriseId, userId, x__xgafv=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]88<p class="firstline">Lists all entitlements for the specified user. Only the ID is set.</p>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]89<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]90 <code><a href="#update">update(enterpriseId, userId, entitlementId, body=None, install=None, x__xgafv=None)</a></code></p>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]91<p class="firstline">Adds or updates an entitlement to an app for a user.</p>
92<h3>Method Details</h3>
93<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]94 <code class="details" id="close">close()</code>
95 <pre>Close httplib2 connections.</pre>
96</div>
97
98<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]99 <code class="details" id="delete">delete(enterpriseId, userId, entitlementId, x__xgafv=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]100 <pre>Removes an entitlement to an app for a user.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]101
102Args:
103 enterpriseId: string, The ID of the enterprise. (required)
104 userId: string, The ID of the user. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]105 entitlementId: string, The ID of the entitlement (a product ID), e.g. &quot;app:com.google.android.gm&quot;. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]106 x__xgafv: string, V1 error format.
107 Allowed values
108 1 - v1 error format
109 2 - v2 error format
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]110</pre>
111</div>
112
113<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]114 <code class="details" id="get">get(enterpriseId, userId, entitlementId, x__xgafv=None)</code>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]115 <pre>Retrieves details of an entitlement.
116
117Args:
118 enterpriseId: string, The ID of the enterprise. (required)
119 userId: string, The ID of the user. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]120 entitlementId: string, The ID of the entitlement (a product ID), e.g. &quot;app:com.google.android.gm&quot;. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]121 x__xgafv: string, V1 error format.
122 Allowed values
123 1 - v1 error format
124 2 - v2 error format
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]125
126Returns:
127 An object of the form:
128
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]129 { # The presence of an Entitlements resource indicates that a user has the right to use a particular app. Entitlements are user specific, not device specific. This allows a user with an entitlement to an app to install the app on all their devices. It&#x27;s also possible for a user to hold an entitlement to an app without installing the app on any device. The API can be used to create an entitlement. As an option, you can also use the API to trigger the installation of an app on all a user&#x27;s managed devices at the same time the entitlement is created. If the app is free, creating the entitlement also creates a group license for that app. For paid apps, creating the entitlement consumes one license, and that license remains consumed until the entitlement is removed. If the enterprise hasn&#x27;t purchased enough licenses, then no entitlement is created and the installation fails. An entitlement is also not created for an app if the app requires permissions that the enterprise hasn&#x27;t accepted. If an entitlement is deleted, the app may be uninstalled from a user&#x27;s device. As a best practice, uninstall the app by calling Installs.delete() before deleting the entitlement. Entitlements for apps that a user pays for on an unmanaged profile have &quot;userPurchase&quot; as the entitlement reason. These entitlements cannot be removed via the API.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]130 &quot;productId&quot;: &quot;A String&quot;, # The ID of the product that the entitlement is for. For example, &quot;app:com.google.android.gm&quot;.
131 &quot;reason&quot;: &quot;A String&quot;, # The reason for the entitlement. For example, &quot;free&quot; for free apps. This property is temporary: it will be replaced by the acquisition kind field of group licenses.
132}</pre>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]133</div>
134
135<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]136 <code class="details" id="list">list(enterpriseId, userId, x__xgafv=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]137 <pre>Lists all entitlements for the specified user. Only the ID is set.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]138
139Args:
140 enterpriseId: string, The ID of the enterprise. (required)
141 userId: string, The ID of the user. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]142 x__xgafv: string, V1 error format.
143 Allowed values
144 1 - v1 error format
145 2 - v2 error format
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]146
147Returns:
148 An object of the form:
149
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]150 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]151 &quot;entitlement&quot;: [ # An entitlement of a user to a product (e.g. an app). For example, a free app that they have installed, or a paid app that they have been allocated a license to.
152 { # The presence of an Entitlements resource indicates that a user has the right to use a particular app. Entitlements are user specific, not device specific. This allows a user with an entitlement to an app to install the app on all their devices. It&#x27;s also possible for a user to hold an entitlement to an app without installing the app on any device. The API can be used to create an entitlement. As an option, you can also use the API to trigger the installation of an app on all a user&#x27;s managed devices at the same time the entitlement is created. If the app is free, creating the entitlement also creates a group license for that app. For paid apps, creating the entitlement consumes one license, and that license remains consumed until the entitlement is removed. If the enterprise hasn&#x27;t purchased enough licenses, then no entitlement is created and the installation fails. An entitlement is also not created for an app if the app requires permissions that the enterprise hasn&#x27;t accepted. If an entitlement is deleted, the app may be uninstalled from a user&#x27;s device. As a best practice, uninstall the app by calling Installs.delete() before deleting the entitlement. Entitlements for apps that a user pays for on an unmanaged profile have &quot;userPurchase&quot; as the entitlement reason. These entitlements cannot be removed via the API.
153 &quot;productId&quot;: &quot;A String&quot;, # The ID of the product that the entitlement is for. For example, &quot;app:com.google.android.gm&quot;.
154 &quot;reason&quot;: &quot;A String&quot;, # The reason for the entitlement. For example, &quot;free&quot; for free apps. This property is temporary: it will be replaced by the acquisition kind field of group licenses.
155 },
156 ],
157}</pre>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]158</div>
159
160<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]161 <code class="details" id="update">update(enterpriseId, userId, entitlementId, body=None, install=None, x__xgafv=None)</code>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]162 <pre>Adds or updates an entitlement to an app for a user.
163
164Args:
165 enterpriseId: string, The ID of the enterprise. (required)
166 userId: string, The ID of the user. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]167 entitlementId: string, The ID of the entitlement (a product ID), e.g. &quot;app:com.google.android.gm&quot;. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]168 body: object, The request body.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]169 The object takes the form of:
170
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]171{ # The presence of an Entitlements resource indicates that a user has the right to use a particular app. Entitlements are user specific, not device specific. This allows a user with an entitlement to an app to install the app on all their devices. It&#x27;s also possible for a user to hold an entitlement to an app without installing the app on any device. The API can be used to create an entitlement. As an option, you can also use the API to trigger the installation of an app on all a user&#x27;s managed devices at the same time the entitlement is created. If the app is free, creating the entitlement also creates a group license for that app. For paid apps, creating the entitlement consumes one license, and that license remains consumed until the entitlement is removed. If the enterprise hasn&#x27;t purchased enough licenses, then no entitlement is created and the installation fails. An entitlement is also not created for an app if the app requires permissions that the enterprise hasn&#x27;t accepted. If an entitlement is deleted, the app may be uninstalled from a user&#x27;s device. As a best practice, uninstall the app by calling Installs.delete() before deleting the entitlement. Entitlements for apps that a user pays for on an unmanaged profile have &quot;userPurchase&quot; as the entitlement reason. These entitlements cannot be removed via the API.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]172 &quot;productId&quot;: &quot;A String&quot;, # The ID of the product that the entitlement is for. For example, &quot;app:com.google.android.gm&quot;.
173 &quot;reason&quot;: &quot;A String&quot;, # The reason for the entitlement. For example, &quot;free&quot; for free apps. This property is temporary: it will be replaced by the acquisition kind field of group licenses.
174}
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]175
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]176 install: boolean, Set to true to also install the product on all the user&#x27;s devices where possible. Failure to install on one or more devices will not prevent this operation from returning successfully, as long as the entitlement was successfully assigned to the user.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]177 x__xgafv: string, V1 error format.
178 Allowed values
179 1 - v1 error format
180 2 - v2 error format
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]181
182Returns:
183 An object of the form:
184
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]185 { # The presence of an Entitlements resource indicates that a user has the right to use a particular app. Entitlements are user specific, not device specific. This allows a user with an entitlement to an app to install the app on all their devices. It&#x27;s also possible for a user to hold an entitlement to an app without installing the app on any device. The API can be used to create an entitlement. As an option, you can also use the API to trigger the installation of an app on all a user&#x27;s managed devices at the same time the entitlement is created. If the app is free, creating the entitlement also creates a group license for that app. For paid apps, creating the entitlement consumes one license, and that license remains consumed until the entitlement is removed. If the enterprise hasn&#x27;t purchased enough licenses, then no entitlement is created and the installation fails. An entitlement is also not created for an app if the app requires permissions that the enterprise hasn&#x27;t accepted. If an entitlement is deleted, the app may be uninstalled from a user&#x27;s device. As a best practice, uninstall the app by calling Installs.delete() before deleting the entitlement. Entitlements for apps that a user pays for on an unmanaged profile have &quot;userPurchase&quot; as the entitlement reason. These entitlements cannot be removed via the API.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]186 &quot;productId&quot;: &quot;A String&quot;, # The ID of the product that the entitlement is for. For example, &quot;app:com.google.android.gm&quot;.
187 &quot;reason&quot;: &quot;A String&quot;, # The reason for the entitlement. For example, &quot;free&quot; for free apps. This property is temporary: it will be replaced by the acquisition kind field of group licenses.
188}</pre>
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]189</div>
190
191</body></html>