Class: Jamf::OAPISchemas::ApiIntegrationRequest

Inherits:

Jamf::OAPIObject

• Object
• Jamf::OAPIObject
• Jamf::OAPISchemas::ApiIntegrationRequest

Defined in:

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

Overview

OAPI Object Model and Enums for: ApiIntegrationRequest

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/api-integrations:POST' needs permissions:
  - Create API Integrations
- '/v1/api-integrations/{id}:PUT' needs permissions:
  - Update API Integrations

Constant Summary

OAPI_PROPERTIES =

{

  # API Role display names.
  # @!attribute authorizationScopes
  #   @return [Array<String>]
  authorizationScopes: {
    class: :string,
    required: true,
    multi: true
  },

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

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

  # @!attribute accessTokenLifetimeSeconds
  #   @return [Integer]
  accessTokenLifetimeSeconds: {
    class: :integer
  }

}

Instance Attribute Summary

• #accessTokenLifetimeSeconds ⇒ Integer
• #authorizationScopes ⇒ Array<String>
• #displayName ⇒ String
• #enabled ⇒ Boolean

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#accessTokenLifetimeSeconds ⇒ Integer

Returns:

• (Integer)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/api_integration_request.rb', line 94

#authorizationScopes ⇒ Array<String>

Returns:

• (Array<String>)

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

#displayName ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/api_integration_request.rb', line 81

#enabled ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/api_integration_request.rb', line 88