Class: Jamf::OAPISchemas::ApiRoleResult

Inherits:

Jamf::OAPIObject

Object
Jamf::OAPIObject
Jamf::OAPISchemas::ApiRoleResult

show all

Defined in:: lib/jamf/api/jamf_pro/oapi_schemas/api_role_result.rb

Overview

OAPI Object Model and Enums for: ApiRoleResult

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.

Sub Objects: Other object models used by this model’s attributes.

- Jamf::OAPISchemas::ApiRole

Endpoints and Privileges: API endpoints and HTTP operations that use this object model, and the Jamf Pro privileges needed to access them.

- '/v1/api-roles:GET' needs permissions:
  - Read API Roles

Constant Summary collapse

OAPI_PROPERTIES =

{

  # @!attribute [r] totalCount
  #   @return [Integer]
  totalCount: {
    class: :integer,
    required: true,
    readonly: true,
    minimum: 0
  },

  # @!attribute results
  #   @return [Array<Jamf::OAPISchemas::ApiRole>]
  results: {
    class: Jamf::OAPISchemas::ApiRole,
    required: true,
    multi: true,
    min_items: 0
  }

}

Instance Attribute Summary collapse

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#results ⇒ `Array<Jamf::OAPISchemas::ApiRole>`

Returns:

(Array<Jamf::OAPISchemas::ApiRole>)

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

#totalCount ⇒ `Integer` (readonly)