Class: Google::Apis::AndroidmanagementV1::EnrollmentToken
- Inherits:
-
Object
- Object
- Google::Apis::AndroidmanagementV1::EnrollmentToken
- 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
-
#additional_data ⇒ String
Optional, arbitrary data associated with the enrollment token.
-
#duration ⇒ String
The length of time the enrollment token is valid, ranging from 1 minute to 30 days.
-
#expiration_timestamp ⇒ String
The expiration time of the token.
-
#name ⇒ String
The name of the enrollment token, which is generated by the server during creation, in the form enterprises/
enterpriseId
/enrollmentTokens/enrollmentTokenId
. -
#one_time_only ⇒ Boolean
(also: #one_time_only?)
Whether the enrollment token is for one time use only.
-
#policy_name ⇒ String
The name of the policy initially applied to the enrolled device, in the form enterprises/
enterpriseId
/policies/policyId
. -
#qr_code ⇒ String
A JSON string whose UTF-8 representation can be used to generate a QR code to enroll a device with this enrollment token.
-
#user ⇒ Google::Apis::AndroidmanagementV1::User
A user belonging to an enterprise.
-
#value ⇒ String
The token value that's passed to the device and authorizes the device to enroll.
Instance Method Summary collapse
-
#initialize(**args) ⇒ EnrollmentToken
constructor
A new instance of EnrollmentToken.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ EnrollmentToken
Returns a new instance of EnrollmentToken.
1094 1095 1096 |
# File 'generated/google/apis/androidmanagement_v1/classes.rb', line 1094 def initialize(**args) update!(**args) end |
Instance Attribute Details
#additional_data ⇒ String
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
1036 1037 1038 |
# File 'generated/google/apis/androidmanagement_v1/classes.rb', line 1036 def additional_data @additional_data end |
#duration ⇒ String
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
1042 1043 1044 |
# File 'generated/google/apis/androidmanagement_v1/classes.rb', line 1042 def duration @duration end |
#expiration_timestamp ⇒ String
The expiration time of the token. This is a read-only field generated by the
server.
Corresponds to the JSON property expirationTimestamp
1048 1049 1050 |
# File 'generated/google/apis/androidmanagement_v1/classes.rb', line 1048 def @expiration_timestamp end |
#name ⇒ String
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
1055 1056 1057 |
# File 'generated/google/apis/androidmanagement_v1/classes.rb', line 1055 def name @name end |
#one_time_only ⇒ Boolean 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
1061 1062 1063 |
# File 'generated/google/apis/androidmanagement_v1/classes.rb', line 1061 def one_time_only @one_time_only end |
#policy_name ⇒ String
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
1073 1074 1075 |
# File 'generated/google/apis/androidmanagement_v1/classes.rb', line 1073 def policy_name @policy_name end |
#qr_code ⇒ String
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
1081 1082 1083 |
# File 'generated/google/apis/androidmanagement_v1/classes.rb', line 1081 def qr_code @qr_code end |
#user ⇒ Google::Apis::AndroidmanagementV1::User
A user belonging to an enterprise.
Corresponds to the JSON property user
1086 1087 1088 |
# File 'generated/google/apis/androidmanagement_v1/classes.rb', line 1086 def user @user end |
#value ⇒ String
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
1092 1093 1094 |
# File 'generated/google/apis/androidmanagement_v1/classes.rb', line 1092 def value @value end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 |
# File 'generated/google/apis/androidmanagement_v1/classes.rb', line 1099 def update!(**args) @additional_data = args[:additional_data] if args.key?(:additional_data) @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 |