Add SpEncryption to the ApplicationSAML and associated models (#348)

* Add `SpEncryption` to the `ApplicationSAML` and associated models

* update changelog

* updates on doc preview

* update descriptions

* update field description

* version and changelog

* update changelog

CHANGELOG.md

@@ -1,5 +1,7 @@
 # Release (Unreleased)
 
+* `github.com/patrickcping/pingone-go-sdk-v2/management` : [v0.41.0](./management/CHANGELOG.md)
+    * **Enhancement** Added `SpEncryption` to the `ApplicationSAML` and associated models to control encryption of SAML application assertions. [#348](https://github.com/patrickcping/pingone-go-sdk-v2/pull/348)
 * `github.com/patrickcping/pingone-go-sdk-v2/risk` : [v0.15.1](./risk/CHANGELOG.md)
     * **Bug** Corrected `DomainWhiteList` field in the `RiskPredictorAdversaryInTheMiddle` model. [#361](https://github.com/patrickcping/pingone-go-sdk-v2/pull/361)
 

management/.openapi-generator/FILES

@@ -128,6 +128,8 @@ docs/ApplicationRoleAssignmentsApi.md
 docs/ApplicationSAML.md
 docs/ApplicationSAMLAllOfIdpSigning.md
 docs/ApplicationSAMLAllOfIdpSigningKey.md
+docs/ApplicationSAMLAllOfSpEncryption.md
+docs/ApplicationSAMLAllOfSpEncryptionCertificate.md
 docs/ApplicationSAMLAllOfSpVerification.md
 docs/ApplicationSAMLAllOfSpVerificationCertificates.md
 docs/ApplicationSecret.md
@@ -213,6 +215,7 @@ docs/EnumBrandingThemeTemplate.md
 docs/EnumCSRExportHeader.md
 docs/EnumCSRResponseImportHeader.md
 docs/EnumCertificateKeyAlgorithm.md
+docs/EnumCertificateKeyEncryptionAlgorithm.md
 docs/EnumCertificateKeySignagureAlgorithm.md
 docs/EnumCertificateKeyStatus.md
 docs/EnumCertificateKeyUsageType.md
@@ -699,6 +702,8 @@ model_application_resource_grant_scopes_inner.go
 model_application_saml.go
 model_application_saml_all_of_idp_signing.go
 model_application_saml_all_of_idp_signing_key.go
+model_application_saml_all_of_sp_encryption.go
+model_application_saml_all_of_sp_encryption_certificate.go
 model_application_saml_all_of_sp_verification.go
 model_application_saml_all_of_sp_verification_certificates.go
 model_application_secret.go
@@ -765,6 +770,7 @@ model_enum_branding_logo_type.go
 model_enum_branding_theme_background_type.go
 model_enum_branding_theme_template.go
 model_enum_certificate_key_algorithm.go
+model_enum_certificate_key_encryption_algorithm.go
 model_enum_certificate_key_signagure_algorithm.go
 model_enum_certificate_key_status.go
 model_enum_certificate_key_usage_type.go

management/.version

@@ -1 +1 @@
-0.40.0
+0.41.0

management/CHANGELOG.md

@@ -1,3 +1,7 @@
+# v0.41.0 (Unreleased)
+
+* **Enhancement** Added `SpEncryption` to the `ApplicationSAML` and associated models to control encryption of SAML application assertions. [#348](https://github.com/patrickcping/pingone-go-sdk-v2/pull/348)
+
 # v0.40.0 (2024-06-07)
 
 * **Breaking Change** Removed the `FormSocialLoginButtonStyles` data model.  Use the `FormStyles` data model going forward. [#350](https://github.com/patrickcping/pingone-go-sdk-v2/pull/350)

management/README.md

@@ -6,7 +6,7 @@ The PingOne Platform API covering the base and SSO services (otherwise known as
 This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project.  By using the [OpenAPI-spec](https://www.openapis.org/) from a remote server, you can easily generate an API client.
 
 - API version: 2023-06-29
-- Package version: 0.40.0
+- Package version: 0.41.0
 - Build package: org.openapitools.codegen.languages.GoClientCodegen
 
 ## Installation
@@ -472,6 +472,8 @@ Class | Method | HTTP request | Description
  - [ApplicationSAML](docs/ApplicationSAML.md)
  - [ApplicationSAMLAllOfIdpSigning](docs/ApplicationSAMLAllOfIdpSigning.md)
  - [ApplicationSAMLAllOfIdpSigningKey](docs/ApplicationSAMLAllOfIdpSigningKey.md)
+ - [ApplicationSAMLAllOfSpEncryption](docs/ApplicationSAMLAllOfSpEncryption.md)
+ - [ApplicationSAMLAllOfSpEncryptionCertificate](docs/ApplicationSAMLAllOfSpEncryptionCertificate.md)
  - [ApplicationSAMLAllOfSpVerification](docs/ApplicationSAMLAllOfSpVerification.md)
  - [ApplicationSAMLAllOfSpVerificationCertificates](docs/ApplicationSAMLAllOfSpVerificationCertificates.md)
  - [ApplicationSecret](docs/ApplicationSecret.md)
@@ -546,6 +548,7 @@ Class | Method | HTTP request | Description
  - [EnumCSRExportHeader](docs/EnumCSRExportHeader.md)
  - [EnumCSRResponseImportHeader](docs/EnumCSRResponseImportHeader.md)
  - [EnumCertificateKeyAlgorithm](docs/EnumCertificateKeyAlgorithm.md)
+ - [EnumCertificateKeyEncryptionAlgorithm](docs/EnumCertificateKeyEncryptionAlgorithm.md)
  - [EnumCertificateKeySignagureAlgorithm](docs/EnumCertificateKeySignagureAlgorithm.md)
  - [EnumCertificateKeyStatus](docs/EnumCertificateKeyStatus.md)
  - [EnumCertificateKeyUsageType](docs/EnumCertificateKeyUsageType.md)

management/api/openapi.yaml

@@ -26497,6 +26497,13 @@ components:
       - EC
       - UNKNOWN
       type: string
+    EnumCertificateKeyEncryptionAlgorithm:
+      description: The algorithm to use when encrypting assertions.
+      enum:
+      - AES_128
+      - AES_256
+      - TRIPLEDES
+      type: string
     EnumCertificateKeySignagureAlgorithm:
       description: "Specifies the signature algorithm of the key. For RSA keys, options\
         \ are `SHA256withRSA`, `SHA384withRSA` and `SHA512withRSA`. For elliptical\
@@ -27904,6 +27911,8 @@ components:
               \ This setting is per application. The SLO logout is separate from the\
               \ user session logout that revokes all tokens."
             type: integer
+          spEncryption:
+            $ref: '#/components/schemas/ApplicationSAML_allOf_spEncryption'
           spEntityId:
             description: A string that specifies the service provider entity ID used
               to lookup the application. This is a required property and is unique
@@ -35932,6 +35941,31 @@ components:
       - key
       type: object
       example: null
+    ApplicationSAML_allOf_spEncryption_certificate:
+      description: Contains the ID of the encryption public certificate that has been
+        uploaded to PingOne.
+      properties:
+        id:
+          description: Specify the unique identifier of the encryption public certificate
+            that has been uploaded to PingOne.
+          type: string
+      required:
+      - id
+      type: object
+      example: null
+    ApplicationSAML_allOf_spEncryption:
+      description: Enables PingOne to encrypt SAML assertions to be sent to the application.
+        Assertions are not encrypted by default.
+      properties:
+        algorithm:
+          $ref: '#/components/schemas/EnumCertificateKeyEncryptionAlgorithm'
+        certificate:
+          $ref: '#/components/schemas/ApplicationSAML_allOf_spEncryption_certificate'
+      required:
+      - algorithm
+      - certificate
+      type: object
+      example: null
     ApplicationSAML_allOf_spVerification_certificates:
       properties:
         id:

management/docs/ApplicationSAML.md

@@ -32,6 +32,7 @@ Name | Type | Description | Notes
 **SloEndpoint** | Pointer to **string** | A string that specifies the logout endpoint URL. This is an optional property. However, if a sloEndpoint logout endpoint URL is not defined, logout actions result in an error. | [optional] 
 **SloResponseEndpoint** | Pointer to **string** | A string that specifies the endpoint URL to submit the logout response. If a value is not provided, the sloEndpoint property value is used to submit SLO response. | [optional] 
 **SloWindow** | Pointer to **int32** | Defines how long PingOne can exchange logout messages with the application, specifically a `LogoutRequest` from the application, since the initial request. PingOne can also send a `LogoutRequest` to the application when a single logout is initiated by the user from other session participants, such as an application or identity provider. This setting is per application. The SLO logout is separate from the user session logout that revokes all tokens. | [optional] 
+**SpEncryption** | Pointer to [**ApplicationSAMLAllOfSpEncryption**](ApplicationSAMLAllOfSpEncryption.md) |  | [optional] 
 **SpEntityId** | **string** | A string that specifies the service provider entity ID used to lookup the application. This is a required property and is unique within the environment. | 
 **SpVerification** | Pointer to [**ApplicationSAMLAllOfSpVerification**](ApplicationSAMLAllOfSpVerification.md) |  | [optional] 
 
@@ -724,6 +725,31 @@ SetSloWindow sets SloWindow field to given value.
 
 HasSloWindow returns a boolean if a field has been set.
 
+### GetSpEncryption
+
+`func (o *ApplicationSAML) GetSpEncryption() ApplicationSAMLAllOfSpEncryption`
+
+GetSpEncryption returns the SpEncryption field if non-nil, zero value otherwise.
+
+### GetSpEncryptionOk
+
+`func (o *ApplicationSAML) GetSpEncryptionOk() (*ApplicationSAMLAllOfSpEncryption, bool)`
+
+GetSpEncryptionOk returns a tuple with the SpEncryption field if it's non-nil, zero value otherwise
+and a boolean to check if the value has been set.
+
+### SetSpEncryption
+
+`func (o *ApplicationSAML) SetSpEncryption(v ApplicationSAMLAllOfSpEncryption)`
+
+SetSpEncryption sets SpEncryption field to given value.
+
+### HasSpEncryption
+
+`func (o *ApplicationSAML) HasSpEncryption() bool`
+
+HasSpEncryption returns a boolean if a field has been set.
+
 ### GetSpEntityId
 
 `func (o *ApplicationSAML) GetSpEntityId() string`

management/docs/ApplicationSAMLAllOfSpEncryption.md

@@ -0,0 +1,72 @@
+# ApplicationSAMLAllOfSpEncryption
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Algorithm** | [**EnumCertificateKeyEncryptionAlgorithm**](EnumCertificateKeyEncryptionAlgorithm.md) |  | 
+**Certificate** | [**ApplicationSAMLAllOfSpEncryptionCertificate**](ApplicationSAMLAllOfSpEncryptionCertificate.md) |  | 
+
+## Methods
+
+### NewApplicationSAMLAllOfSpEncryption
+
+`func NewApplicationSAMLAllOfSpEncryption(algorithm EnumCertificateKeyEncryptionAlgorithm, certificate ApplicationSAMLAllOfSpEncryptionCertificate, ) *ApplicationSAMLAllOfSpEncryption`
+
+NewApplicationSAMLAllOfSpEncryption instantiates a new ApplicationSAMLAllOfSpEncryption object
+This constructor will assign default values to properties that have it defined,
+and makes sure properties required by API are set, but the set of arguments
+will change when the set of required properties is changed
+
+### NewApplicationSAMLAllOfSpEncryptionWithDefaults
+
+`func NewApplicationSAMLAllOfSpEncryptionWithDefaults() *ApplicationSAMLAllOfSpEncryption`
+
+NewApplicationSAMLAllOfSpEncryptionWithDefaults instantiates a new ApplicationSAMLAllOfSpEncryption object
+This constructor will only assign default values to properties that have it defined,
+but it doesn't guarantee that properties required by API are set
+
+### GetAlgorithm
+
+`func (o *ApplicationSAMLAllOfSpEncryption) GetAlgorithm() EnumCertificateKeyEncryptionAlgorithm`
+
+GetAlgorithm returns the Algorithm field if non-nil, zero value otherwise.
+
+### GetAlgorithmOk
+
+`func (o *ApplicationSAMLAllOfSpEncryption) GetAlgorithmOk() (*EnumCertificateKeyEncryptionAlgorithm, bool)`
+
+GetAlgorithmOk returns a tuple with the Algorithm field if it's non-nil, zero value otherwise
+and a boolean to check if the value has been set.
+
+### SetAlgorithm
+
+`func (o *ApplicationSAMLAllOfSpEncryption) SetAlgorithm(v EnumCertificateKeyEncryptionAlgorithm)`
+
+SetAlgorithm sets Algorithm field to given value.
+
+
+### GetCertificate
+
+`func (o *ApplicationSAMLAllOfSpEncryption) GetCertificate() ApplicationSAMLAllOfSpEncryptionCertificate`
+
+GetCertificate returns the Certificate field if non-nil, zero value otherwise.
+
+### GetCertificateOk
+
+`func (o *ApplicationSAMLAllOfSpEncryption) GetCertificateOk() (*ApplicationSAMLAllOfSpEncryptionCertificate, bool)`
+
+GetCertificateOk returns a tuple with the Certificate field if it's non-nil, zero value otherwise
+and a boolean to check if the value has been set.
+
+### SetCertificate
+
+`func (o *ApplicationSAMLAllOfSpEncryption) SetCertificate(v ApplicationSAMLAllOfSpEncryptionCertificate)`
+
+SetCertificate sets Certificate field to given value.
+
+
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

management/docs/ApplicationSAMLAllOfSpEncryptionCertificate.md

@@ -0,0 +1,51 @@
+# ApplicationSAMLAllOfSpEncryptionCertificate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Id** | **string** | Specify the unique identifier of the encryption public certificate that has been uploaded to PingOne. | 
+
+## Methods
+
+### NewApplicationSAMLAllOfSpEncryptionCertificate
+
+`func NewApplicationSAMLAllOfSpEncryptionCertificate(id string, ) *ApplicationSAMLAllOfSpEncryptionCertificate`
+
+NewApplicationSAMLAllOfSpEncryptionCertificate instantiates a new ApplicationSAMLAllOfSpEncryptionCertificate object
+This constructor will assign default values to properties that have it defined,
+and makes sure properties required by API are set, but the set of arguments
+will change when the set of required properties is changed
+
+### NewApplicationSAMLAllOfSpEncryptionCertificateWithDefaults
+
+`func NewApplicationSAMLAllOfSpEncryptionCertificateWithDefaults() *ApplicationSAMLAllOfSpEncryptionCertificate`
+
+NewApplicationSAMLAllOfSpEncryptionCertificateWithDefaults instantiates a new ApplicationSAMLAllOfSpEncryptionCertificate object
+This constructor will only assign default values to properties that have it defined,
+but it doesn't guarantee that properties required by API are set
+
+### GetId
+
+`func (o *ApplicationSAMLAllOfSpEncryptionCertificate) GetId() string`
+
+GetId returns the Id field if non-nil, zero value otherwise.
+
+### GetIdOk
+
+`func (o *ApplicationSAMLAllOfSpEncryptionCertificate) GetIdOk() (*string, bool)`
+
+GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise
+and a boolean to check if the value has been set.
+
+### SetId
+
+`func (o *ApplicationSAMLAllOfSpEncryptionCertificate) SetId(v string)`
+
+SetId sets Id field to given value.
+
+
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

management/docs/CreateApplication201Response.md

@@ -32,6 +32,7 @@ Name | Type | Description | Notes
 **SloEndpoint** | Pointer to **string** | The single logout endpoint URL. | [optional] 
 **SloResponseEndpoint** | Pointer to **string** | A string that specifies the endpoint URL to submit the logout response. If a value is not provided, the sloEndpoint property value is used to submit SLO response. | [optional] 
 **SloWindow** | Pointer to **int32** | Defines how long PingOne can exchange logout messages with the application, specifically a `LogoutRequest` from the application, since the initial request. PingOne can also send a `LogoutRequest` to the application when a single logout is initiated by the user from other session participants, such as an application or identity provider. This setting is per application. The SLO logout is separate from the user session logout that revokes all tokens. | [optional] 
+**SpEncryption** | Pointer to [**ApplicationSAMLAllOfSpEncryption**](ApplicationSAMLAllOfSpEncryption.md) |  | [optional] 
 **SpEntityId** | **string** | A string that specifies the service provider entity ID used to lookup the application. This is a required property and is unique within the environment. | 
 **SpVerification** | Pointer to [**ApplicationSAMLAllOfSpVerification**](ApplicationSAMLAllOfSpVerification.md) |  | [optional] 
 **AdditionalRefreshTokenReplayProtectionEnabled** | Pointer to **bool** | When set to `true` (the default), if you attempt to reuse the refresh token, the authorization server immediately revokes the reused refresh token, as well as all descendant tokens. Setting this to null equates to a `false` setting. | [optional] [default to true]
@@ -747,6 +748,31 @@ SetSloWindow sets SloWindow field to given value.
 
 HasSloWindow returns a boolean if a field has been set.
 
+### GetSpEncryption
+
+`func (o *CreateApplication201Response) GetSpEncryption() ApplicationSAMLAllOfSpEncryption`
+
+GetSpEncryption returns the SpEncryption field if non-nil, zero value otherwise.
+
+### GetSpEncryptionOk
+
+`func (o *CreateApplication201Response) GetSpEncryptionOk() (*ApplicationSAMLAllOfSpEncryption, bool)`
+
+GetSpEncryptionOk returns a tuple with the SpEncryption field if it's non-nil, zero value otherwise
+and a boolean to check if the value has been set.
+
+### SetSpEncryption
+
+`func (o *CreateApplication201Response) SetSpEncryption(v ApplicationSAMLAllOfSpEncryption)`
+
+SetSpEncryption sets SpEncryption field to given value.
+
+### HasSpEncryption
+
+`func (o *CreateApplication201Response) HasSpEncryption() bool`
+
+HasSpEncryption returns a boolean if a field has been set.
+
 ### GetSpEntityId
 
 `func (o *CreateApplication201Response) GetSpEntityId() string`

management/docs/CreateApplicationRequest.md

@@ -32,6 +32,7 @@ Name | Type | Description | Notes
 **SloEndpoint** | Pointer to **string** | The single logout endpoint URL. | [optional] 
 **SloResponseEndpoint** | Pointer to **string** | A string that specifies the endpoint URL to submit the logout response. If a value is not provided, the sloEndpoint property value is used to submit SLO response. | [optional] 
 **SloWindow** | Pointer to **int32** | Defines how long PingOne can exchange logout messages with the application, specifically a `LogoutRequest` from the application, since the initial request. PingOne can also send a `LogoutRequest` to the application when a single logout is initiated by the user from other session participants, such as an application or identity provider. This setting is per application. The SLO logout is separate from the user session logout that revokes all tokens. | [optional] 
+**SpEncryption** | Pointer to [**ApplicationSAMLAllOfSpEncryption**](ApplicationSAMLAllOfSpEncryption.md) |  | [optional] 
 **SpEntityId** | **string** | A string that specifies the service provider entity ID used to lookup the application. This is a required property and is unique within the environment. | 
 **SpVerification** | Pointer to [**ApplicationSAMLAllOfSpVerification**](ApplicationSAMLAllOfSpVerification.md) |  | [optional] 
 **AdditionalRefreshTokenReplayProtectionEnabled** | Pointer to **bool** | When set to `true` (the default), if you attempt to reuse the refresh token, the authorization server immediately revokes the reused refresh token, as well as all descendant tokens. Setting this to null equates to a `false` setting. | [optional] [default to true]
@@ -747,6 +748,31 @@ SetSloWindow sets SloWindow field to given value.
 
 HasSloWindow returns a boolean if a field has been set.
 
+### GetSpEncryption
+
+`func (o *CreateApplicationRequest) GetSpEncryption() ApplicationSAMLAllOfSpEncryption`
+
+GetSpEncryption returns the SpEncryption field if non-nil, zero value otherwise.
+
+### GetSpEncryptionOk
+
+`func (o *CreateApplicationRequest) GetSpEncryptionOk() (*ApplicationSAMLAllOfSpEncryption, bool)`
+
+GetSpEncryptionOk returns a tuple with the SpEncryption field if it's non-nil, zero value otherwise
+and a boolean to check if the value has been set.
+
+### SetSpEncryption
+
+`func (o *CreateApplicationRequest) SetSpEncryption(v ApplicationSAMLAllOfSpEncryption)`
+
+SetSpEncryption sets SpEncryption field to given value.
+
+### HasSpEncryption
+
+`func (o *CreateApplicationRequest) HasSpEncryption() bool`
+
+HasSpEncryption returns a boolean if a field has been set.
+
 ### GetSpEntityId
 
 `func (o *CreateApplicationRequest) GetSpEntityId() string`