Class: Jamf::OAPISchemas::AccountGroup

Inherits:

Jamf::OAPIObject

• Object
• Jamf::OAPIObject
• Jamf::OAPISchemas::AccountGroup

Defined in:

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

Overview

OAPI Object Model and Enums for: AccountGroup

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::Authorization
- Jamf::OAPISchemas::AuthorizationV1

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

ACCESS_LEVEL_OPTIONS =

Enums used by this class or others

[
  'FullAccess',
  'SiteAccess',
  'GroupBasedAccess'
]

PRIVILEGE_SET_OPTIONS =

[
  'ADMINISTRATOR',
  'AUDITOR',
  'ENROLLMENT',
  'CUSTOM'
]

OAPI_PROPERTIES =

{

  # @!attribute accessLevel
  #   @return [String]
  accessLevel: {
    class: :string,
    enum: ACCESS_LEVEL_OPTIONS
  },

  # @!attribute privilegeSet
  #   @return [String]
  privilegeSet: {
    class: :string,
    enum: PRIVILEGE_SET_OPTIONS
  },

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

  # @!attribute privileges
  #   @return [Array<String>]
  privileges: {
    class: :string,
    multi: true
  },

  # @!attribute memberUserIds
  #   @return [Array<Integer>]
  memberUserIds: {
    class: :integer,
    multi: true
  }

}

Instance Attribute Summary

• #accessLevel ⇒ String
• #memberUserIds ⇒ Array<Integer>
• #privileges ⇒ Array<String>
• #privilegeSet ⇒ String
• #siteId ⇒ Integer

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#accessLevel ⇒ String

Returns:

• (String)

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

#memberUserIds ⇒ Array<Integer>

Returns:

• (Array<Integer>)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/account_group.rb', line 110

#privileges ⇒ Array<String>

Returns:

• (Array<String>)

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

#privilegeSet ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/account_group.rb', line 90

#siteId ⇒ Integer

Returns:

• (Integer)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/account_group.rb', line 97