Class: Jamf::OAPISchemas::UserMappings

Inherits:

Jamf::OAPIObject

• Object
• Jamf::OAPIObject
• Jamf::OAPISchemas::UserMappings

Defined in:

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

Overview

OAPI Object Model and Enums for: UserMappings

Description of this class from the OAPI Schema:

Cloud Identity Provider user mappings configuration

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::CloudLdapMappingsRequest
- Jamf::OAPISchemas::CloudLdapMappingsResponse

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

OBJECT_CLASS_LIMITATION_OPTIONS =

Enums used by this class or others

[
  'ANY_OBJECT_CLASSES',
  'ALL_OBJECT_CLASSES'
]

SEARCH_SCOPE_OPTIONS =

[
  'ALL_SUBTREES',
  'FIRST_LEVEL_ONLY'
]

OAPI_PROPERTIES =

{

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

}

Instance Attribute Summary

• #additionalSearchBase ⇒ String
• #building ⇒ String
• #department ⇒ String
• #emailAddress ⇒ String
• #objectClasses ⇒ String
• #objectClassLimitation ⇒ String
• #phone ⇒ String
• #position ⇒ String
• #realName ⇒ String
• #room ⇒ String
• #searchBase ⇒ String
• #searchScope ⇒ String
• #userID ⇒ String
• #username ⇒ String
• #userUuid ⇒ String

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#additionalSearchBase ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/user_mappings.rb', line 111

#building ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/user_mappings.rb', line 152

#department ⇒ String

Returns:

• (String)

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

#emailAddress ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/user_mappings.rb', line 138

#objectClasses ⇒ String

Returns:

• (String)

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

#objectClassLimitation ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/user_mappings.rb', line 81

#phone ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/user_mappings.rb', line 166

#position ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/user_mappings.rb', line 173

#realName ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/user_mappings.rb', line 131

#room ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/user_mappings.rb', line 159

#searchBase ⇒ String

Returns:

• (String)

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

#searchScope ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/user_mappings.rb', line 103

#userID ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/user_mappings.rb', line 117

#username ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/user_mappings.rb', line 124

#userUuid ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/user_mappings.rb', line 180