Class: Jamf::OAPISchemas::SsoKeystore

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

Overview

OAPI Object Model and Enums for: SsoKeystore

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.

- Jamf::OAPISchemas::SsoKeystoreWithDetails

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/sso/cert:PUT' needs permissions:
  - Update SSO Settings
- '/v2/sso/cert:PUT' needs permissions:
  - Update SSO Settings

Constant Summary collapse

TYPE_OPTIONS =

Enums used by this class or others

[
  'PKCS12',
  'JKS',
  'NONE'
]
KEYSTORE_SETUP_TYPE_OPTIONS = 
[
  'NONE',
  'UPLOADED',
  'GENERATED'
]
OAPI_PROPERTIES = 
{

  # @!attribute keys
  #   @return [Array<Jamf::OAPISchemas::CertificateKey>]
  keys: {
    class: Jamf::OAPISchemas::CertificateKey,
    multi: true
  },

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

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

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

  # @!attribute keystoreSetupType
  #   @return [String]
  keystoreSetupType: {
    class: :string,
    enum: KEYSTORE_SETUP_TYPE_OPTIONS
  }

}.merge(Jamf::OAPISchemas::SsoKeystoreParse::OAPI_PROPERTIES)

Constructor Details

This class inherits a constructor from Jamf::OAPIObject