Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added the UriParameters field to the DeviceAuthenticationPolicyTotp data model #384

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion mfa/.version
Original file line number Diff line number Diff line change
@@ -1 +1 @@
0.20.1
0.21.0
3 changes: 2 additions & 1 deletion mfa/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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)

Expand Down
2 changes: 1 addition & 1 deletion mfa/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
23 changes: 23 additions & 0 deletions mfa/api/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3139,6 +3139,8 @@ components:
promptForNicknameOnPairing: true
totp:
pairingDisabled: true
uriParameters:
key: uriParameters
otp:
failure:
count: 6
Expand Down Expand Up @@ -3511,6 +3513,8 @@ components:
promptForNicknameOnPairing: true
totp:
pairingDisabled: true
uriParameters:
key: uriParameters
otp:
failure:
count: 6
Expand Down Expand Up @@ -3652,6 +3656,8 @@ components:
promptForNicknameOnPairing: true
totp:
pairingDisabled: true
uriParameters:
key: uriParameters
otp:
failure:
count: 6
Expand Down Expand Up @@ -4857,6 +4863,8 @@ components:
description: TOTP device authentication policy settings.
example:
pairingDisabled: true
uriParameters:
key: uriParameters
otp:
failure:
count: 6
Expand All @@ -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
Expand Down Expand Up @@ -5042,6 +5061,8 @@ components:
promptForNicknameOnPairing: true
totp:
pairingDisabled: true
uriParameters:
key: uriParameters
otp:
failure:
count: 6
Expand Down Expand Up @@ -5183,6 +5204,8 @@ components:
promptForNicknameOnPairing: true
totp:
pairingDisabled: true
uriParameters:
key: uriParameters
otp:
failure:
count: 6
Expand Down
2 changes: 1 addition & 1 deletion mfa/configuration.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

26 changes: 26 additions & 0 deletions mfa/docs/DeviceAuthenticationPolicyTotp.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Name | Type | Description | Notes
**PairingDisabled** | Pointer to **bool** | You can set `pairingDisabled` 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 `true` 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 `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. | [optional]

## Methods

Expand Down Expand Up @@ -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)

Expand Down
5 changes: 5 additions & 0 deletions mfa/generate/pingone-mfa.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
37 changes: 37 additions & 0 deletions mfa/model_device_authentication_policy_totp.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading