Class: Jamf::OAPISchemas::SessionDetails

Inherits:

Jamf::OAPIObject

• Object
• Jamf::OAPIObject
• Jamf::OAPISchemas::SessionDetails

Defined in:

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

Overview

OAPI Object Model and Enums for: SessionDetails

Description of this class from the OAPI Schema:

Session details

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

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/{sessionId}:GET' needs permissions:
  - Read Remote Administration

Constant Summary

DEVICE_TYPE_OPTIONS =

Enums used by this class or others

[
  'COMPUTER'
]

STATE_OPTIONS =

[
  'OPEN',
  'CLOSED',
  'UNKNOWN'
]

OAPI_PROPERTIES =

{

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

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

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

  # Supporter session URL
  # @!attribute supporterLink
  #   @return [String]
  supporterLink: {
    class: :string
  },

  # End user session URL
  # @!attribute endUserLink
  #   @return [String]
  endUserLink: {
    class: :string
  },

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

  # Device name if found - null otherwise
  # @!attribute deviceName
  #   @return [String]
  deviceName: {
    class: :string
  },

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

  # Session state
  # @!attribute state
  #   @return [String]
  state: {
    class: :string,
    enum: STATE_OPTIONS
  },

  # ID of session creator if session created by Jamf Pro local user, null otherwise
  # @!attribute creatorId
  #   @return [String]
  creatorId: {
    class: :string
  },

  # Username of the session creator
  # @!attribute creatorName
  #   @return [String]
  creatorName: {
    class: :string
  },

  # Session creation time
  # @!attribute createdAt
  #   @return [Jamf::Timestamp]
  createdAt: {
    class: Jamf::Timestamp,
    format: 'date-time'
  }

}

Instance Attribute Summary

• #code ⇒ String
• #createdAt ⇒ Jamf::Timestamp
• #creatorId ⇒ String
• #creatorName ⇒ String
• #description ⇒ String
• #deviceId ⇒ String
• #deviceName ⇒ String
• #deviceType ⇒ String
• #endUserLink ⇒ String
• #id ⇒ String
• #state ⇒ String
• #supporterLink ⇒ String

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#code ⇒ String

Returns:

• (String)

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

#createdAt ⇒ Jamf::Timestamp

Returns:

• (Jamf::Timestamp)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/session_details.rb', line 161

#creatorId ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/session_details.rb', line 147

#creatorName ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/session_details.rb', line 154

#description ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/session_details.rb', line 96

#deviceId ⇒ String

Returns:

• (String)

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

#deviceName ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/session_details.rb', line 124

#deviceType ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/session_details.rb', line 131

#endUserLink ⇒ String

Returns:

• (String)

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

#id ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/session_details.rb', line 81

#state ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/session_details.rb', line 139

#supporterLink ⇒ String

Returns:

• (String)

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