Class: Jamf::OAPISchemas::Authorization

Inherits:

Jamf::OAPIObject

• Object
• Jamf::OAPIObject
• Jamf::OAPISchemas::Authorization

Defined in:

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

Overview

OAPI Object Model and Enums for: Authorization

This class was automatically genereated from the api/schema URL path on a Jamf Pro server version 10.36.1-t1645562643

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.

- Jamf::OAPISchemas::AuthAccount
- Jamf::OAPISchemas::AccountGroup
- Jamf::OAPISchemas::Site

Endpoints and Privileges: API endpoints and HTTP operations that use this object model, and the Jamf Pro privileges needed to access them.

- '/auth:GET' needs permissions:
  - Unknown

Constant Summary

AUTHENTICATION_TYPE_OPTIONS =

Enums used by this class or others

[
  'JSS',
  'LDAP',
  'SAML',
  'INVITE',
  'OAUTH',
  'DEVICE_SIGNATURE',
  'CLOUD_CONNECTOR',
  'SYSTEM_ACCOUNT'
]

OAPI_PROPERTIES =

{

  # @!attribute account
  #   @return [Jamf::OAPISchemas::AuthAccount]
  account: {
    class: Jamf::OAPISchemas::AuthAccount
  },

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

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

  # @!attribute authenticationType
  #   @return [String]
  authenticationType: {
    class: :string,
    enum: AUTHENTICATION_TYPE_OPTIONS
  }

}

Instance Attribute Summary

• #account ⇒ Jamf::OAPISchemas::AuthAccount
• #accountGroups ⇒ Array<Jamf::OAPISchemas::AccountGroup>
• #authenticationType ⇒ String
• #sites ⇒ Array<Jamf::OAPISchemas::Site>

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#account ⇒ Jamf::OAPISchemas::AuthAccount

Returns:

• (Jamf::OAPISchemas::AuthAccount)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/authorization.rb', line 84

#accountGroups ⇒ Array<Jamf::OAPISchemas::AccountGroup>

Returns:

• (Array<Jamf::OAPISchemas::AccountGroup>)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/authorization.rb', line 90

#authenticationType ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/authorization.rb', line 104

#sites ⇒ Array<Jamf::OAPISchemas::Site>

Returns:

• (Array<Jamf::OAPISchemas::Site>)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/authorization.rb', line 97