Class: Jamf::OAPISchemas::SelfServiceLoginSettings

Inherits:

Jamf::OAPIObject

• Object
• Jamf::OAPIObject
• Jamf::OAPISchemas::SelfServiceLoginSettings

Defined in:

lib/jamf/api/jamf_pro/oapi_schemas/self_service_login_settings.rb

Overview

This class was automatically generated from the api/schema URL path on a Jamf Pro server version 11.6.1-t1718634702

This class may be used directly, e.g instances of other classes may use instances of this class as one of their own properties/attributes.

It may also be used as a superclass when implementing Jamf Pro API Resources in ruby-jss. The subclasses include appropriate mixins, and should expand on the basic functionality provided here.

Container Objects: Other object models that use this model as the value in one of their attributes.

- Jamf::OAPISchemas::SelfServiceSettings

Sub Objects: Other object models used by this model’s attributes.

Endpoints and Privileges: API endpoints and HTTP operations that use this object model, and the Jamf Pro privileges needed to access them.

Constant Summary

USER_LOGIN_LEVEL_OPTIONS =

Enums used by this class or others

[
  'NotRequired',
  'Anonymous',
  'Required'
]

AUTH_TYPE_OPTIONS =

[
  'Basic',
  'Saml'
]

OAPI_PROPERTIES =

{

  # login setting to tell clients how to let users log in
  # @!attribute userLoginLevel
  #   @return [String]
  userLoginLevel: {
    class: :string,
    required: true,
    enum: USER_LOGIN_LEVEL_OPTIONS
  },

  # true if remember me functionality is allowed, false if not
  # @!attribute allowRememberMe
  #   @return [Boolean]
  allowRememberMe: {
    class: :boolean
  },

  # login type to be used when asking users to log in
  # @!attribute authType
  #   @return [String]
  authType: {
    class: :string,
    required: true,
    enum: AUTH_TYPE_OPTIONS
  }

}

Instance Attribute Summary

• #allowRememberMe ⇒ Boolean
• #authType ⇒ String
• #userLoginLevel ⇒ String

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#allowRememberMe ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/self_service_login_settings.rb', line 91

#authType ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/self_service_login_settings.rb', line 98

#userLoginLevel ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/self_service_login_settings.rb', line 82