Class: Jamf::OAPISchemas::CloudIdPCommon

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

Overview

OAPI Object Model and Enums for: CloudIdPCommon

Description of this class from the OAPI Schema:

A Cloud Identity Provider information

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.

- Jamf::OAPISchemas::AzureConfiguration
- Jamf::OAPISchemas::AzureConfigurationUpdate
- Jamf::OAPISchemas::LdapConfigurationResponse
- Jamf::OAPISchemas::LdapConfigurationUpdate

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/cloud-idp/{id}:GET' needs permissions:
  - Read LDAP Servers

Constant Summary collapse

PROVIDER_NAME_OPTIONS =

Enums used by this class or others

[
  'GOOGLE',
  'AZURE'
]
OAPI_PROPERTIES = 
{

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

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

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

}

Instance Attribute Summary collapse

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#displayName ⇒ String

Returns:




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

#id ⇒ String

Returns:




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

#providerName ⇒ String

Returns:




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