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

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

Overview

An enrollment token.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ EnrollmentToken

Returns a new instance of EnrollmentToken.



1911
1912
1913
 
# File 'lib/google/apis/androidmanagement_v1/classes.rb', line 1911

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

Returns:

  • (String) 


1842
1843
1844
 
# File 'lib/google/apis/androidmanagement_v1/classes.rb', line 1842

def additional_data
  @additional_data
end

#allow_personal_usage ⇒ String

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) 


1853
1854
1855
 
# File 'lib/google/apis/androidmanagement_v1/classes.rb', line 1853

def allow_personal_usage
  @allow_personal_usage
end

#duration ⇒ String

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

Returns:

  • (String) 


1859
1860
1861
 
# File 'lib/google/apis/androidmanagement_v1/classes.rb', line 1859

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

Returns:

  • (String) 


1865
1866
1867
 
# File 'lib/google/apis/androidmanagement_v1/classes.rb', line 1865

def expiration_timestamp
  @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

Returns:

  • (String) 


1872
1873
1874
 
# File 'lib/google/apis/androidmanagement_v1/classes.rb', line 1872

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

Returns:

  • (Boolean) 


1878
1879
1880
 
# File 'lib/google/apis/androidmanagement_v1/classes.rb', line 1878

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

Returns:

  • (String) 


1890
1891
1892
 
# File 'lib/google/apis/androidmanagement_v1/classes.rb', line 1890

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

Returns:

  • (String) 


1898
1899
1900
 
# File 'lib/google/apis/androidmanagement_v1/classes.rb', line 1898

def qr_code
  @qr_code
end

#user ⇒ Google::Apis::AndroidmanagementV1::User

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

Returns:



1903
1904
1905
 
# File 'lib/google/apis/androidmanagement_v1/classes.rb', line 1903

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

Returns:

  • (String) 


1909
1910
1911
 
# File 'lib/google/apis/androidmanagement_v1/classes.rb', line 1909

def value
  @value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
 
# File 'lib/google/apis/androidmanagement_v1/classes.rb', line 1916

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