Class: Jamf::OAPISchemas::Credentials

Inherits:

Jamf::OAPIObject

• Object
• Jamf::OAPIObject
• Jamf::OAPISchemas::Credentials

Defined in:

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

Overview

OAPI Object Model and Enums for: Credentials

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/jcds/files:POST' needs permissions:
  - Create Jamf Content Distribution Server Files
- '/v1/jcds/renew-credentials:POST' needs permissions:
  - Create Jamf Content Distribution Server Files

Constant Summary

OAPI_PROPERTIES =

{

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

  # @!attribute expiration
  #   @return [Integer]
  expiration: {
    class: :integer,
    format: 'int64'
  },

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

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

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

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

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

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

}

Instance Attribute Summary

• #accessKeyID ⇒ String
• #bucketName ⇒ String
• #expiration ⇒ Integer
• #path ⇒ String
• #region ⇒ String
• #secretAccessKey ⇒ String
• #sessionToken ⇒ String
• #uuid ⇒ String

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#accessKeyID ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/credentials.rb', line 72

#bucketName ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/credentials.rb', line 105

#expiration ⇒ Integer

Returns:

• (Integer)

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

#path ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/credentials.rb', line 111

#region ⇒ String

Returns:

• (String)

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

#secretAccessKey ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/credentials.rb', line 86

#sessionToken ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/credentials.rb', line 93

#uuid ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/credentials.rb', line 117