Show / Hide Table of Contents

Class EnrollmentToken

An enrollment token.

Inheritance
object
EnrollmentToken
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.AndroidManagement.v1.Data
Assembly: Google.Apis.AndroidManagement.v1.dll
Syntax
public class EnrollmentToken : IDirectResponseSchema

Properties

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 enrollment_token_data field of the Device resource. The data must be 1024 characters or less; otherwise, the creation request will fail.

Declaration
[JsonProperty("additionalData")]
public virtual string AdditionalData { get; set; }
Property Value
Type Description
string

AllowPersonalUsage

Controls whether personal usage is allowed on a device provisioned with this enrollment token.For company-owned devices: Enabling personal usage allows the user to set up a work profile on the device. Disabling personal usage requires the user provision the device as a fully managed device.For personally-owned devices: Enabling personal usage allows the user to set up a work profile on the device. Disabling personal usage will prevent the device from provisioning. Personal usage cannot be disabled on personally-owned device.

Declaration
[JsonProperty("allowPersonalUsage")]
public virtual string AllowPersonalUsage { get; set; }
Property Value
Type Description
string

Duration

The length of time the enrollment token is valid, ranging from 1 minute to Durations.MAX_VALUE (https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/util/Durations.html#MAX_VALUE), approximately 10,000 years. If not specified, the default duration is 1 hour. Please note that if requested duration causes the resulting expiration_timestamp to exceed Timestamps.MAX_VALUE (https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/util/Timestamps.html#MAX_VALUE), then expiration_timestamp is coerced to Timestamps.MAX_VALUE.

Declaration
[JsonProperty("duration")]
public virtual object Duration { get; set; }
Property Value
Type Description
object

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

ExpirationTimestamp

object representation of ExpirationTimestampRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use ExpirationTimestampDateTimeOffset instead.")]
public virtual object ExpirationTimestamp { get; set; }
Property Value
Type Description
object

ExpirationTimestampDateTimeOffset

DateTimeOffset representation of ExpirationTimestampRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? ExpirationTimestampDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

ExpirationTimestampRaw

The expiration time of the token. This is a read-only field generated by the server.

Declaration
[JsonProperty("expirationTimestamp")]
public virtual string ExpirationTimestampRaw { get; set; }
Property Value
Type Description
string

Name

The name of the enrollment token, which is generated by the server during creation, in the form enterprises/{enterpriseId}/enrollmentTokens/{enrollmentTokenId}.

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

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.

Declaration
[JsonProperty("oneTimeOnly")]
public virtual bool? OneTimeOnly { get; set; }
Property Value
Type Description
bool?

PolicyName

The name of the policy initially applied to the enrolled device, in the form enterprises/{enterpriseId}/policies/{policyId}. If not specified, the policy_name for the device’s user is applied. If user_name is also not specified, enterprises/{enterpriseId}/policies/default is applied by default. When updating this field, you can specify only the policyId as long as the policyId doesn’t contain any slashes. The rest of the policy name will be inferred.

Declaration
[JsonProperty("policyName")]
public virtual string PolicyName { get; set; }
Property Value
Type Description
string

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 java.util.Properties representation of the properties in the JSON.

Declaration
[JsonProperty("qrCode")]
public virtual string QrCode { get; set; }
Property Value
Type Description
string

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 account_identifier field needs to be set.

Declaration
[JsonProperty("user")]
public virtual User User { get; set; }
Property Value
Type Description
User

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.

Declaration
[JsonProperty("value")]
public virtual string Value { get; set; }
Property Value
Type Description
string

Implements

IDirectResponseSchema
In This Article
Back to top Generated by DocFX