Class: Jamf::OAPISchemas::AzureServerConfiguration

Inherits:

Jamf::OAPIObject

• Object
• Jamf::OAPIObject
• Jamf::OAPISchemas::AzureServerConfiguration

Defined in:

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

Overview

OAPI Object Model and Enums for: AzureServerConfiguration

Description of this class from the OAPI Schema:

Azure Cloud Identity Provider configuration

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.

- Jamf::OAPISchemas::AzureConfiguration

Sub Objects: Other object models used by this model's attributes.

- Jamf::OAPISchemas::AzureMappings

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

- '/v1/cloud-azure/defaults/server-configuration:GET' needs permissions:
  - Read LDAP Servers

Constant Summary

OAPI_PROPERTIES =

{

  # @!attribute id
  #   @return [String]
  id: {
    class: :j_id,
    required: true,
    identifier: :primary
  },

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

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

  # @!attribute migrated
  #   @return [Boolean]
  migrated: {
    class: :boolean,
    required: true
  },

  # @!attribute mappings
  #   @return [Jamf::OAPISchemas::AzureMappings]
  mappings: {
    class: Jamf::OAPISchemas::AzureMappings,
    required: true
  },

  # @!attribute searchTimeout
  #   @return [Integer]
  searchTimeout: {
    class: :integer,
    required: true,
    minimum: 5,
    maximum: 600
  },

  # Use this field to enable transitive membership lookup with Single Sign On
  # @!attribute transitiveMembershipEnabled
  #   @return [Boolean]
  transitiveMembershipEnabled: {
    class: :boolean,
    required: true
  },

  # Use this field to set user field mapping for transitive membership lookup with Single Sign On
  # @!attribute transitiveMembershipUserField
  #   @return [String]
  transitiveMembershipUserField: {
    class: :string,
    required: true
  },

  # Use this field to enable transitive membership lookup. This setting would not apply to Single Sign On
  # @!attribute transitiveDirectoryMembershipEnabled
  #   @return [Boolean]
  transitiveDirectoryMembershipEnabled: {
    class: :boolean,
    required: true
  }

}

Instance Attribute Summary

• #enabled ⇒ Boolean
• #id ⇒ String
• #mappings ⇒ Jamf::OAPISchemas::AzureMappings
• #migrated ⇒ Boolean
• #searchTimeout ⇒ Integer
• #tenantId ⇒ String
• #transitiveDirectoryMembershipEnabled ⇒ Boolean
• #transitiveMembershipEnabled ⇒ Boolean
• #transitiveMembershipUserField ⇒ String

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#enabled ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/azure_server_configuration.rb', line 87

#id ⇒ String

Returns:

• (String)

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

#mappings ⇒ Jamf::OAPISchemas::AzureMappings

Returns:

• (Jamf::OAPISchemas::AzureMappings)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/azure_server_configuration.rb', line 101

#migrated ⇒ Boolean

Returns:

• (Boolean)

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

#searchTimeout ⇒ Integer

Returns:

• (Integer)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/azure_server_configuration.rb', line 108

#tenantId ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/azure_server_configuration.rb', line 80

#transitiveDirectoryMembershipEnabled ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/azure_server_configuration.rb', line 133

#transitiveMembershipEnabled ⇒ Boolean

Returns:

• (Boolean)

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

#transitiveMembershipUserField ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/azure_server_configuration.rb', line 125