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.



1939
1940
1941
 
# File 'lib/google/apis/androidmanagement_v1/classes.rb', line 1939

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) 


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

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) 


1875
1876
1877
 
# File 'lib/google/apis/androidmanagement_v1/classes.rb', line 1875

def allow_personal_usage
  @allow_personal_usage
end

#duration ⇒ String

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

Returns:

  • (String) 


1887
1888
1889
 
# File 'lib/google/apis/androidmanagement_v1/classes.rb', line 1887

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) 


1893
1894
1895
 
# File 'lib/google/apis/androidmanagement_v1/classes.rb', line 1893

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) 


1900
1901
1902
 
# File 'lib/google/apis/androidmanagement_v1/classes.rb', line 1900

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) 


1906
1907
1908
 
# File 'lib/google/apis/androidmanagement_v1/classes.rb', line 1906

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) 


1918
1919
1920
 
# File 'lib/google/apis/androidmanagement_v1/classes.rb', line 1918

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) 


1926
1927
1928
 
# File 'lib/google/apis/androidmanagement_v1/classes.rb', line 1926

def qr_code
  @qr_code
end

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

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

Returns:



1931
1932
1933
 
# File 'lib/google/apis/androidmanagement_v1/classes.rb', line 1931

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) 


1937
1938
1939
 
# File 'lib/google/apis/androidmanagement_v1/classes.rb', line 1937

def value
  @value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
 
# File 'lib/google/apis/androidmanagement_v1/classes.rb', line 1944

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