Blame - docs/dyn/cloudidentity_v1beta1.devices.html - platform/external/python/google-api-python-client

2020-11-25 07:50:41 -0800

[diff] [blame^]

98

<code><a href="#list">list(view=None, filter=None, pageToken=None, customer=None, orderBy=None, pageSize=None, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

99

<p class="firstline">Lists/Searches devices.</p>

100

101

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

102

<p class="firstline">Retrieves the next page of results.</p>

103

104

<code><a href="#wipe">wipe(name, body=None, x__xgafv=None)</a></code></p>

105

<p class="firstline">Wipes all data on the specified device.</p>

106

<h3>Method Details</h3>

107

108

<code class="details" id="cancelWipe">cancelWipe(name, body=None, x__xgafv=None)</code>

109

<pre>Cancels an unfinished device wipe. This operation can be used to cancel device wipe in the gap between the wipe operation returning success and the device being wiped.

110

111

Args:

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

112

name: string, Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device_id}`, where device_id is the unique ID assigned to the Device. (required)

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

113

body: object, The request body.

114

The object takes the form of:

115

116

{ # Request message for cancelling an unfinished device wipe.

117

"customer": "A String", # Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the customer. If you're using this API for your own organization, use `customers/my_customer` If you're using this API to manage another organization, use `customers/{customer_id}`, where customer_id is the customer to whom the device belongs.

118

}

119

120

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

127

128

{ # This resource represents a long-running operation that is the result of a network API call.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

129

"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.

130

"a_key": "", # Properties of the object. Contains field @type with type URL.

131

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

132

"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

133

"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

134

"a_key": "", # Properties of the object. Contains field @type with type URL.

135

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

136

"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

137

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

138

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

139

{

140

"a_key": "", # Properties of the object. Contains field @type with type URL.

141

},

142

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

143

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

144

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

145

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="close">close()</code>

151

<pre>Close httplib2 connections.</pre>

</div>

<code class="details" id="create">create(body=None, x__xgafv=None)</code>

156

<pre>Creates a device. Only company-owned device may be created.

157

158

Args:

159

body: object, The request body.

160

The object takes the form of:

161

162

{ # Request message for creating a Company Owned device.

163

"device": { # A Device within the Cloud Identity Devices API. Represents a Device known to Google Cloud, independent of the device ownership, type, and whether it is assigned or in use by a user. # Required. The device to be created. The name field within this device is ignored in the create method. A new name is created by the method, and returned within the response. Only the fields `device_type`, `serial_number` and `asset_tag` (if present) are used to create the device.`device_type` and `serial_number` are required.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

164

"brand": "A String", # Output only. Device brand. Example: Samsung.

165

"createTime": "A String", # Output only. When the Company-Owned device was imported. This field is empty for BYOD devices.

166

"ownerType": "A String", # Output only. Whether the device is owned by the company or an individual

167

"name": "A String", # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device_id}`, where device_id is the unique id assigned to the Device.

168

"managementState": "A String", # Output only. Management state of the device

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

169

