| 1 |
<html><body> |
| 2 |
<style> |
| 3 |
|
| 4 |
body, 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 |
|
| 15 |
body { |
| 16 |
font-size: 13px; |
| 17 |
padding: 1em; |
| 18 |
} |
| 19 |
|
| 20 |
h1 { |
| 21 |
font-size: 26px; |
| 22 |
margin-bottom: 1em; |
| 23 |
} |
| 24 |
|
| 25 |
h2 { |
| 26 |
font-size: 24px; |
| 27 |
margin-bottom: 1em; |
| 28 |
} |
| 29 |
|
| 30 |
h3 { |
| 31 |
font-size: 20px; |
| 32 |
margin-bottom: 1em; |
| 33 |
margin-top: 1em; |
| 34 |
} |
| 35 |
|
| 36 |
pre, code { |
| 37 |
line-height: 1.5; |
| 38 |
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 |
} |
| 40 |
|
| 41 |
pre { |
| 42 |
margin-top: 0.5em; |
| 43 |
} |
| 44 |
|
| 45 |
h1, h2, h3, p { |
| 46 |
font-family: Arial, sans serif; |
| 47 |
} |
| 48 |
|
| 49 |
h1, 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="androidmanagement_v1.html">Android Management API</a> . <a href="androidmanagement_v1.enterprises.html">enterprises</a> . <a href="androidmanagement_v1.enterprises.migrationTokens.html">migrationTokens</a></h1> |
| 76 |
<h2>Instance Methods</h2> |
| 77 |
<p class="toc_element"> |
| 78 |
<code><a href="#close">close()</a></code></p> |
| 79 |
<p class="firstline">Close httplib2 connections.</p> |
| 80 |
<p class="toc_element"> |
| 81 |
<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> |
| 82 |
<p class="firstline">Creates a migration token, to migrate an existing device from being managed by the EMM's Device Policy Controller (DPC) to being managed by the Android Management API. See the guide (https://developers.google.com/android/management/dpc-migration) for more details.</p> |
| 83 |
<p class="toc_element"> |
| 84 |
<code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| 85 |
<p class="firstline">Gets a migration token.</p> |
| 86 |
<p class="toc_element"> |
| 87 |
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| 88 |
<p class="firstline">Lists migration tokens.</p> |
| 89 |
<p class="toc_element"> |
| 90 |
<code><a href="#list_next">list_next()</a></code></p> |
| 91 |
<p class="firstline">Retrieves the next page of results.</p> |
| 92 |
<h3>Method Details</h3> |
| 93 |
<div class="method"> |
| 94 |
<code class="details" id="close">close()</code> |
| 95 |
<pre>Close httplib2 connections.</pre> |
| 96 |
</div> |
| 97 |
|
| 98 |
<div class="method"> |
| 99 |
<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> |
| 100 |
<pre>Creates a migration token, to migrate an existing device from being managed by the EMM's Device Policy Controller (DPC) to being managed by the Android Management API. See the guide (https://developers.google.com/android/management/dpc-migration) for more details. |
| 101 |
|
| 102 |
Args: |
| 103 |
parent: string, Required. The enterprise in which this migration token is created. This must be the same enterprise which already manages the device in the Play EMM API. Format: enterprises/{enterprise} (required) |
| 104 |
body: object, The request body. |
| 105 |
The object takes the form of: |
| 106 |
|
| 107 |
{ # A token to initiate the migration of a device from being managed by a third-party DPC to being managed by Android Management API. A migration token is valid only for a single device. See the guide (https://developers.google.com/android/management/dpc-migration) for more details. |
| 108 |
"additionalData": "A String", # Immutable. Optional EMM-specified additional data. Once the device is migrated this will be populated in the migrationAdditionalData field of the Device resource. This must be at most 1024 characters. |
| 109 |
"createTime": "A String", # Output only. Time when this migration token was created. |
| 110 |
"device": "A String", # Output only. Once this migration token is used to migrate a device, the name of the resulting Device resource will be populated here, in the form enterprises/{enterprise}/devices/{device}. |
| 111 |
"deviceId": "A String", # Required. Immutable. The id of the device, as in the Play EMM API. This corresponds to the deviceId parameter in Play EMM API's Devices.get (https://developers.google.com/android/work/play/emm-api/v1/devices/get#parameters) call. |
| 112 |
"expireTime": "A String", # Immutable. The time when this migration token expires. This can be at most seven days from the time of creation. The migration token is deleted seven days after it expires. |
| 113 |
"managementMode": "A String", # Required. Immutable. The management mode of the device or profile being migrated. |
| 114 |
"name": "A String", # Output only. The name of the migration token, which is generated by the server during creation, in the form enterprises/{enterprise}/migrationTokens/{migration_token}. |
| 115 |
"policy": "A String", # Required. Immutable. The name of the policy initially applied to the enrolled device, in the form enterprises/{enterprise}/policies/{policy}. |
| 116 |
"ttl": "A String", # Input only. The time that this migration token is valid for. This is input-only, and for returning a migration token the server will populate the expireTime field. This can be at most seven days. The default is seven days. |
| 117 |
"userId": "A String", # Required. Immutable. The user id of the Managed Google Play account on the device, as in the Play EMM API. This corresponds to the userId parameter in Play EMM API's Devices.get (https://developers.google.com/android/work/play/emm-api/v1/devices/get#parameters) call. |
| 118 |
"value": "A String", # Output only. The value of the migration token. |
| 119 |
} |
| 120 |
|
| 121 |
x__xgafv: string, V1 error format. |
| 122 |
Allowed values |
| 123 |
1 - v1 error format |
| 124 |
2 - v2 error format |
| 125 |
|
| 126 |
Returns: |
| 127 |
An object of the form: |
| 128 |
|
| 129 |
{ # A token to initiate the migration of a device from being managed by a third-party DPC to being managed by Android Management API. A migration token is valid only for a single device. See the guide (https://developers.google.com/android/management/dpc-migration) for more details. |
| 130 |
"additionalData": "A String", # Immutable. Optional EMM-specified additional data. Once the device is migrated this will be populated in the migrationAdditionalData field of the Device resource. This must be at most 1024 characters. |
| 131 |
"createTime": "A String", # Output only. Time when this migration token was created. |
| 132 |
"device": "A String", # Output only. Once this migration token is used to migrate a device, the name of the resulting Device resource will be populated here, in the form enterprises/{enterprise}/devices/{device}. |
| 133 |
"deviceId": "A String", # Required. Immutable. The id of the device, as in the Play EMM API. This corresponds to the deviceId parameter in Play EMM API's Devices.get (https://developers.google.com/android/work/play/emm-api/v1/devices/get#parameters) call. |
| 134 |
"expireTime": "A String", # Immutable. The time when this migration token expires. This can be at most seven days from the time of creation. The migration token is deleted seven days after it expires. |
| 135 |
"managementMode": "A String", # Required. Immutable. The management mode of the device or profile being migrated. |
| 136 |
"name": "A String", # Output only. The name of the migration token, which is generated by the server during creation, in the form enterprises/{enterprise}/migrationTokens/{migration_token}. |
| 137 |
"policy": "A String", # Required. Immutable. The name of the policy initially applied to the enrolled device, in the form enterprises/{enterprise}/policies/{policy}. |
| 138 |
"ttl": "A String", # Input only. The time that this migration token is valid for. This is input-only, and for returning a migration token the server will populate the expireTime field. This can be at most seven days. The default is seven days. |
| 139 |
"userId": "A String", # Required. Immutable. The user id of the Managed Google Play account on the device, as in the Play EMM API. This corresponds to the userId parameter in Play EMM API's Devices.get (https://developers.google.com/android/work/play/emm-api/v1/devices/get#parameters) call. |
| 140 |
"value": "A String", # Output only. The value of the migration token. |
| 141 |
}</pre> |
| 142 |
</div> |
| 143 |
|
| 144 |
<div class="method"> |
| 145 |
<code class="details" id="get">get(name, x__xgafv=None)</code> |
| 146 |
<pre>Gets a migration token. |
| 147 |
|
| 148 |
Args: |
| 149 |
name: string, Required. The name of the migration token to retrieve. Format: enterprises/{enterprise}/migrationTokens/{migration_token} (required) |
| 150 |
x__xgafv: string, V1 error format. |
| 151 |
Allowed values |
| 152 |
1 - v1 error format |
| 153 |
2 - v2 error format |
| 154 |
|
| 155 |
Returns: |
| 156 |
An object of the form: |
| 157 |
|
| 158 |
{ # A token to initiate the migration of a device from being managed by a third-party DPC to being managed by Android Management API. A migration token is valid only for a single device. See the guide (https://developers.google.com/android/management/dpc-migration) for more details. |
| 159 |
"additionalData": "A String", # Immutable. Optional EMM-specified additional data. Once the device is migrated this will be populated in the migrationAdditionalData field of the Device resource. This must be at most 1024 characters. |
| 160 |
"createTime": "A String", # Output only. Time when this migration token was created. |
| 161 |
"device": "A String", # Output only. Once this migration token is used to migrate a device, the name of the resulting Device resource will be populated here, in the form enterprises/{enterprise}/devices/{device}. |
| 162 |
"deviceId": "A String", # Required. Immutable. The id of the device, as in the Play EMM API. This corresponds to the deviceId parameter in Play EMM API's Devices.get (https://developers.google.com/android/work/play/emm-api/v1/devices/get#parameters) call. |
| 163 |
"expireTime": "A String", # Immutable. The time when this migration token expires. This can be at most seven days from the time of creation. The migration token is deleted seven days after it expires. |
| 164 |
"managementMode": "A String", # Required. Immutable. The management mode of the device or profile being migrated. |
| 165 |
"name": "A String", # Output only. The name of the migration token, which is generated by the server during creation, in the form enterprises/{enterprise}/migrationTokens/{migration_token}. |
| 166 |
"policy": "A String", # Required. Immutable. The name of the policy initially applied to the enrolled device, in the form enterprises/{enterprise}/policies/{policy}. |
| 167 |
"ttl": "A String", # Input only. The time that this migration token is valid for. This is input-only, and for returning a migration token the server will populate the expireTime field. This can be at most seven days. The default is seven days. |
| 168 |
"userId": "A String", # Required. Immutable. The user id of the Managed Google Play account on the device, as in the Play EMM API. This corresponds to the userId parameter in Play EMM API's Devices.get (https://developers.google.com/android/work/play/emm-api/v1/devices/get#parameters) call. |
| 169 |
"value": "A String", # Output only. The value of the migration token. |
| 170 |
}</pre> |
| 171 |
</div> |
| 172 |
|
| 173 |
<div class="method"> |
| 174 |
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| 175 |
<pre>Lists migration tokens. |
| 176 |
|
| 177 |
Args: |
| 178 |
parent: string, Required. The enterprise which the migration tokens belong to. Format: enterprises/{enterprise} (required) |
| 179 |
pageSize: integer, The maximum number of migration tokens to return. Fewer migration tokens may be returned. If unspecified, at most 100 migration tokens will be returned. The maximum value is 100; values above 100 will be coerced to 100. |
| 180 |
pageToken: string, A page token, received from a previous ListMigrationTokens call. Provide this to retrieve the subsequent page.When paginating, all other parameters provided to ListMigrationTokens must match the call that provided the page token. |
| 181 |
x__xgafv: string, V1 error format. |
| 182 |
Allowed values |
| 183 |
1 - v1 error format |
| 184 |
2 - v2 error format |
| 185 |
|
| 186 |
Returns: |
| 187 |
An object of the form: |
| 188 |
|
| 189 |
{ # Response to a request to list migration tokens for a given enterprise. |
| 190 |
"migrationTokens": [ # The migration tokens from the specified enterprise. |
| 191 |
{ # A token to initiate the migration of a device from being managed by a third-party DPC to being managed by Android Management API. A migration token is valid only for a single device. See the guide (https://developers.google.com/android/management/dpc-migration) for more details. |
| 192 |
"additionalData": "A String", # Immutable. Optional EMM-specified additional data. Once the device is migrated this will be populated in the migrationAdditionalData field of the Device resource. This must be at most 1024 characters. |
| 193 |
"createTime": "A String", # Output only. Time when this migration token was created. |
| 194 |
"device": "A String", # Output only. Once this migration token is used to migrate a device, the name of the resulting Device resource will be populated here, in the form enterprises/{enterprise}/devices/{device}. |
| 195 |
"deviceId": "A String", # Required. Immutable. The id of the device, as in the Play EMM API. This corresponds to the deviceId parameter in Play EMM API's Devices.get (https://developers.google.com/android/work/play/emm-api/v1/devices/get#parameters) call. |
| 196 |
"expireTime": "A String", # Immutable. The time when this migration token expires. This can be at most seven days from the time of creation. The migration token is deleted seven days after it expires. |
| 197 |
"managementMode": "A String", # Required. Immutable. The management mode of the device or profile being migrated. |
| 198 |
"name": "A String", # Output only. The name of the migration token, which is generated by the server during creation, in the form enterprises/{enterprise}/migrationTokens/{migration_token}. |
| 199 |
"policy": "A String", # Required. Immutable. The name of the policy initially applied to the enrolled device, in the form enterprises/{enterprise}/policies/{policy}. |
| 200 |
"ttl": "A String", # Input only. The time that this migration token is valid for. This is input-only, and for returning a migration token the server will populate the expireTime field. This can be at most seven days. The default is seven days. |
| 201 |
"userId": "A String", # Required. Immutable. The user id of the Managed Google Play account on the device, as in the Play EMM API. This corresponds to the userId parameter in Play EMM API's Devices.get (https://developers.google.com/android/work/play/emm-api/v1/devices/get#parameters) call. |
| 202 |
"value": "A String", # Output only. The value of the migration token. |
| 203 |
}, |
| 204 |
], |
| 205 |
"nextPageToken": "A String", # A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. |
| 206 |
}</pre> |
| 207 |
</div> |
| 208 |
|
| 209 |
<div class="method"> |
| 210 |
<code class="details" id="list_next">list_next()</code> |
| 211 |
<pre>Retrieves the next page of results. |
| 212 |
|
| 213 |
Args: |
| 214 |
previous_request: The request for the previous page. (required) |
| 215 |
previous_response: The response from the request for the previous page. (required) |
| 216 |
|
| 217 |
Returns: |
| 218 |
A request object that you can call 'execute()' on to request the next |
| 219 |
page. Returns None if there are no more items in the collection. |
| 220 |
</pre> |
| 221 |
</div> |
| 222 |
|
| 223 |
</body></html> |