Class: Jamf::OAPISchemas::ConnectionConfigurationCandidateRequest

Inherits:

Jamf::OAPIObject

• Object
• Jamf::OAPIObject
• Jamf::OAPISchemas::ConnectionConfigurationCandidateRequest

Defined in:

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

Overview

OAPI Object Model and Enums for: ConnectionConfigurationCandidateRequest

Description of this class from the OAPI Schema:

Request that creates configuration and initialize connection between Jamf Pro and Team Viewer

This class was automatically genereated from the api/schema URL path on a Jamf Pro server version 10.46.0-t1681398190

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:POST' needs permissions:
  - Create Remote Administration

Constant Summary

OAPI_PROPERTIES =

{

  # An identifier of a site which Team Viewer Remote Administration will be 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,
    min_length: 1,
    max_length: 255
  },

  # Token which is used for connecting to Team Viewer
  # @!attribute scriptToken
  #   @return [String]
  scriptToken: {
    class: :string,
    required: true,
    min_length: 1,
    max_length: 255
  },

  # Defines the intent to enable or disable Team Viewer connection
  # @!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,
    minimum: 1,
    maximum: 1440
  }

}

Instance Attribute Summary

• #displayName ⇒ String
• #enabled ⇒ Boolean
• #scriptToken ⇒ String
• #sessionTimeout ⇒ Integer
• #siteId ⇒ String

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#displayName ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/connection_configuration_candidate_request.rb', line 79

#enabled ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/connection_configuration_candidate_request.rb', line 99

#scriptToken ⇒ String

Returns:

• (String)

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

#sessionTimeout ⇒ Integer

Returns:

• (Integer)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/connection_configuration_candidate_request.rb', line 107

#siteId ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/connection_configuration_candidate_request.rb', line 71