ruby-jss 4.1.0 → 4.1.1b2

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

@@ -1,4 +1,4 @@
-# Copyright 2023 Pixar
+# Copyright 2024 Pixar
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")
 #    with the following modification; you may not use this file except in
@@ -34,8 +34,8 @@ module Jamf
     #
     #
     #
-    # This class was automatically genereated from the api/schema
-    # URL path on a Jamf Pro server version 10.50.0-t1693149930
+    # 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.
@@ -59,6 +59,8 @@ module Jamf
     # model, and the Jamf Pro privileges needed to access them.
     #  - '/v1/sso/validate:POST' needs permissions:
     #    - Update SSO Settings
+    #  - '/v2/sso/validate:POST' needs permissions:
+    #    - Update SSO Settings
     #
     #
     class SsoMetadataUrl < Jamf::OAPIObject

data/lib/jamf/api/jamf_pro/oapi_schemas/{sso_settings.rb → sso_settings_v1.rb}

@@ -1,4 +1,4 @@
-# Copyright 2023 Pixar
+# Copyright 2024 Pixar
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")
 #    with the following modification; you may not use this file except in
@@ -30,12 +30,12 @@ module Jamf
   module OAPISchemas
 
 
-    # OAPI Object Model and Enums for: SsoSettings
+    # OAPI Object Model and Enums for: SsoSettingsV1
     #
     #
     #
-    # This class was automatically genereated from the api/schema
-    # URL path on a Jamf Pro server version 10.50.0-t1693149930
+    # 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.
@@ -63,7 +63,7 @@ module Jamf
     #    - Update SSO Settings
     #
     #
-    class SsoSettings < Jamf::OAPIObject
+    class SsoSettingsV1 < Jamf::OAPIObject
 
       # Enums used by this class or others
 
@@ -246,7 +246,7 @@ module Jamf
 
       } # end OAPI_PROPERTIES
 
-    end # class SsoSettings
+    end # class SsoSettingsV1
 
   end # module OAPISchemas
 

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

@@ -0,0 +1,253 @@
+# Copyright 2024 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: SsoSettingsV2
+    #
+    #
+    #
+    # 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.
+    #  - Jamf::OAPISchemas::EnrollmentSsoConfig
+    #
+    # Endpoints and Privileges:
+    # API endpoints and HTTP operations that use this object
+    # model, and the Jamf Pro privileges needed to access them.
+    #  - '/v2/sso:GET' needs permissions:
+    #    - Read SSO Settings
+    #  - '/v2/sso:PUT' needs permissions:
+    #    - Update SSO Settings
+    #
+    #
+    class SsoSettingsV2 < 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 enrollmentSsoForAccountDrivenEnrollmentEnabled
+        #   @return [Boolean]
+        enrollmentSsoForAccountDrivenEnrollmentEnabled: {
+          class: :boolean,
+          required: true
+        },
+
+        # @!attribute enrollmentSsoConfig
+        #   @return [Jamf::OAPISchemas::EnrollmentSsoConfig]
+        enrollmentSsoConfig: {
+          class: Jamf::OAPISchemas::EnrollmentSsoConfig
+        },
+
+        # @!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 SsoSettingsV2
+
+  end # module OAPISchemas
+
+end # module Jamf

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

@@ -1,4 +1,4 @@
-# Copyright 2023 Pixar
+# Copyright 2024 Pixar
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")
 #    with the following modification; you may not use this file except in
@@ -34,8 +34,8 @@ module Jamf
     #
     #
     #
-    # This class was automatically genereated from the api/schema
-    # URL path on a Jamf Pro server version 10.50.0-t1693149930
+    # 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.

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

@@ -1,4 +1,4 @@
-# Copyright 2023 Pixar
+# Copyright 2024 Pixar
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")
 #    with the following modification; you may not use this file except in
@@ -34,8 +34,8 @@ module Jamf
     #
     #
     #
-    # This class was automatically genereated from the api/schema
-    # URL path on a Jamf Pro server version 10.50.0-t1693149930
+    # 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.

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

@@ -1,4 +1,4 @@
-# Copyright 2023 Pixar
+# Copyright 2024 Pixar
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")
 #    with the following modification; you may not use this file except in
@@ -34,8 +34,8 @@ module Jamf
     #
     #
     #
-    # This class was automatically genereated from the api/schema
-    # URL path on a Jamf Pro server version 10.50.0-t1693149930
+    # 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.

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

@@ -1,4 +1,4 @@
-# Copyright 2023 Pixar
+# Copyright 2024 Pixar
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")
 #    with the following modification; you may not use this file except in
@@ -34,8 +34,8 @@ module Jamf
     #
     #
     #
-    # This class was automatically genereated from the api/schema
-    # URL path on a Jamf Pro server version 10.50.0-t1693149930
+    # 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.

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

@@ -1,4 +1,4 @@
-# Copyright 2023 Pixar
+# Copyright 2024 Pixar
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")
 #    with the following modification; you may not use this file except in
@@ -34,8 +34,8 @@ module Jamf
     #
     #
     #
-    # This class was automatically genereated from the api/schema
-    # URL path on a Jamf Pro server version 10.50.0-t1693149930
+    # 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.

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

@@ -1,4 +1,4 @@
-# Copyright 2023 Pixar
+# Copyright 2024 Pixar
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")
 #    with the following modification; you may not use this file except in
