Class: Jamf::OAPISchemas::SsoSettings

Inherits:

Jamf::OAPIObject

Object
Jamf::OAPIObject
Jamf::OAPISchemas::SsoSettings

Defined in:: lib/jamf/api/jamf_pro/oapi_schemas/sso_settings.rb

Overview

OAPI Object Model and Enums for: SsoSettings

This class was automatically genereated from the api/schema URL path on a Jamf Pro server version 10.50.0-t1693149930

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.

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

- Jamf::OAPISchemas::EnrollmentSsoConfig

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

- '/v1/sso:GET' needs permissions:
  - Read SSO Settings
- '/v1/sso:PUT' needs permissions:
  - Update SSO Settings

Constant Summary collapse

USER_MAPPING_OPTIONS = Enums used by this class or others

[
  'USERNAME',
  'EMAIL'
]

IDP_PROVIDER_TYPE_OPTIONS =

[
  'ADFS',
  'OKTA',
  'GOOGLE',
  'SHIBBOLETH',
  'ONELOGIN',
  'PING',
  'CENTRIFY',
  'AZURE',
  'OTHER'
]

METADATA_SOURCE_OPTIONS =

[
  'URL',
  'FILE',
  'UNKNOWN'
]

OAPI_PROPERTIES =

{

  # @!attribute ssoForEnrollmentEnabled
  #   @return [Boolean]
  ssoForEnrollmentEnabled: {
    class: :boolean,
    required: true
  },

  # @!attribute ssoBypassAllowed
  #   @return [Boolean]
  ssoBypassAllowed: {
    class: :boolean,
    required: true
  },

  # @!attribute ssoEnabled
  #   @return [Boolean]
  ssoEnabled: {
    class: :boolean,
    required: true
  },

  # @!attribute ssoForMacOsSelfServiceEnabled
  #   @return [Boolean]
  ssoForMacOsSelfServiceEnabled: {
    class: :boolean,
    required: true
  },

  # @!attribute tokenExpirationDisabled
  #   @return [Boolean]
  tokenExpirationDisabled: {
    class: :boolean,
    required: true
  },

  # @!attribute userAttributeEnabled
  #   @return [Boolean]
  userAttributeEnabled: {
    class: :boolean,
    required: true
  },

  # @!attribute userAttributeName
  #   @return [String]
  userAttributeName: {
    class: :string
  },

  # @!attribute userMapping
  #   @return [String]
  userMapping: {
    class: :string,
    required: true,
    enum: USER_MAPPING_OPTIONS
  },

  # @!attribute enrollmentSsoForAdueEnabled
  #   @return [Boolean]
  enrollmentSsoForAdueEnabled: {
    class: :boolean,
    required: true
  },

  # @!attribute enrollmentSsoConfig
  #   @return [Jamf::OAPISchemas::EnrollmentSsoConfig]
  enrollmentSsoConfig: {
    class: Jamf::OAPISchemas::EnrollmentSsoConfig
  },

  # @!attribute groupEnrollmentAccessEnabled
  #   @return [Boolean]
  groupEnrollmentAccessEnabled: {
    class: :boolean,
    required: true
  },

  # @!attribute groupAttributeName
  #   @return [String]
  groupAttributeName: {
    class: :string,
    required: true
  },

  # @!attribute groupRdnKey
  #   @return [String]
  groupRdnKey: {
    class: :string,
    required: true
  },

  # @!attribute groupEnrollmentAccessName
  #   @return [String]
  groupEnrollmentAccessName: {
    class: :string
  },

  # @!attribute idpProviderType
  #   @return [String]
  idpProviderType: {
    class: :string,
    required: true,
    enum: IDP_PROVIDER_TYPE_OPTIONS
  },

  # @!attribute idpUrl
  #   @return [String]
  idpUrl: {
    class: :string
  },

  # @!attribute entityId
  #   @return [String]
  entityId: {
    class: :string,
    required: true
  },

  # @!attribute metadataFileName
  #   @return [String]
  metadataFileName: {
    class: :string
  },

  # @!attribute otherProviderTypeName
  #   @return [String]
  otherProviderTypeName: {
    class: :string
  },

  # @!attribute federationMetadataFile
  #   @return [String]
  federationMetadataFile: {
    class: :string,
    format: 'byte',
    pattern: Regexp.new('^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$')
  },

  # @!attribute metadataSource
  #   @return [String]
  metadataSource: {
    class: :string,
    required: true,
    enum: METADATA_SOURCE_OPTIONS
  },

  # @!attribute sessionTimeout
  #   @return [Integer]
  sessionTimeout: {
    class: :integer,
    format: 'int32'
  }

}

Instance Attribute Summary collapse

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#metadataSource ⇒ `String`

Returns:

(String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/sso_settings.rb', line 232

#sessionTimeout ⇒ `Integer`