"wifiMacAddresses": [ # WiFi MAC addresses of device.

170

"A String",

171

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

172

"compromisedState": "A String", # Output only. Represents whether the Device is compromised.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

173

"securityPatchTime": "A String", # Output only. OS security patch update time on device.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

174

"imei": "A String", # Output only. IMEI number of device if GSM device; empty otherwise.

175

"bootloaderVersion": "A String", # Output only. Device bootloader version. Example: 0.6.7.

176

"enabledDeveloperOptions": True or False, # Output only. Whether developer options is enabled on device.

177

"serialNumber": "A String", # Serial Number of device. Example: HT82V1A01076.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

178

"manufacturer": "A String", # Output only. Device manufacturer. Example: Motorola.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

179

"encryptionState": "A String", # Output only. Device encryption state.

180

"networkOperator": "A String", # Output only. Mobile or network operator of device, if available.

181

"buildNumber": "A String", # Output only. Build number of the device.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

182

"otherAccounts": [ # Output only. Domain name for Google accounts on device. Type for other accounts on device. On Android, will only be populated if |ownership_privilege| is |PROFILE_OWNER| or |DEVICE_OWNER|. Does not include the account signed in to the device policy app if that account's domain has only one account. Examples: "com.example", "xyz.com".

183

"A String",

184

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

185

"lastSyncTime": "A String", # Most recent time when device synced with this service.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

186

"releaseVersion": "A String", # Output only. OS release version. Example: 6.0.

187

"assetTag": "A String", # Asset tag of the device.

188

"kernelVersion": "A String", # Output only. Kernel version of the device.

189

"meid": "A String", # Output only. MEID number of device if CDMA device; empty otherwise.

190

"osVersion": "A String", # Output only. OS version of the device. Example: Android 8.1.0.

191

"androidSpecificAttributes": { # Resource representing the Android specific attributes of a Device. # Output only. Attributes specific to Android devices.

192

"ownershipPrivilege": "A String", # Ownership privileges on device.

193

"supportsWorkProfile": True or False, # Whether device supports Android work profiles. If false, this service will not block access to corp data even if an administrator turns on the "Enforce Work Profile" policy.

194

"ownerProfileAccount": True or False, # Whether this account is on an owner/primary profile. For phones, only true for owner profiles. Android 4+ devices can have secondary or restricted user profiles.

195

"enabledUnknownSources": True or False, # Whether applications from unknown sources can be installed on device.

196

},

197

"enabledUsbDebugging": True or False, # Output only. Whether USB debugging is enabled on device.

198

"basebandVersion": "A String", # Output only. Baseband version of the device.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

199

"model": "A String", # Output only. Model name of device. Example: Pixel 3.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

200

"deviceType": "A String", # Output only. Type of device.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

201

},

202

"customer": "A String", # Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the customer. If you're using this API for your own organization, use `customers/my_customer` If you're using this API to manage another organization, use `customers/{customer_id}`, where customer_id is the customer to whom the device belongs.

203

}

204

205

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

212

213

{ # This resource represents a long-running operation that is the result of a network API call.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

214

"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.

215

"a_key": "", # Properties of the object. Contains field @type with type URL.

216

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

217

"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

218

"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

219

"a_key": "", # Properties of the object. Contains field @type with type URL.

220

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

221

"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

222

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

223

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

224

{

225

"a_key": "", # Properties of the object. Contains field @type with type URL.

226

},

227

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

228

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

229

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

230

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="delete">delete(name, customer=None, x__xgafv=None)</code>

236

<pre>Deletes the specified device.

237

238

Args:

239

name: string, Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device_id}`, where device_id is the unique ID assigned to the Device. (required)

240

customer: string, Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the customer. If you're using this API for your own organization, use `customers/my_customer` If you're using this API to manage another organization, use `customers/{customer_id}`, where customer_id is the customer to whom the device belongs.

241

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

248

249

{ # This resource represents a long-running operation that is the result of a network API call.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

250

"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.

251

"a_key": "", # Properties of the object. Contains field @type with type URL.

252

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

253

"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

254

"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

255

"a_key": "", # Properties of the object. Contains field @type with type URL.

256

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

257

"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

258

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

259

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

260

{

261

"a_key": "", # Properties of the object. Contains field @type with type URL.

262

},

263

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

264

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

265

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

266

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="get">get(name, customer=None, x__xgafv=None)</code>

272

<pre>Retrieves the specified device.

273

274

Args:

275

name: string, Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device_id}`, where device_id is the unique ID assigned to the Device. (required)

276

customer: string, Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Customer in format: `customers/{customer_id}`, where customer_id is the customer to whom the device belongs.

277

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

284

285

