Class: Jamf::OAPISchemas::ConnectionConfigurationResponse

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

Overview

OAPI Object Model and Enums for: ConnectionConfigurationResponse

Description of this class from the OAPI Schema:

Response that contains information about connection configuration for Team Viewer

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/{id}:GET' needs permissions:
  - Read Remote Administration
- '/preview/remote-administration-configurations/team-viewer/{id}:PATCH' needs permissions:
  - Update Remote Administration

Constant Summary collapse

OAPI_PROPERTIES = 
{

  # An identifier of connection configuration for Team Viewer Remote Administration
  # @!attribute id
  #   @return [String]
  id: {
    class: :j_id,
    required: true,
    identifier: :primary
  },

  # An identifier of a site which Team Viewer Remote Administration is configured on
  # @!attribute siteId
  #   @return [String]
  siteId: {
    class: :string,
    required: true
  },

  # Name for Team Viewer Connection Configuration
  # @!attribute displayName
  #   @return [String]
  displayName: {
    class: :string,
    required: true
  },

  # Describes if Team Viewer connection is enabled or disabled
  # @!attribute enabled
  #   @return [Boolean]
  enabled: {
    class: :boolean,
    required: true
  },

  # Number of minutes before the session expires
  # @!attribute sessionTimeout
  #   @return [Integer]
  sessionTimeout: {
    class: :integer,
    required: true,
    nil_ok: true,
    minimum: 1,
    maximum: 1440
  }

}

Instance Attribute Summary collapse

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#displayName ⇒ String

Returns:




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

#enabled ⇒ Boolean

Returns:

  • (Boolean) 



# File 'lib/jamf/api/jamf_pro/oapi_schemas/connection_configuration_response.rb', line 98

#id ⇒ String

Returns:




# File 'lib/jamf/api/jamf_pro/oapi_schemas/connection_configuration_response.rb', line 73

#sessionTimeout ⇒ Integer

Returns:

  • (Integer) 



# File 'lib/jamf/api/jamf_pro/oapi_schemas/connection_configuration_response.rb', line 106

#siteId ⇒ String

Returns:




# File 'lib/jamf/api/jamf_pro/oapi_schemas/connection_configuration_response.rb', line 82