Class: Jamf::OAPISchemas::GsxConnection

Inherits:

Jamf::OAPIObject

• Object
• Jamf::OAPIObject
• Jamf::OAPISchemas::GsxConnection

Defined in:

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

Overview

OAPI Object Model and Enums for: GsxConnection

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.

- Jamf::OAPISchemas::GsxKeystore

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

- '/v1/gsx-connection:GET' needs permissions:
  - Read GSX Connection
  - Read Push Certificates
- '/v1/gsx-connection:PUT' needs permissions:
  - Update GSX Connection
  - Update Push Certificates
- '/v1/gsx-connection:PATCH' needs permissions:
  - Update GSX Connection
  - Update Push Certificates

Constant Summary

OAPI_PROPERTIES =

{

  # @!attribute enabled
  #   @return [Boolean]
  enabled: {
    class: :boolean,
    required: true
  },

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

  # @!attribute serviceAccountNo
  #   @return [String]
  serviceAccountNo: {
    class: :string,
    required: true,
    max_length: 10
  },

  # @!attribute shipToNo
  #   @return [String]
  shipToNo: {
    class: :string,
    max_length: 10
  },

  # @!attribute token
  #   @return [String]
  token: {
    class: :string,
    required: true,
    writeonly: true
  },

  # @!attribute gsxKeystore
  #   @return [Jamf::OAPISchemas::GsxKeystore]
  gsxKeystore: {
    class: Jamf::OAPISchemas::GsxKeystore,
    required: true
  }

}

Instance Attribute Summary

• #enabled ⇒ Boolean
• #gsxKeystore ⇒ Jamf::OAPISchemas::GsxKeystore
• #serviceAccountNo ⇒ String
• #shipToNo ⇒ String
• #token ⇒ String
• #username ⇒ String

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#enabled ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/gsx_connection.rb', line 77

#gsxKeystore ⇒ Jamf::OAPISchemas::GsxKeystore

Returns:

• (Jamf::OAPISchemas::GsxKeystore)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/gsx_connection.rb', line 114

#serviceAccountNo ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/gsx_connection.rb', line 91

#shipToNo ⇒ String

Returns:

• (String)

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

#token ⇒ String

Returns:

• (String)

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

#username ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/gsx_connection.rb', line 84