Class: Google::Apis::AndroidmanagementV1::SigninDetail

Inherits:

Object

• Object
• Google::Apis::AndroidmanagementV1::SigninDetail

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

A resource containing sign in details for an enterprise. Use enterprises to manage SigninDetails for a given enterprise.For an enterprise, we can have any number of SigninDetails that is uniquely identified by combination of the following three fields (signin_url, allow_personal_usage, token_tag). One cannot create two SigninDetails with the same (signin_url, allow_personal_usage, token_tag). (token_tag is an optional field).Patch: The operation updates the current list of SigninDetails with the new list of SigninDetails. If the stored SigninDetail configuration is passed, it returns the same signin_enrollment_token and qr_code. If we pass multiple identical SigninDetail configurations that are not stored, it will store the first one amongst those SigninDetail configurations. if the configuration already exists we cannot request it more than once in a particular patch API call, otherwise it will give a duplicate key error and the whole operation will fail. If we remove certain SigninDetail configuration from the request then it will get removed from the storage. We can then request another signin_enrollment_token and qr_code for the same SigninDetail configuration.

Instance Attribute Summary

• #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.

• #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.

• #signin_enrollment_token ⇒ String

  An enterprise wide enrollment token used to trigger custom sign-in flow.

• #signin_url ⇒ String

  Sign-in URL for authentication when device is provisioned with a sign-in enrollment token.

• #token_tag ⇒ String

  An EMM-specified metadata to distinguish between instances of SigninDetail.

Instance Method Summary

• #initialize(**args) ⇒ SigninDetail constructor

  A new instance of SigninDetail.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ SigninDetail

Returns a new instance of SigninDetail.

# File 'lib/google/apis/androidmanagement_v1/classes.rb', line 4972

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

Instance Attribute Details

#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)

# File 'lib/google/apis/androidmanagement_v1/classes.rb', line 4942

def allow_personal_usage
  @allow_personal_usage
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. This is a read-only field generated by the server. Corresponds to the JSON property qrCode

Returns:

• (String)

# File 'lib/google/apis/androidmanagement_v1/classes.rb', line 4950

def qr_code
  @qr_code
end

#signin_enrollment_token ⇒ String

An enterprise wide enrollment token used to trigger custom sign-in flow. This is a read-only field generated by the server. Corresponds to the JSON property signinEnrollmentToken

Returns:

• (String)

# File 'lib/google/apis/androidmanagement_v1/classes.rb', line 4956

def signin_enrollment_token
  @signin_enrollment_token
end

#signin_url ⇒ String

Sign-in URL for authentication when device is provisioned with a sign-in enrollment token. The sign-in endpoint should finish authentication flow with a URL in the form of https://enterprise.google.com/android/enroll?et= for a successful login, or https://enterprise.google.com/android/enroll/invalid for a failed login. Corresponds to the JSON property signinUrl

Returns:

• (String)

# File 'lib/google/apis/androidmanagement_v1/classes.rb', line 4965

def signin_url
  @signin_url
end

#token_tag ⇒ String

An EMM-specified metadata to distinguish between instances of SigninDetail. Corresponds to the JSON property tokenTag

Returns:

• (String)

# File 'lib/google/apis/androidmanagement_v1/classes.rb', line 4970

def token_tag
  @token_tag
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'lib/google/apis/androidmanagement_v1/classes.rb', line 4977

def update!(**args)
  @allow_personal_usage = args[:allow_personal_usage] if args.key?(:allow_personal_usage)
  @qr_code = args[:qr_code] if args.key?(:qr_code)
  @signin_enrollment_token = args[:signin_enrollment_token] if args.key?(:signin_enrollment_token)
  @signin_url = args[:signin_url] if args.key?(:signin_url)
  @token_tag = args[:token_tag] if args.key?(:token_tag)
end