Class: Jamf::OAPISchemas::EnrollmentAccessGroupPreview

Inherits:

Jamf::OAPIObject

• Object
• Jamf::OAPIObject
• Jamf::OAPISchemas::EnrollmentAccessGroupPreview

Defined in:

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

Overview

OAPI Object Model and Enums for: EnrollmentAccessGroupPreview

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

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.

- '/v3/enrollment/access-groups:POST' needs permissions:
  - Update User-Initiated Enrollment
- '/v3/enrollment/access-groups/{id}:GET' needs permissions:
  - Read User-Initiated Enrollment
- '/v3/enrollment/access-groups/{id}:PUT' needs permissions:
  - Update User-Initiated Enrollment

Constant Summary

OAPI_PROPERTIES =

{

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

  # LDAP Group ID
  # @!attribute groupId
  #   @return [String]
  groupId: {
    class: :string,
    required: true
  },

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

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

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

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

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

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

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

}

Instance Attribute Summary

• #accountDrivenUserEnrollmentEnabled ⇒ Boolean
• #enterpriseEnrollmentEnabled ⇒ Boolean
• #groupId ⇒ String
• #id ⇒ String readonly
• #ldapServerId ⇒ String
• #name ⇒ String
• #personalEnrollmentEnabled ⇒ Boolean
• #requireEula ⇒ Boolean
• #siteId ⇒ String

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#accountDrivenUserEnrollmentEnabled ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/enrollment_access_group_preview.rb', line 123

#enterpriseEnrollmentEnabled ⇒ Boolean

Returns:

• (Boolean)

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

#groupId ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/enrollment_access_group_preview.rb', line 83

#id ⇒ String (readonly)

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/enrollment_access_group_preview.rb', line 74

#ldapServerId ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/enrollment_access_group_preview.rb', line 91

#name ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/enrollment_access_group_preview.rb', line 98

#personalEnrollmentEnabled ⇒ Boolean

Returns:

• (Boolean)

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

#requireEula ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/enrollment_access_group_preview.rb', line 129

#siteId ⇒ String

Returns:

• (String)

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