Class: Jamf::OAPISchemas::ProtectRegistrationRequest

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

Overview

OAPI Object Model and Enums for: ProtectRegistrationRequest

Description of this class from the OAPI Schema:

Create an API Client in the Jamf Protect web console to obtain these values.

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.

- '/v1/jamf-protect/register:POST' needs permissions:
  - Update Jamf Protect Settings

Constant Summary collapse

OAPI_PROPERTIES = 
{

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

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

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

}

Instance Attribute Summary collapse

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#clientId ⇒ String

Returns:




# File 'lib/jamf/api/jamf_pro/oapi_schemas/protect_registration_request.rb', line 78

#password ⇒ String

Returns:




# File 'lib/jamf/api/jamf_pro/oapi_schemas/protect_registration_request.rb', line 85

#protectUrl ⇒ String

Returns:




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