ruby-jss 1.6.4 → 2.0.0b1

data/lib/jamf/api/jamf_pro/oapi_schemas/sso_metadata_url.rb

@@ -0,0 +1,83 @@
+# Copyright 2022 Pixar
+#
+#    Licensed under the Apache License, Version 2.0 (the "Apache License")
+#    with the following modification; you may not use this file except in
+#    compliance with the Apache License and the following modification to it:
+#    Section 6. Trademarks. is deleted and replaced with:
+#
+#    6. Trademarks. This License does not grant permission to use the trade
+#       names, trademarks, service marks, or product names of the Licensor
+#       and its affiliates, except as required to comply with Section 4(c) of
+#       the License and to reproduce the content of the NOTICE file.
+#
+#    You may obtain a copy of the Apache License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the Apache License with the above modification is
+#    distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+#    KIND, either express or implied. See the Apache License for the specific
+#    language governing permissions and limitations under the Apache License.
+#
+
+
+module Jamf
+
+  # This module is the namespace for all objects defined
+  # in the OAPI JSON schema under the components => schemas key
+  #
+  module OAPISchemas
+
+
+    # OAPI Object Model and Enums for: SsoMetadataUrl
+    #
+    #
+    #
+    # This class was automatically genereated from the api/schema
+    # URL path on a Jamf Pro server version 10.40.0-t1657115323
+    #
+    # 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/sso/validate:POST' needs permissions:
+    #    - Update SSO Settings
+    #
+    #
+    class SsoMetadataUrl < Jamf::OAPIObject
+
+      
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute idpUrl
+        #   @return [String]
+        idpUrl: {
+          class: :string,
+          required: true
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class SsoMetadataUrl
+
+  end # module OAPISchemas
+
+end # module Jamf

data/lib/jamf/api/jamf_pro/oapi_schemas/sso_settings.rb

@@ -0,0 +1,240 @@
+# Copyright 2022 Pixar
+#
+#    Licensed under the Apache License, Version 2.0 (the "Apache License")
+#    with the following modification; you may not use this file except in
+#    compliance with the Apache License and the following modification to it:
+#    Section 6. Trademarks. is deleted and replaced with:
+#
+#    6. Trademarks. This License does not grant permission to use the trade
+#       names, trademarks, service marks, or product names of the Licensor
+#       and its affiliates, except as required to comply with Section 4(c) of
+#       the License and to reproduce the content of the NOTICE file.
+#
+#    You may obtain a copy of the Apache License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the Apache License with the above modification is
+#    distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+#    KIND, either express or implied. See the Apache License for the specific
+#    language governing permissions and limitations under the Apache License.
+#
+
+
+module Jamf
+
+  # This module is the namespace for all objects defined
+  # in the OAPI JSON schema under the components => schemas key
+  #
+  module OAPISchemas
+
+
+    # OAPI Object Model and Enums for: SsoSettings
+    #
+    #
+    #
+    # This class was automatically genereated from the api/schema
+    # URL path on a Jamf Pro server version 10.40.0-t1657115323
+    #
+    # 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/sso:GET' needs permissions:
+    #    - Read SSO Settings
+    #  - '/v1/sso:PUT' needs permissions:
+    #    - Update SSO Settings
+    #
+    #
+    class SsoSettings < Jamf::OAPIObject
+
+      # Enums used by this class or others
+
+      USER_MAPPING_OPTIONS = [
+        'USERNAME',
+        'EMAIL'
+      ]
+
+      IDP_PROVIDER_TYPE_OPTIONS = [
+        'ADFS',
+        'OKTA',
+        'GOOGLE',
+        'SHIBBOLETH',
+        'ONELOGIN',
+        'PING',
+        'CENTRIFY',
+        'AZURE',
+        'OTHER'
+      ]
+
+      METADATA_SOURCE_OPTIONS = [
+        'URL',
+        'FILE',
+        'UNKNOWN'
+      ]
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute ssoForEnrollmentEnabled
+        #   @return [Boolean]
+        ssoForEnrollmentEnabled: {
+          class: :boolean,
+          required: true
+        },
+
+        # @!attribute ssoBypassAllowed
+        #   @return [Boolean]
+        ssoBypassAllowed: {
+          class: :boolean,
+          required: true
+        },
+
+        # @!attribute ssoEnabled
+        #   @return [Boolean]
+        ssoEnabled: {
+          class: :boolean,
+          required: true
+        },
+
+        # @!attribute ssoForMacOsSelfServiceEnabled
+        #   @return [Boolean]
+        ssoForMacOsSelfServiceEnabled: {
+          class: :boolean,
+          required: true
+        },
+
+        # @!attribute tokenExpirationDisabled
+        #   @return [Boolean]
+        tokenExpirationDisabled: {
+          class: :boolean,
+          required: true
+        },
+
+        # @!attribute userAttributeEnabled
+        #   @return [Boolean]
+        userAttributeEnabled: {
+          class: :boolean,
+          required: true
+        },
+
+        # @!attribute userAttributeName
+        #   @return [String]
+        userAttributeName: {
+          class: :string
+        },
+
+        # @!attribute userMapping
+        #   @return [String]
+        userMapping: {
+          class: :string,
+          required: true,
+          enum: USER_MAPPING_OPTIONS
+        },
+
+        # @!attribute groupEnrollmentAccessEnabled
+        #   @return [Boolean]
+        groupEnrollmentAccessEnabled: {
+          class: :boolean,
+          required: true
+        },
+
+        # @!attribute groupAttributeName
+        #   @return [String]
+        groupAttributeName: {
+          class: :string,
+          required: true
+        },
+
+        # @!attribute groupRdnKey
+        #   @return [String]
+        groupRdnKey: {
+          class: :string,
+          required: true
+        },
+
+        # @!attribute groupEnrollmentAccessName
+        #   @return [String]
+        groupEnrollmentAccessName: {
+          class: :string
+        },
+
+        # @!attribute idpProviderType
+        #   @return [String]
+        idpProviderType: {
+          class: :string,
+          required: true,
+          enum: IDP_PROVIDER_TYPE_OPTIONS
+        },
+
+        # @!attribute idpUrl
+        #   @return [String]
+        idpUrl: {
+          class: :string
+        },
+
+        # @!attribute entityId
+        #   @return [String]
+        entityId: {
+          class: :string,
+          required: true
+        },
+
+        # @!attribute metadataFileName
+        #   @return [String]
+        metadataFileName: {
+          class: :string
+        },
+
+        # @!attribute otherProviderTypeName
+        #   @return [String]
+        otherProviderTypeName: {
+          class: :string
+        },
+
+        # @!attribute federationMetadataFile
+        #   @return [String]
+        federationMetadataFile: {
+          class: :string,
+          format: 'byte',
+          pattern: Regexp.new('^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$')
+        },
+
+        # @!attribute metadataSource
+        #   @return [String]
+        metadataSource: {
+          class: :string,
+          required: true,
+          enum: METADATA_SOURCE_OPTIONS
+        },
+
+        # @!attribute sessionTimeout
+        #   @return [Integer]
+        sessionTimeout: {
+          class: :integer,
+          format: 'int32'
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class SsoSettings
+
+  end # module OAPISchemas
+
+end # module Jamf

data/lib/jamf/api/jamf_pro/oapi_schemas/startup_status.rb

@@ -0,0 +1,185 @@
+# Copyright 2022 Pixar
+#
+#    Licensed under the Apache License, Version 2.0 (the "Apache License")
+#    with the following modification; you may not use this file except in
+#    compliance with the Apache License and the following modification to it:
+#    Section 6. Trademarks. is deleted and replaced with:
+#
+#    6. Trademarks. This License does not grant permission to use the trade
+#       names, trademarks, service marks, or product names of the Licensor
+#       and its affiliates, except as required to comply with Section 4(c) of
+#       the License and to reproduce the content of the NOTICE file.
+#
+#    You may obtain a copy of the Apache License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the Apache License with the above modification is
+#    distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+#    KIND, either express or implied. See the Apache License for the specific
+#    language governing permissions and limitations under the Apache License.
+#
+
+
+module Jamf
+
+  # This module is the namespace for all objects defined
+  # in the OAPI JSON schema under the components => schemas key
+  #
+  module OAPISchemas
+
+
+    # OAPI Object Model and Enums for: StartupStatus
+    #
+    #
+    #
+    # This class was automatically genereated from the api/schema
+    # URL path on a Jamf Pro server version 10.40.0-t1657115323
+    #
+    # 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.
+    #  - '/startup-status:GET' needs permissions:
+    #    - Unknown
+    #
+    #
+    class StartupStatus < Jamf::OAPIObject
+
+      # Enums used by this class or others
+
+      STEP_CODE_OPTIONS = [
+        'SERVER_INIT_START',
+        'SERVER_INIT_ANALYZING_WEBAPP',
+        'SERVER_INIT_POPULATING_NAVIGATION',
+        'SERVER_INIT_POPULATING_OBJECTS',
+        'SERVER_INIT_INITIALIZING_OBJ',
+        'SERVER_INIT_VERIFYING_CACHE',
+        'SERVER_INIT_INITIALIZING_CHANGE_MANAGEMENT',
+        'SERVER_INIT_INITIALIZING_COMMUNICATION_SYSTEM',
+        'SERVER_INIT_INITIALIZING_MDM_QUEUE_MONITOR',
+        'SERVER_INIT_CALCULATING_SMART_GROUPS',
+        'SERVER_INIT_DB_SCHEMA_COMPARE',
+        'SERVER_INIT_DB_TABLE_CHECK_FOR_RENAME',
+        'SERVER_INIT_DB_TABLE_ALTER',
+        'SERVER_INIT_DB_TABLE_ANALYZING',
+        'SERVER_INIT_DB_TABLE_CREATE',
+        'SERVER_INIT_DB_TABLE_DROP',
+        'SERVER_INIT_DB_TABLE_RENAME',
+        'SERVER_INIT_DB_COLUMN_RENAME',
+        'SERVER_INIT_DB_COLUMN_ENCODING_CHANGE_STEP_1',
+        'SERVER_INIT_DB_COLUMN_ENCODING_CHANGE_STEP_2',
+        'SERVER_INIT_DB_COLUMN_ENCODING_CHANGE_STEP_3',
+        'SERVER_INIT_DB_UPGRADE_CHECK',
+        'SERVER_INIT_DB_UPGRADE_COMPLETE',
+        'SERVER_INIT_SS_GENERATE_NOTIFICATIONS',
+        'SERVER_INIT_SS_GENERATE_NOTIFICATIONS_STATUS',
+        'SERVER_INIT_SS_GENERATE_NOTIFICATIONS_FINALIZE',
+        'SERVER_INIT_PKI_MIGRATION_DONE',
+        'SERVER_INIT_PKI_MIGRATION_STATUS',
+        'SERVER_INIT_MEMCACHED_ENDPOINTS_CHECK',
+        'SERVER_INIT_CACHE_FLUSHING',
+        'SERVER_INIT_COMPLETE'
+      ]
+
+      WARNING_CODE_OPTIONS = [
+        'SERVER_INIT_WARNING_DB_TABLE_ENCODING'
+      ]
+
+      ERROR_CODE_OPTIONS = [
+        'CACHE_CONFIGURATION_ERROR',
+        'SECONDARY_NODE_STARTUP_ERROR',
+        'MORE_THAN_ONE_CLUSTER_SETTINGS_ERROR',
+        'PRIMARY_NODE_NOT_SET_ERROR',
+        'DATABASE_ERROR',
+        'DATABASE_PASSWORD_MISSING',
+        'EHCACHE_ERROR',
+        'FLAG_INITIALIZATION_FAILED',
+        'MEMCACHED_ERROR',
+        'DATABASE_MYISAM_ERROR',
+        'OLD_VERSION_ERROR'
+      ]
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute step
+        #   @return [String]
+        step: {
+          class: :string
+        },
+
+        # @!attribute stepCode
+        #   @return [String]
+        stepCode: {
+          class: :string,
+          enum: STEP_CODE_OPTIONS
+        },
+
+        # @!attribute stepParam
+        #   @return [String]
+        stepParam: {
+          class: :string
+        },
+
+        # @!attribute percentage
+        #   @return [Integer]
+        percentage: {
+          class: :integer
+        },
+
+        # @!attribute warning
+        #   @return [String]
+        warning: {
+          class: :string
+        },
+
+        # @!attribute warningCode
+        #   @return [String]
+        warningCode: {
+          class: :string,
+          enum: WARNING_CODE_OPTIONS
+        },
+
+        # @!attribute warningParam
+        #   @return [String]
+        warningParam: {
+          class: :string
+        },
+
+        # @!attribute error
+        #   @return [String]
+        error: {
+          class: :string
+        },
+
+        # @!attribute errorCode
+        #   @return [String]
+        errorCode: {
+          class: :string,
+          enum: ERROR_CODE_OPTIONS
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class StartupStatus
+
+  end # module OAPISchemas
+
+end # module Jamf

data/lib/jamf/api/jamf_pro/oapi_schemas/static_user_group.rb

@@ -0,0 +1,91 @@
+# Copyright 2022 Pixar
+#
+#    Licensed under the Apache License, Version 2.0 (the "Apache License")
+#    with the following modification; you may not use this file except in
+#    compliance with the Apache License and the following modification to it:
+#    Section 6. Trademarks. is deleted and replaced with:
+#
+#    6. Trademarks. This License does not grant permission to use the trade
+#       names, trademarks, service marks, or product names of the Licensor
+#       and its affiliates, except as required to comply with Section 4(c) of
+#       the License and to reproduce the content of the NOTICE file.
+#
+#    You may obtain a copy of the Apache License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the Apache License with the above modification is
+#    distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+#    KIND, either express or implied. See the Apache License for the specific
+#    language governing permissions and limitations under the Apache License.
+#
+
+
+module Jamf
+
+  # This module is the namespace for all objects defined
+  # in the OAPI JSON schema under the components => schemas key
+  #
+  module OAPISchemas
+
+
+    # OAPI Object Model and Enums for: StaticUserGroup
+    #
+    #
+    #
+    # This class was automatically genereated from the api/schema
+    # URL path on a Jamf Pro server version 10.40.0-t1657115323
+    #
+    # 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/static-user-groups:GET' needs permissions:
+    #    - Read Static User Groups
+    #  - '/v1/static-user-groups/{id}:GET' needs permissions:
+    #    - Read Static User Groups
+    #
+    #
+    class StaticUserGroup < Jamf::OAPIObject
+
+      
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute id
+        #   @return [Integer]
+        id: {
+          class: :j_id,
+          identifier: :primary
+        },
+
+        # @!attribute name
+        #   @return [String]
+        name: {
+          class: :string
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class StaticUserGroup
+
+  end # module OAPISchemas
+
+end # module Jamf

data/lib/jamf/api/jamf_pro/oapi_schemas/supervision_identity.rb

@@ -0,0 +1,107 @@
+# Copyright 2022 Pixar
+#
+#    Licensed under the Apache License, Version 2.0 (the "Apache License")
+#    with the following modification; you may not use this file except in
+#    compliance with the Apache License and the following modification to it:
+#    Section 6. Trademarks. is deleted and replaced with:
+#
+#    6. Trademarks. This License does not grant permission to use the trade
+#       names, trademarks, service marks, or product names of the Licensor
+#       and its affiliates, except as required to comply with Section 4(c) of
+#       the License and to reproduce the content of the NOTICE file.
+#
+#    You may obtain a copy of the Apache License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the Apache License with the above modification is
+#    distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+#    KIND, either express or implied. See the Apache License for the specific
+#    language governing permissions and limitations under the Apache License.
+#
+
+
+module Jamf
+
+  # This module is the namespace for all objects defined
+  # in the OAPI JSON schema under the components => schemas key
+  #
+  module OAPISchemas
+
+
+    # OAPI Object Model and Enums for: SupervisionIdentity
+    #
+    #
+    #
+    # This class was automatically genereated from the api/schema
+    # URL path on a Jamf Pro server version 10.40.0-t1657115323
+    #
+    # 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::SupervisionIdentitySearchResults
+    #
+    # 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/supervision-identities:POST' needs permissions:
+    #    - Update Apple Configurator Enrollment
+    #  - '/v1/supervision-identities/upload:POST' needs permissions:
+    #    - Update Apple Configurator Enrollment
+    #  - '/v1/supervision-identities/{id}:GET' needs permissions:
+    #    - Read Apple Configurator Enrollment
+    #  - '/v1/supervision-identities/{id}:PUT' needs permissions:
+    #    - Update Apple Configurator Enrollment
+    #
+    #
+    class SupervisionIdentity < Jamf::OAPIObject
+
+      
+
+      OAPI_PROPERTIES = {
+
+        # @!attribute id
+        #   @return [Integer]
+        id: {
+          class: :j_id,
+          identifier: :primary
+        },
+
+        # @!attribute displayName
+        #   @return [String]
+        displayName: {
+          class: :string
+        },
+
+        # @!attribute commonName
+        #   @return [String]
+        commonName: {
+          class: :string
+        },
+
+        # @!attribute expirationDate
+        #   @return [String]
+        expirationDate: {
+          class: :string
+        }
+
+      } # end OAPI_PROPERTIES
+
+    end # class SupervisionIdentity
+
+  end # module OAPISchemas
+
+end # module Jamf