Class: Google::Apis::AndroidmanagementV1::EnrollmentToken

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/androidmanagement_v1/classes.rb,
generated/google/apis/androidmanagement_v1/representations.rb,
generated/google/apis/androidmanagement_v1/representations.rb

Overview

An enrollment token.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ EnrollmentToken

Returns a new instance of EnrollmentToken.


1118
1119
1120
# File 'generated/google/apis/androidmanagement_v1/classes.rb', line 1118

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#additional_dataString

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. Corresponds to the JSON property additionalData

Returns:

  • (String)

1049
1050
1051
# File 'generated/google/apis/androidmanagement_v1/classes.rb', line 1049

def additional_data
  @additional_data
end

#allow_personal_usageString

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. Corresponds to the JSON property allowPersonalUsage

Returns:

  • (String)

1060
1061
1062
# File 'generated/google/apis/androidmanagement_v1/classes.rb', line 1060

def allow_personal_usage
  @allow_personal_usage
end

#durationString

The length of time the enrollment token is valid, ranging from 1 minute to 30 days. If not specified, the default duration is 1 hour. Corresponds to the JSON property duration

Returns:

  • (String)

1066
1067
1068
# File 'generated/google/apis/androidmanagement_v1/classes.rb', line 1066

def duration
  @duration
end

#expiration_timestampString

The expiration time of the token. This is a read-only field generated by the server. Corresponds to the JSON property expirationTimestamp

Returns:

  • (String)

1072
1073
1074
# File 'generated/google/apis/androidmanagement_v1/classes.rb', line 1072

def expiration_timestamp
  @expiration_timestamp
end

#nameString

The name of the enrollment token, which is generated by the server during creation, in the form enterprises/enterpriseId/enrollmentTokens/ enrollmentTokenId. Corresponds to the JSON property name

Returns:

  • (String)

1079
1080
1081
# File 'generated/google/apis/androidmanagement_v1/classes.rb', line 1079

def name
  @name
end

#one_time_onlyBoolean Also known as: one_time_only?

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. Corresponds to the JSON property oneTimeOnly

Returns:

  • (Boolean)

1085
1086
1087
# File 'generated/google/apis/androidmanagement_v1/classes.rb', line 1085

def one_time_only
  @one_time_only
end

#policy_nameString

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. Corresponds to the JSON property policyName

Returns:

  • (String)

1097
1098
1099
# File 'generated/google/apis/androidmanagement_v1/classes.rb', line 1097

def policy_name
  @policy_name
end

#qr_codeString

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. Corresponds to the JSON property qrCode

Returns:

  • (String)

1105
1106
1107
# File 'generated/google/apis/androidmanagement_v1/classes.rb', line 1105

def qr_code
  @qr_code
end

#userGoogle::Apis::AndroidmanagementV1::User

A user belonging to an enterprise. Corresponds to the JSON property user


1110
1111
1112
# File 'generated/google/apis/androidmanagement_v1/classes.rb', line 1110

def user
  @user
end

#valueString

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. Corresponds to the JSON property value

Returns:

  • (String)

1116
1117
1118
# File 'generated/google/apis/androidmanagement_v1/classes.rb', line 1116

def value
  @value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
# File 'generated/google/apis/androidmanagement_v1/classes.rb', line 1123

def update!(**args)
  @additional_data = args[:additional_data] if args.key?(:additional_data)
  @allow_personal_usage = args[:allow_personal_usage] if args.key?(:allow_personal_usage)
  @duration = args[:duration] if args.key?(:duration)
  @expiration_timestamp = args[:expiration_timestamp] if args.key?(:expiration_timestamp)
  @name = args[:name] if args.key?(:name)
  @one_time_only = args[:one_time_only] if args.key?(:one_time_only)
  @policy_name = args[:policy_name] if args.key?(:policy_name)
  @qr_code = args[:qr_code] if args.key?(:qr_code)
  @user = args[:user] if args.key?(:user)
  @value = args[:value] if args.key?(:value)
end