Class: Jamf::OAPISchemas::CloudLdapServerRequest

Inherits:

Jamf::OAPIObject

• Object
• Jamf::OAPIObject
• Jamf::OAPISchemas::CloudLdapServerRequest

Defined in:

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

Overview

OAPI Object Model and Enums for: CloudLdapServerRequest

Description of this class from the OAPI Schema:

A Cloud Identity Provider LDAP server configuration for requests

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

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::LdapConfigurationRequest

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

- Jamf::OAPISchemas::CloudLdapKeystoreFile

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

Constant Summary

CONNECTION_TYPE_OPTIONS =

Enums used by this class or others

[
  'LDAPS',
  'START_TLS'
]

OAPI_PROPERTIES =

{

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

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

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

  # @!attribute port
  #   @return [Integer]
  port: {
    class: :integer,
    required: true,
    minimum: 1,
    maximum: 65535
  },

  # @!attribute keystore
  #   @return [Jamf::OAPISchemas::CloudLdapKeystoreFile]
  keystore: {
    class: Jamf::OAPISchemas::CloudLdapKeystoreFile,
    required: true
  },

  # @!attribute connectionTimeout
  #   @return [Integer]
  connectionTimeout: {
    class: :integer,
    required: true,
    minimum: 5,
    maximum: 600.0
  },

  # @!attribute searchTimeout
  #   @return [Integer]
  searchTimeout: {
    class: :integer,
    required: true,
    minimum: 5,
    maximum: 600.0
  },

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

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

  # @!attribute membershipCalculationOptimizationEnabled
  #   @return [Boolean]
  membershipCalculationOptimizationEnabled: {
    class: :boolean
  }

}

Instance Attribute Summary

• #connectionTimeout ⇒ Integer
• #connectionType ⇒ String
• #domainName ⇒ String
• #enabled ⇒ Boolean
• #keystore ⇒ Jamf::OAPISchemas::CloudLdapKeystoreFile
• #membershipCalculationOptimizationEnabled ⇒ Boolean
• #port ⇒ Integer
• #searchTimeout ⇒ Integer
• #serverUrl ⇒ String
• #useWildcards ⇒ Boolean

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#connectionTimeout ⇒ Integer

Returns:

• (Integer)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/cloud_ldap_server_request.rb', line 112

#connectionType ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/cloud_ldap_server_request.rb', line 137

#domainName ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/cloud_ldap_server_request.rb', line 89

#enabled ⇒ Boolean

Returns:

• (Boolean)

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

#keystore ⇒ Jamf::OAPISchemas::CloudLdapKeystoreFile

Returns:

• (Jamf::OAPISchemas::CloudLdapKeystoreFile)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/cloud_ldap_server_request.rb', line 105

#membershipCalculationOptimizationEnabled ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/cloud_ldap_server_request.rb', line 145

#port ⇒ Integer

Returns:

• (Integer)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/cloud_ldap_server_request.rb', line 96

#searchTimeout ⇒ Integer

Returns:

• (Integer)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/cloud_ldap_server_request.rb', line 121

#serverUrl ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/cloud_ldap_server_request.rb', line 75

#useWildcards ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/cloud_ldap_server_request.rb', line 130