Class: Jamf::OAPISchemas::SessionCandidateRequest

Inherits:
Jamf::OAPIObject show all
Defined in:
lib/jamf/api/jamf_pro/oapi_schemas/session_candidate_request.rb

Overview

OAPI Object Model and Enums for: SessionCandidateRequest

Description of this class from the OAPI Schema:

Request to crate new remote session. Ultimately this allows connection between an admin and an end-user

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.

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

- '/preview/remote-administration-configurations/team-viewer/{configurationId}/sessions:POST' needs permissions:
  - Create Remote Administration

Constant Summary collapse

DEVICE_TYPE_OPTIONS =

Enums used by this class or others

[
  'COMPUTER'
]
OAPI_PROPERTIES = 
{

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

  # Device type
  # @!attribute deviceType
  #   @return [String]
  deviceType: {
    class: :string,
    required: true,
    enum: DEVICE_TYPE_OPTIONS
  },

  # Session description. To be used for additional context on the reason of the session
  # @!attribute description
  #   @return [String]
  description: {
    class: :string,
    required: true,
    min_length: 0,
    max_length: 255
  }

}

Instance Attribute Summary collapse

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#description ⇒ String

Returns:




# File 'lib/jamf/api/jamf_pro/oapi_schemas/session_candidate_request.rb', line 92

#deviceId ⇒ String

Returns:




# File 'lib/jamf/api/jamf_pro/oapi_schemas/session_candidate_request.rb', line 75

#deviceType ⇒ String

Returns:




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