Resource: EnrollmentToken
An enrollment token.
JSON representation |
---|
{ "name": string, "value": string, "duration": string, "expirationTimestamp": string, "policyName": string, "additionalData": string, "qrCode": string, "oneTimeOnly": boolean, "user": { object ( |
Fields | |
---|---|
name |
The name of the enrollment token, which is generated by the server during creation, in the form |
value |
The token value that's passed to the device and authorizes the device to enroll. This is a read-only field generated by the server. |
duration |
The length of time the enrollment token is valid, ranging from 1 minute to A duration in seconds with up to nine fractional digits, ending with ' |
expirationTimestamp |
The expiration time of the token. This is a read-only field generated by the server. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
policyName |
The name of the policy initially applied to the enrolled device, in the form |
additionalData |
Optional, arbitrary data associated with the enrollment token. This could contain, for example, the ID of an org unit the device is assigned to after enrollment. After a device enrolls with the token, this data will be exposed in the |
qrCode |
A JSON string whose UTF-8 representation can be used to generate a QR code to enroll a device with this enrollment token. To enroll a device using NFC, the NFC record must contain a serialized |
oneTimeOnly |
Whether the enrollment token is for one time use only. If the flag is set to true, only one device can use it for registration. |
user |
The user associated with this enrollment token. If it's specified when the enrollment token is created and the user does not exist, the user will be created. This field must not contain personally identifiable information. Only the accountIdentifier field needs to be set. |
allowPersonalUsage |
Controls whether personal usage is allowed on a device provisioned with this enrollment token. For company-owned devices:
For personally-owned devices:
|
Methods |
|
---|---|
|
Creates an enrollment token for a given enterprise. |
|
Deletes an enrollment token. |
|
Gets an active, unexpired enrollment token. |
|
Lists active, unexpired enrollment tokens for a given enterprise. |