Class: Jamf::OAPISchemas::VenafiCaRecord

Inherits:

Jamf::OAPIObject

• Object
• Jamf::OAPIObject
• Jamf::OAPISchemas::VenafiCaRecord

Defined in:

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

Overview

OAPI Object Model and Enums for: VenafiCaRecord

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/pki/venafi:POST' needs permissions:
  - Update PKI
- '/v1/pki/venafi/{id}:GET' needs permissions:
  - Read PKI
- '/v1/pki/venafi/{id}:PATCH' needs permissions:
  - Update PKI

Constant Summary

OAPI_PROPERTIES =

{

  # @!attribute [r] id
  #   @return [Integer]
  id: {
    class: :j_id,
    identifier: :primary,
    readonly: true
  },

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

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

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

  # @!attribute [r] passwordConfigured
  #   @return [Boolean]
  passwordConfigured: {
    class: :boolean,
    readonly: true
  },

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

  # @!attribute revocationEnabled
  #   @return [Boolean]
  revocationEnabled: {
    class: :boolean
  },

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

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

  # @!attribute [r] refreshTokenConfigured
  #   @return [Boolean]
  refreshTokenConfigured: {
    class: :boolean,
    readonly: true
  }

}

Instance Attribute Summary

• #clientId ⇒ String
• #id ⇒ Integer readonly
• #name ⇒ String
• #password ⇒ String
• #passwordConfigured ⇒ Boolean readonly
• #proxyAddress ⇒ String
• #refreshToken ⇒ String
• #refreshTokenConfigured ⇒ Boolean readonly
• #revocationEnabled ⇒ Boolean
• #username ⇒ String

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#clientId ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/venafi_ca_record.rb', line 122

#id ⇒ Integer (readonly)

Returns:

• (Integer)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/venafi_ca_record.rb', line 74

#name ⇒ String

Returns:

• (String)

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

#password ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/venafi_ca_record.rb', line 95

#passwordConfigured ⇒ Boolean (readonly)

Returns:

• (Boolean)

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

#proxyAddress ⇒ String

Returns:

• (String)

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

#refreshToken ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/venafi_ca_record.rb', line 128

#refreshTokenConfigured ⇒ Boolean (readonly)

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/venafi_ca_record.rb', line 135

#revocationEnabled ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/venafi_ca_record.rb', line 116

#username ⇒ String

Returns:

• (String)

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