Class: Jamf::OAPISchemas::GroupMappings

Inherits:

Jamf::OAPIObject

• Object
• Jamf::OAPIObject
• Jamf::OAPISchemas::GroupMappings

Defined in:

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

Overview

OAPI Object Model and Enums for: GroupMappings

Description of this class from the OAPI Schema:

Cloud Identity Provider user group 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 groupID
  #   @return [String]
  groupID: {
    class: :string,
    required: true
  },

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

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

}

Instance Attribute Summary

• #groupID ⇒ String
• #groupName ⇒ String
• #groupUuid ⇒ String
• #objectClasses ⇒ String
• #objectClassLimitation ⇒ String
• #searchBase ⇒ String
• #searchScope ⇒ String

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#groupID ⇒ String

Returns:

• (String)

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

#groupName ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/group_mappings.rb', line 118

#groupUuid ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/group_mappings.rb', line 125

#objectClasses ⇒ String

Returns:

• (String)

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

#objectClassLimitation ⇒ String

Returns:

• (String)

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

#searchBase ⇒ String

Returns:

• (String)

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

#searchScope ⇒ String

Returns:

• (String)

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