Added the UriParameters field to the `DeviceAuthenticationPolicyTot…

…p` data model (#384) * Added the `UriParameters` field to the `DeviceAuthenticationPolicyTotp` data model * changelog
patrickcping · Nov 8, 2024 · 4902ee4 · 4902ee4
1 parent a94469c
commit 4902ee4
Show file tree

Hide file tree

Showing 9 changed files with 98 additions and 5 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -11,8 +11,9 @@
 * `github.com/patrickcping/pingone-go-sdk-v2/management` : [v0.44.0](./management/CHANGELOG.md)
     * **Note** Upgraded go version to 1.22 to align with the go [release policy](https://go.dev/doc/devel/release#policy). [#376](https://github.com/patrickcping/pingone-go-sdk-v2/pull/376)
     * **Feature** Added support for the Administrator Security API. [#381](https://github.com/patrickcping/pingone-go-sdk-v2/pull/381)
-* `github.com/patrickcping/pingone-go-sdk-v2/mfa` : [v0.20.1](./mfa/CHANGELOG.md)
+* `github.com/patrickcping/pingone-go-sdk-v2/mfa` : [v0.21.0](./mfa/CHANGELOG.md)
     * **Note** Upgraded go version to 1.22 to align with the go [release policy](https://go.dev/doc/devel/release#policy). [#376](https://github.com/patrickcping/pingone-go-sdk-v2/pull/376)
+    * **Enhancement** Added the `UriParameters` field to the `DeviceAuthenticationPolicyTotp` data model. [#384](https://github.com/patrickcping/pingone-go-sdk-v2/pull/384)
 * `github.com/patrickcping/pingone-go-sdk-v2/risk` : [v0.17.0](./risk/CHANGELOG.md)
     * **Note** Upgraded go version to 1.22 to align with the go [release policy](https://go.dev/doc/devel/release#policy). [#376](https://github.com/patrickcping/pingone-go-sdk-v2/pull/376)
     * **Enhancement** Added the `ShouldValidatePayloadSignature` field to the `RiskPredictorDevice` model. [#380](https://github.com/patrickcping/pingone-go-sdk-v2/pull/380)

diff --git a/mfa/.version b/mfa/.version
@@ -1 +1 @@
-0.20.1
+0.21.0
diff --git a/mfa/CHANGELOG.md b/mfa/CHANGELOG.md
@@ -1,6 +1,7 @@
-# v0.20.1 (Unreleased)
+# v0.21.0 (Unreleased)
 
 * **Note** Upgraded go version to 1.22 to align with the go [release policy](https://go.dev/doc/devel/release#policy). [#376](https://github.com/patrickcping/pingone-go-sdk-v2/pull/376)
+* **Enhancement** Added the `UriParameters` field to the `DeviceAuthenticationPolicyTotp` data model. [#384](https://github.com/patrickcping/pingone-go-sdk-v2/pull/384)
 
 # v0.20.0 (2024-07-04)
 

diff --git a/mfa/README.md b/mfa/README.md
@@ -6,7 +6,7 @@ The PingOne Platform API covering the PingOne MFA service
 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.20.1
+- Package version: 0.21.0
 - Build package: org.openapitools.codegen.languages.GoClientCodegen
 
 ## Installation

diff --git a/mfa/api/openapi.yaml b/mfa/api/openapi.yaml
@@ -3139,6 +3139,8 @@ components:
           promptForNicknameOnPairing: true
         totp:
           pairingDisabled: true
+          uriParameters:
+            key: uriParameters
           otp:
             failure:
               count: 6
@@ -3511,6 +3513,8 @@ components:
               promptForNicknameOnPairing: true
             totp:
               pairingDisabled: true
+              uriParameters:
+                key: uriParameters
               otp:
                 failure:
                   count: 6
@@ -3652,6 +3656,8 @@ components:
               promptForNicknameOnPairing: true
             totp:
               pairingDisabled: true
+              uriParameters:
+                key: uriParameters
               otp:
                 failure:
                   count: 6
@@ -4857,6 +4863,8 @@ components:
       description: TOTP device authentication policy settings.
       example:
         pairingDisabled: true
+        uriParameters:
+          key: uriParameters
         otp:
           failure:
             count: 6
@@ -4882,6 +4890,17 @@ components:
           description: Set to `true` if you want to allow users to provide nicknames
             for devices during pairing.
           type: boolean
+        uriParameters:
+          additionalProperties:
+            type: string
+          description: "Object that you can use to provide key:value pairs for `otpauth`\
+            \ URI parameters. For example, if you provide a value for the `issuer`\
+            \ parameter, then authenticators that support that parameter will display\
+            \ the text you specify together with the OTP (in addition to the username).\
+            \ This can help users recognize which application the OTP is for. If you\
+            \ intend on using the same MFA policy for multiple applications, choose\
+            \ a name that reflects the group of applications."
+          type: object
       required:
       - enabled
       - otp
@@ -5042,6 +5061,8 @@ components:
             promptForNicknameOnPairing: true
           totp:
             pairingDisabled: true
+            uriParameters:
+              key: uriParameters
             otp:
               failure:
                 count: 6
@@ -5183,6 +5204,8 @@ components:
             promptForNicknameOnPairing: true
           totp:
             pairingDisabled: true
+            uriParameters:
+              key: uriParameters
             otp:
               failure:
                 count: 6

diff --git a/mfa/configuration.go b/mfa/configuration.go
diff --git a/mfa/docs/DeviceAuthenticationPolicyTotp.md b/mfa/docs/DeviceAuthenticationPolicyTotp.md
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
 **PairingDisabled** | Pointer to **bool** | You can set &#x60;pairingDisabled&#x60; to true to prevent users from pairing new devices with the relevant method. You can use this option if you want to phase out an existing authentication method but want to allow users to continue using the method for authentication for existing devices. | [optional] 
 **Otp** | [**DeviceAuthenticationPolicyTotpOtp**](DeviceAuthenticationPolicyTotpOtp.md) |  | 
 **PromptForNicknameOnPairing** | Pointer to **bool** | Set to &#x60;true&#x60; if you want to allow users to provide nicknames for devices during pairing. | [optional] 
+**UriParameters** | Pointer to **map[string]string** | Object that you can use to provide key:value pairs for &#x60;otpauth&#x60; URI parameters. For example, if you provide a value for the &#x60;issuer&#x60; parameter, then authenticators that support that parameter will display the text you specify together with the OTP (in addition to the username). This can help users recognize which application the OTP is for. If you intend on using the same MFA policy for multiple applications, choose a name that reflects the group of applications. | [optional] 
 
 ## Methods
 
@@ -118,6 +119,31 @@ SetPromptForNicknameOnPairing sets PromptForNicknameOnPairing field to given val
 
 HasPromptForNicknameOnPairing returns a boolean if a field has been set.
 
+### GetUriParameters
+
+`func (o *DeviceAuthenticationPolicyTotp) GetUriParameters() map[string]string`
+
+GetUriParameters returns the UriParameters field if non-nil, zero value otherwise.
+
+### GetUriParametersOk
+
+`func (o *DeviceAuthenticationPolicyTotp) GetUriParametersOk() (*map[string]string, bool)`
+
+GetUriParametersOk returns a tuple with the UriParameters field if it's non-nil, zero value otherwise
+and a boolean to check if the value has been set.
+
+### SetUriParameters
+
+`func (o *DeviceAuthenticationPolicyTotp) SetUriParameters(v map[string]string)`
+
+SetUriParameters sets UriParameters field to given value.
+
+### HasUriParameters
+
+`func (o *DeviceAuthenticationPolicyTotp) HasUriParameters() bool`
+
+HasUriParameters returns a boolean if a field has been set.
+
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/mfa/generate/pingone-mfa.yml b/mfa/generate/pingone-mfa.yml
@@ -362,6 +362,11 @@ components:
             promptForNicknameOnPairing:
               type: boolean
               description: Set to `true` if you want to allow users to provide nicknames for devices during pairing.
+            uriParameters:
+              type: object
+              additionalProperties:
+                type: string
+              description: Object that you can use to provide key:value pairs for `otpauth` URI parameters. For example, if you provide a value for the `issuer` parameter, then authenticators that support that parameter will display the text you specify together with the OTP (in addition to the username). This can help users recognize which application the OTP is for. If you intend on using the same MFA policy for multiple applications, choose a name that reflects the group of applications.
           required:
             - enabled
             - otp

diff --git a/mfa/model_device_authentication_policy_totp.go b/mfa/model_device_authentication_policy_totp.go