Class: Jamf::OAPISchemas::EnrollmentAccessGroup

Inherits:

Jamf::OAPIObject

• Object
• Jamf::OAPIObject
• Jamf::OAPISchemas::EnrollmentAccessGroup

Defined in:

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

Overview

OAPI Object Model and Enums for: EnrollmentAccessGroup

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

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

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.

- '/v1/enrollment/access-groups/{group-key}:GET' needs permissions:
  - Read User-Initiated Enrollment
- '/v1/enrollment/access-groups/{group-key}:PUT' needs permissions:
  - Update User-Initiated Enrollment

Constant Summary

OAPI_PROPERTIES =

{

  # @!attribute [r] id
  #   @return [String]
  id: {
    class: :j_id,
    identifier: :primary,
    readonly: true
  },

  # @!attribute ldapServerId
  #   @return [Integer]
  ldapServerId: {
    class: :integer
  },

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

  # @!attribute siteId
  #   @return [Integer]
  siteId: {
    class: :integer
  },

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

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

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

}

Instance Attribute Summary

• #id ⇒ String readonly
• #isEnableEnterpriseEnrollment ⇒ Boolean
• #isEnablePersonalEnrollment ⇒ Boolean
• #isRequireEula ⇒ Boolean
• #ldapServerId ⇒ Integer
• #name ⇒ String
• #siteId ⇒ Integer

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#id ⇒ String (readonly)

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/enrollment_access_group.rb', line 73

#isEnableEnterpriseEnrollment ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/enrollment_access_group.rb', line 99

#isEnablePersonalEnrollment ⇒ Boolean

Returns:

• (Boolean)

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

#isRequireEula ⇒ Boolean

Returns:

• (Boolean)

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

#ldapServerId ⇒ Integer

Returns:

• (Integer)

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

#name ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/enrollment_access_group.rb', line 87

#siteId ⇒ Integer

Returns:

• (Integer)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/enrollment_access_group.rb', line 93