@@ -34,8 +34,8 @@ module Jamf
     #
     #
     #
-    # This class was automatically genereated from the api/schema
-    # URL path on a Jamf Pro server version 10.50.0-t1693149930
+    # 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.

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

@@ -1,4 +1,4 @@
-# Copyright 2023 Pixar
+# Copyright 2024 Pixar
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")
 #    with the following modification; you may not use this file except in
@@ -34,8 +34,8 @@ module Jamf
     #
     #
     #
-    # This class was automatically genereated from the api/schema
-    # URL path on a Jamf Pro server version 10.50.0-t1693149930
+    # 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.

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

@@ -1,4 +1,4 @@
-# Copyright 2023 Pixar
+# Copyright 2024 Pixar
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")
 #    with the following modification; you may not use this file except in
@@ -34,8 +34,8 @@ module Jamf
     #
     #
     #
-    # This class was automatically genereated from the api/schema
-    # URL path on a Jamf Pro server version 10.50.0-t1693149930
+    # 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.

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

@@ -1,4 +1,4 @@
-# Copyright 2023 Pixar
+# Copyright 2024 Pixar
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")
 #    with the following modification; you may not use this file except in
@@ -34,8 +34,8 @@ module Jamf
     #
     #
     #
-    # This class was automatically genereated from the api/schema
-    # URL path on a Jamf Pro server version 10.50.0-t1693149930
+    # 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.

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

@@ -1,4 +1,4 @@
-# Copyright 2023 Pixar
+# Copyright 2024 Pixar
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")
 #    with the following modification; you may not use this file except in
@@ -34,8 +34,8 @@ module Jamf
     #
     #
     #
-    # This class was automatically genereated from the api/schema
-    # URL path on a Jamf Pro server version 10.50.0-t1693149930
+    # 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.

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

@@ -1,4 +1,4 @@
-# Copyright 2023 Pixar
+# Copyright 2024 Pixar
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")
 #    with the following modification; you may not use this file except in
@@ -34,8 +34,8 @@ module Jamf
     #
     #
     #
-    # This class was automatically genereated from the api/schema
-    # URL path on a Jamf Pro server version 10.50.0-t1693149930
+    # 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.

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

@@ -1,4 +1,4 @@
-# Copyright 2023 Pixar
+# Copyright 2024 Pixar
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")
 #    with the following modification; you may not use this file except in
@@ -34,8 +34,8 @@ module Jamf
     #
     #
     #
-    # This class was automatically genereated from the api/schema
-    # URL path on a Jamf Pro server version 10.50.0-t1693149930
+    # 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.

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

@@ -1,4 +1,4 @@
-# Copyright 2023 Pixar
+# Copyright 2024 Pixar
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")
 #    with the following modification; you may not use this file except in
@@ -34,8 +34,8 @@ module Jamf
     #
     #
     #
-    # This class was automatically genereated from the api/schema
-    # URL path on a Jamf Pro server version 10.50.0-t1693149930
+    # 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.

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

@@ -1,4 +1,4 @@
-# Copyright 2023 Pixar
+# Copyright 2024 Pixar
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")
 #    with the following modification; you may not use this file except in
@@ -34,8 +34,8 @@ module Jamf
     #
     #
     #
-    # This class was automatically genereated from the api/schema
-    # URL path on a Jamf Pro server version 10.50.0-t1693149930
+    # 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.

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

@@ -1,4 +1,4 @@
-# Copyright 2023 Pixar
+# Copyright 2024 Pixar
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")
 #    with the following modification; you may not use this file except in
@@ -34,8 +34,8 @@ module Jamf
     #
     #
     #
-    # This class was automatically genereated from the api/schema
-    # URL path on a Jamf Pro server version 10.50.0-t1693149930
+    # 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.

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

@@ -1,4 +1,4 @@
-# Copyright 2023 Pixar
+# Copyright 2024 Pixar
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")
 #    with the following modification; you may not use this file except in
@@ -34,8 +34,8 @@ module Jamf
     #
     #
     #
-    # This class was automatically genereated from the api/schema
-    # URL path on a Jamf Pro server version 10.50.0-t1693149930
+    # 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.

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

@@ -1,4 +1,4 @@
-# Copyright 2023 Pixar
+# Copyright 2024 Pixar
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")
 #    with the following modification; you may not use this file except in
@@ -35,8 +35,8 @@ module Jamf
     # Description of this class from the OAPI Schema:
     #   will be populated if the type is appleTv.
     #
-    # This class was automatically genereated from the api/schema
-    # URL path on a Jamf Pro server version 10.50.0-t1693149930
+    # 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.

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

@@ -1,4 +1,4 @@
-# Copyright 2023 Pixar
+# Copyright 2024 Pixar
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")
 #    with the following modification; you may not use this file except in
@@ -34,8 +34,8 @@ module Jamf
     #
     #
     #
-    # This class was automatically genereated from the api/schema
-    # URL path on a Jamf Pro server version 10.50.0-t1693149930
+    # 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.

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

@@ -1,4 +1,4 @@
-# Copyright 2023 Pixar
+# Copyright 2024 Pixar
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")
 #    with the following modification; you may not use this file except in
@@ -34,8 +34,8 @@ module Jamf
     #
     #
     #
-    # This class was automatically genereated from the api/schema
-    # URL path on a Jamf Pro server version 10.50.0-t1693149930
+    # 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.