{ # A Device within the Cloud Identity Devices API. Represents a Device known to Google Cloud, independent of the device ownership, type, and whether it is assigned or in use by a user.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

286

"brand": "A String", # Output only. Device brand. Example: Samsung.

287

"createTime": "A String", # Output only. When the Company-Owned device was imported. This field is empty for BYOD devices.

288

"ownerType": "A String", # Output only. Whether the device is owned by the company or an individual

289

"name": "A String", # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device_id}`, where device_id is the unique id assigned to the Device.

290

"managementState": "A String", # Output only. Management state of the device

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

291

"wifiMacAddresses": [ # WiFi MAC addresses of device.

292

"A String",

293

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

294

"compromisedState": "A String", # Output only. Represents whether the Device is compromised.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

295

"securityPatchTime": "A String", # Output only. OS security patch update time on device.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

296

"imei": "A String", # Output only. IMEI number of device if GSM device; empty otherwise.

297

"bootloaderVersion": "A String", # Output only. Device bootloader version. Example: 0.6.7.

298

"enabledDeveloperOptions": True or False, # Output only. Whether developer options is enabled on device.

299

"serialNumber": "A String", # Serial Number of device. Example: HT82V1A01076.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

300

"manufacturer": "A String", # Output only. Device manufacturer. Example: Motorola.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

301

"encryptionState": "A String", # Output only. Device encryption state.

302

"networkOperator": "A String", # Output only. Mobile or network operator of device, if available.

303

"buildNumber": "A String", # Output only. Build number of the device.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

304

"otherAccounts": [ # Output only. Domain name for Google accounts on device. Type for other accounts on device. On Android, will only be populated if |ownership_privilege| is |PROFILE_OWNER| or |DEVICE_OWNER|. Does not include the account signed in to the device policy app if that account's domain has only one account. Examples: "com.example", "xyz.com".

305

"A String",

306

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

307

"lastSyncTime": "A String", # Most recent time when device synced with this service.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

308

"releaseVersion": "A String", # Output only. OS release version. Example: 6.0.

309

"assetTag": "A String", # Asset tag of the device.

310

"kernelVersion": "A String", # Output only. Kernel version of the device.

311

"meid": "A String", # Output only. MEID number of device if CDMA device; empty otherwise.

312

"osVersion": "A String", # Output only. OS version of the device. Example: Android 8.1.0.

313

"androidSpecificAttributes": { # Resource representing the Android specific attributes of a Device. # Output only. Attributes specific to Android devices.

314

"ownershipPrivilege": "A String", # Ownership privileges on device.

315

"supportsWorkProfile": True or False, # Whether device supports Android work profiles. If false, this service will not block access to corp data even if an administrator turns on the "Enforce Work Profile" policy.

316

"ownerProfileAccount": True or False, # Whether this account is on an owner/primary profile. For phones, only true for owner profiles. Android 4+ devices can have secondary or restricted user profiles.

317

"enabledUnknownSources": True or False, # Whether applications from unknown sources can be installed on device.

318

},

319

"enabledUsbDebugging": True or False, # Output only. Whether USB debugging is enabled on device.

320

"basebandVersion": "A String", # Output only. Baseband version of the device.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

321

"model": "A String", # Output only. Model name of device. Example: Pixel 3.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

322

"deviceType": "A String", # Output only. Type of device.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

}</pre>

</div>

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

327

<code class="details" id="list">list(view=None, filter=None, pageToken=None, customer=None, orderBy=None, pageSize=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

328

<pre>Lists/Searches devices.

329

330

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

331

view: string, Optional. The view to use for the List request.

332

Allowed values

333

VIEW_UNSPECIFIED - Default value. The value is unused.

334

COMPANY_INVENTORY - This view contains all devices imported by the company admin. Each device in the response contains all information specified by the company admin when importing the device (i.e. asset tags).

335

USER_ASSIGNED_DEVICES - This view contains all devices with at least one user registered on the device. Each device in the response contains all device information, except for asset tags.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

336

filter: string, Optional. Additional restrictions when fetching list of devices. For a list of search fields, refer to [Mobile device search fields](https://developers.google.com/admin-sdk/directory/v1/search-operators). Multiple search fields are separated by the space character.

337

pageToken: string, Optional. A page token, received from a previous `ListDevices` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDevices` must match the call that provided the page token.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

338

customer: string, Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the customer.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

339

orderBy: string, Optional. Order specification for devices in the response. Only one of the following field names may be used to specify the order: `create_time`, `last_sync_time`, `model`, `os_version`, `device_type` and `serial_number`. `desc` may be specified optionally to specify results to be sorted in descending order. Default order is ascending.

340

pageSize: integer, Optional. The maximum number of Devices to return. If unspecified, at most 20 Devices will be returned. The maximum value is 100; values above 100 will be coerced to 100.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

341

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

348

349

{ # Response message that is returned from the ListDevices method.

350

"devices": [ # Devices meeting the list restrictions.

351

{ # A Device within the Cloud Identity Devices API. Represents a Device known to Google Cloud, independent of the device ownership, type, and whether it is assigned or in use by a user.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

352

"brand": "A String", # Output only. Device brand. Example: Samsung.

353

"createTime": "A String", # Output only. When the Company-Owned device was imported. This field is empty for BYOD devices.

354

"ownerType": "A String", # Output only. Whether the device is owned by the company or an individual

355

"name": "A String", # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device_id}`, where device_id is the unique id assigned to the Device.

356

"managementState": "A String", # Output only. Management state of the device

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

357

"wifiMacAddresses": [ # WiFi MAC addresses of device.

358

"A String",

359

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

360

"compromisedState": "A String", # Output only. Represents whether the Device is compromised.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

361

"securityPatchTime": "A String", # Output only. OS security patch update time on device.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

362

"imei": "A String", # Output only. IMEI number of device if GSM device; empty otherwise.

363

"bootloaderVersion": "A String", # Output only. Device bootloader version. Example: 0.6.7.

364

"enabledDeveloperOptions": True or False, # Output only. Whether developer options is enabled on device.

365

"serialNumber": "A String", # Serial Number of device. Example: HT82V1A01076.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

366

"manufacturer": "A String", # Output only. Device manufacturer. Example: Motorola.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

367

"encryptionState": "A String", # Output only. Device encryption state.

368

"networkOperator": "A String", # Output only. Mobile or network operator of device, if available.

369

"buildNumber": "A String", # Output only. Build number of the device.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

370

"otherAccounts": [ # Output only. Domain name for Google accounts on device. Type for other accounts on device. On Android, will only be populated if |ownership_privilege| is |PROFILE_OWNER| or |DEVICE_OWNER|. Does not include the account signed in to the device policy app if that account's domain has only one account. Examples: "com.example", "xyz.com".

371

"A String",

372

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

373

"lastSyncTime": "A String", # Most recent time when device synced with this service.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

374

"releaseVersion": "A String", # Output only. OS release version. Example: 6.0.

375

"assetTag": "A String", # Asset tag of the device.

376

"kernelVersion": "A String", # Output only. Kernel version of the device.

377

"meid": "A String", # Output only. MEID number of device if CDMA device; empty otherwise.

378

"osVersion": "A String", # Output only. OS version of the device. Example: Android 8.1.0.

379

"androidSpecificAttributes": { # Resource representing the Android specific attributes of a Device. # Output only. Attributes specific to Android devices.

380

"ownershipPrivilege": "A String", # Ownership privileges on device.

381

"supportsWorkProfile": True or False, # Whether device supports Android work profiles. If false, this service will not block access to corp data even if an administrator turns on the "Enforce Work Profile" policy.

382

"ownerProfileAccount": True or False, # Whether this account is on an owner/primary profile. For phones, only true for owner profiles. Android 4+ devices can have secondary or restricted user profiles.

383

"enabledUnknownSources": True or False, # Whether applications from unknown sources can be installed on device.

384

},

385

"enabledUsbDebugging": True or False, # Output only. Whether USB debugging is enabled on device.

386

"basebandVersion": "A String", # Output only. Baseband version of the device.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

387

"model": "A String", # Output only. Model name of device. Example: Pixel 3.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

388

"deviceType": "A String", # Output only. Type of device.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

389

},

390

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

391

"nextPageToken": "A String", # Token to retrieve the next page of results. Empty if there are no more results.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

397

<pre>Retrieves the next page of results.

398

399

Args:

400

previous_request: The request for the previous page. (required)

401

previous_response: The response from the request for the previous page. (required)

402

403

Returns:

404

A request object that you can call 'execute()' on to request the next

405

page. Returns None if there are no more items in the collection.

</pre>

</div>

<code class="details" id="wipe">wipe(name, body=None, x__xgafv=None)</code>

411

<pre>Wipes all data on the specified device.

412

413

Args:

414

name: string, Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device_id}/deviceUsers/{device_user_id}`, where device_id is the unique ID assigned to the Device, and device_user_id is the unique ID assigned to the User. (required)

415

body: object, The request body.

416

The object takes the form of:

417

418

{ # Request message for wiping all data on the device.

419

"customer": "A String", # Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the customer. If you're using this API for your own organization, use `customers/my_customer` If you're using this API to manage another organization, use `customers/{customer_id}`, where customer_id is the customer to whom the device belongs.

420

}

421

422

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

429

430

{ # This resource represents a long-running operation that is the result of a network API call.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

431

"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.

432

"a_key": "", # Properties of the object. Contains field @type with type URL.

433

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

434

"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

435

"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

436

"a_key": "", # Properties of the object. Contains field @type with type URL.

437

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

438

"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

439

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

440

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

441

{

442

"a_key": "", # Properties of the object. Contains field @type with type URL.

443

},

444

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

445

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

446

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

447

},

Dmitry Frenkel