Class: Jamf::OAPISchemas::SupervisionIdentity

Inherits:

Jamf::OAPIObject

• Object
• Jamf::OAPIObject
• Jamf::OAPISchemas::SupervisionIdentity

Defined in:

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

Overview

OAPI Object Model and Enums for: SupervisionIdentity

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

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/supervision-identities:POST' needs permissions:
  - Update Apple Configurator Enrollment
- '/v1/supervision-identities/upload:POST' needs permissions:
  - Update Apple Configurator Enrollment
- '/v1/supervision-identities/{id}:GET' needs permissions:
  - Read Apple Configurator Enrollment
- '/v1/supervision-identities/{id}:PUT' needs permissions:
  - Update Apple Configurator Enrollment

Constant Summary

OAPI_PROPERTIES =

{

  # @!attribute id
  #   @return [Integer]
  id: {
    class: :j_id,
    identifier: :primary
  },

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

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

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

}

Instance Attribute Summary

• #commonName ⇒ String
• #displayName ⇒ String
• #expirationDate ⇒ String
• #id ⇒ Integer

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#commonName ⇒ String

Returns:

• (String)

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

#displayName ⇒ String

Returns:

• (String)

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

#expirationDate ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/supervision_identity.rb', line 95

#id ⇒ Integer

Returns:

• (Integer)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/supervision_identity.rb', line 76