REST Resource: enterprises.migrationTokens

Resource: MigrationToken

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.

JSON representation
{
  "name": string,
  "value": string,
  "createTime": string,
  "userId": string,
  "deviceId": string,
  "managementMode": enum (ManagementMode),
  "policy": string,
  "additionalData": string,
  "device": string,

  // Union field expiration can be only one of the following:
  "expireTime": string,
  "ttl": string
  // End of list of possible types for union field expiration.
}
Fields
name

string

Output only. The name of the migration token, which is generated by the server during creation, in the form enterprises/{enterprise}/migrationTokens/{migrationToken}.

value

string

Output only. The value of the migration token.

createTime

string (Timestamp format)

Output only. Time when this migration token was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

userId

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 call.

deviceId

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 call.

managementMode

enum (ManagementMode)

Required. Immutable. The management mode of the device or profile being migrated.

policy

string

Required. Immutable. The name of the policy initially applied to the enrolled device, in the form enterprises/{enterprise}/policies/{policy}.

additionalData

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.

device

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}.

Union field expiration.

expiration can be only one of the following:

expireTime

string (Timestamp format)

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.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

ttl

string (Duration format)

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.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".

ManagementMode

The management mode of the device or profile being migrated.

Enums
MANAGEMENT_MODE_UNSPECIFIED This value must not be used.
WORK_PROFILE_PERSONALLY_OWNED A work profile on a personally owned device. Supported only on devices running Android 9 and above.
WORK_PROFILE_COMPANY_OWNED A work profile on a company-owned device. Supported only on devices running Android 11 and above.
FULLY_MANAGED A fully-managed device. Supported only on devices running Android 9 and above.

Methods

create

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.

get

Gets a migration token.

list

Lists migration tokens.