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

MFASettings model update #50

Merged
merged 3 commits into from
Sep 15, 2022
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
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@
* **Enhancement** - Changed model dereferencing strategy for the `CreateMFAPushCredentialRequest` model [#48](https://github.com/patrickcping/pingone-go-sdk-v2/pull/48)
* **Enhancement** - Changed model dereferencing strategy for the `EntityArrayEmbeddedPushCredentialsInner` model [#48](https://github.com/patrickcping/pingone-go-sdk-v2/pull/48)
* **Enhancement** - Changed model dereferencing strategy for the `UpdateMFAPushCredentialRequest` model [#48](https://github.com/patrickcping/pingone-go-sdk-v2/pull/48)
* **Enhancement** - Add `environment` attribute block to `MFASettings` model [#50](https://github.com/patrickcping/pingone-go-sdk-v2/pull/50)
* **Enhancement** - Add required attributes to the `MFASettings` model [#50](https://github.com/patrickcping/pingone-go-sdk-v2/pull/50)

# Release (2022-09-11)

Expand Down
2 changes: 2 additions & 0 deletions mfa/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
* **Enhancement** - Changed model dereferencing strategy for the `CreateMFAPushCredentialRequest` model [#48](https://github.com/patrickcping/pingone-go-sdk-v2/pull/48)
* **Enhancement** - Changed model dereferencing strategy for the `EntityArrayEmbeddedPushCredentialsInner` model [#48](https://github.com/patrickcping/pingone-go-sdk-v2/pull/48)
* **Enhancement** - Changed model dereferencing strategy for the `UpdateMFAPushCredentialRequest` model [#48](https://github.com/patrickcping/pingone-go-sdk-v2/pull/48)
* **Enhancement** - Add `environment` attribute block to `MFASettings` model [#50](https://github.com/patrickcping/pingone-go-sdk-v2/pull/50)
* **Enhancement** - Add required attributes to the `MFASettings` model [#50](https://github.com/patrickcping/pingone-go-sdk-v2/pull/50)

# v0.5.0 (2022-09-11)

Expand Down
16 changes: 16 additions & 0 deletions mfa/api/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2252,6 +2252,8 @@ components:
$ref: '#/components/schemas/MFAPushCredential'
MFASettings:
example:
environment:
id: id
lockout:
durationSeconds: 6
failureCount: 0
Expand All @@ -2262,6 +2264,8 @@ components:
deviceSelection: null
updatedAt: 2000-01-23T04:56:07.000+00:00
properties:
environment:
$ref: '#/components/schemas/ObjectEnvironment'
authentication:
$ref: '#/components/schemas/MFASettings_authentication'
lockout:
Expand All @@ -2273,6 +2277,10 @@ components:
format: date-time
readOnly: true
type: string
required:
- authentication
- lockout
- pairing
type: object
ObjectEnvironment:
example:
Expand Down Expand Up @@ -2767,6 +2775,8 @@ components:
properties:
deviceSelection:
$ref: '#/components/schemas/EnumMFASettingsDeviceSelection'
required:
- deviceSelection
type: object
MFASettings_lockout:
description: An object that contains lockout settings.
Expand All @@ -2782,6 +2792,9 @@ components:
description: An integer that defines the number of seconds to keep the account
in a locked state.
type: integer
required:
- durationSeconds
- failureCount
type: object
MFASettings_pairing:
description: An object that contains pairing settings.
Expand All @@ -2797,6 +2810,9 @@ components:
type: integer
pairingKeyFormat:
$ref: '#/components/schemas/EnumMFASettingsPairingKeyFormat'
required:
- maxAllowedDevices
- pairingKeyFormat
type: object
P1Error_details_inner_innerError:
description: Additional details to help the client developer resolve the fault
Expand Down
49 changes: 30 additions & 19 deletions mfa/docs/MFASettings.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,17 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Authentication** | Pointer to [**MFASettingsAuthentication**](MFASettingsAuthentication.md) | | [optional]
**Lockout** | Pointer to [**MFASettingsLockout**](MFASettingsLockout.md) | | [optional]
**Pairing** | Pointer to [**MFASettingsPairing**](MFASettingsPairing.md) | | [optional]
**Environment** | Pointer to [**ObjectEnvironment**](ObjectEnvironment.md) | | [optional]
**Authentication** | [**MFASettingsAuthentication**](MFASettingsAuthentication.md) | |
**Lockout** | [**MFASettingsLockout**](MFASettingsLockout.md) | |
**Pairing** | [**MFASettingsPairing**](MFASettingsPairing.md) | |
**UpdatedAt** | Pointer to **time.Time** | The time the resource was last updated. | [optional] [readonly]

## Methods

### NewMFASettings

`func NewMFASettings() *MFASettings`
`func NewMFASettings(authentication MFASettingsAuthentication, lockout MFASettingsLockout, pairing MFASettingsPairing, ) *MFASettings`

NewMFASettings instantiates a new MFASettings object
This constructor will assign default values to properties that have it defined,
Expand All @@ -28,6 +29,31 @@ NewMFASettingsWithDefaults instantiates a new MFASettings 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

### GetEnvironment

`func (o *MFASettings) GetEnvironment() ObjectEnvironment`

GetEnvironment returns the Environment field if non-nil, zero value otherwise.

### GetEnvironmentOk

`func (o *MFASettings) GetEnvironmentOk() (*ObjectEnvironment, bool)`

GetEnvironmentOk returns a tuple with the Environment field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.

### SetEnvironment

`func (o *MFASettings) SetEnvironment(v ObjectEnvironment)`

SetEnvironment sets Environment field to given value.

### HasEnvironment

`func (o *MFASettings) HasEnvironment() bool`

HasEnvironment returns a boolean if a field has been set.

### GetAuthentication

`func (o *MFASettings) GetAuthentication() MFASettingsAuthentication`
Expand All @@ -47,11 +73,6 @@ and a boolean to check if the value has been set.

SetAuthentication sets Authentication field to given value.

### HasAuthentication

`func (o *MFASettings) HasAuthentication() bool`

HasAuthentication returns a boolean if a field has been set.

### GetLockout

Expand All @@ -72,11 +93,6 @@ and a boolean to check if the value has been set.

SetLockout sets Lockout field to given value.

### HasLockout

`func (o *MFASettings) HasLockout() bool`

HasLockout returns a boolean if a field has been set.

### GetPairing

Expand All @@ -97,11 +113,6 @@ and a boolean to check if the value has been set.

SetPairing sets Pairing field to given value.

### HasPairing

`func (o *MFASettings) HasPairing() bool`

HasPairing returns a boolean if a field has been set.

### GetUpdatedAt

Expand Down
2 changes: 1 addition & 1 deletion mfa/docs/MFASettingsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ import (

func main() {
environmentID := "environmentID_example" // string |
mFASettings := *openapiclient.NewMFASettings() // MFASettings | (optional)
mFASettings := *openapiclient.NewMFASettings(*openapiclient.NewMFASettingsAuthentication(openapiclient.EnumMFASettingsDeviceSelection("DEFAULT_TO_FIRST")), *openapiclient.NewMFASettingsLockout(int32(123), int32(123)), *openapiclient.NewMFASettingsPairing(int32(123), openapiclient.EnumMFASettingsPairingKeyFormat("NUMERIC"))) // MFASettings | (optional)

configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
Expand Down
9 changes: 2 additions & 7 deletions mfa/docs/MFASettingsAuthentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**DeviceSelection** | Pointer to [**EnumMFASettingsDeviceSelection**](EnumMFASettingsDeviceSelection.md) | | [optional]
**DeviceSelection** | [**EnumMFASettingsDeviceSelection**](EnumMFASettingsDeviceSelection.md) | |

## Methods

### NewMFASettingsAuthentication

`func NewMFASettingsAuthentication() *MFASettingsAuthentication`
`func NewMFASettingsAuthentication(deviceSelection EnumMFASettingsDeviceSelection, ) *MFASettingsAuthentication`

NewMFASettingsAuthentication instantiates a new MFASettingsAuthentication object
This constructor will assign default values to properties that have it defined,
Expand Down Expand Up @@ -44,11 +44,6 @@ and a boolean to check if the value has been set.

SetDeviceSelection sets DeviceSelection field to given value.

### HasDeviceSelection

`func (o *MFASettingsAuthentication) HasDeviceSelection() bool`

HasDeviceSelection 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
16 changes: 3 additions & 13 deletions mfa/docs/MFASettingsLockout.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**FailureCount** | Pointer to **int32** | An integer that defines the maximum number of incorrect authentication attempts before the account is locked. | [optional]
**DurationSeconds** | Pointer to **int32** | An integer that defines the number of seconds to keep the account in a locked state. | [optional]
**FailureCount** | **int32** | An integer that defines the maximum number of incorrect authentication attempts before the account is locked. |
**DurationSeconds** | **int32** | An integer that defines the number of seconds to keep the account in a locked state. |

## Methods

### NewMFASettingsLockout

`func NewMFASettingsLockout() *MFASettingsLockout`
`func NewMFASettingsLockout(failureCount int32, durationSeconds int32, ) *MFASettingsLockout`

NewMFASettingsLockout instantiates a new MFASettingsLockout object
This constructor will assign default values to properties that have it defined,
Expand Down Expand Up @@ -45,11 +45,6 @@ and a boolean to check if the value has been set.

SetFailureCount sets FailureCount field to given value.

### HasFailureCount

`func (o *MFASettingsLockout) HasFailureCount() bool`

HasFailureCount returns a boolean if a field has been set.

### GetDurationSeconds

Expand All @@ -70,11 +65,6 @@ and a boolean to check if the value has been set.

SetDurationSeconds sets DurationSeconds field to given value.

### HasDurationSeconds

`func (o *MFASettingsLockout) HasDurationSeconds() bool`

HasDurationSeconds 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
16 changes: 3 additions & 13 deletions mfa/docs/MFASettingsPairing.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**MaxAllowedDevices** | Pointer to **int32** | An integer that defines the maximum number of MFA devices each user can have. This can be any number up to 15. The default value is 5. | [optional] [default to 5]
**PairingKeyFormat** | Pointer to [**EnumMFASettingsPairingKeyFormat**](EnumMFASettingsPairingKeyFormat.md) | | [optional]
**MaxAllowedDevices** | **int32** | An integer that defines the maximum number of MFA devices each user can have. This can be any number up to 15. The default value is 5. | [default to 5]
**PairingKeyFormat** | [**EnumMFASettingsPairingKeyFormat**](EnumMFASettingsPairingKeyFormat.md) | |

## Methods

### NewMFASettingsPairing

`func NewMFASettingsPairing() *MFASettingsPairing`
`func NewMFASettingsPairing(maxAllowedDevices int32, pairingKeyFormat EnumMFASettingsPairingKeyFormat, ) *MFASettingsPairing`

NewMFASettingsPairing instantiates a new MFASettingsPairing object
This constructor will assign default values to properties that have it defined,
Expand Down Expand Up @@ -45,11 +45,6 @@ and a boolean to check if the value has been set.

SetMaxAllowedDevices sets MaxAllowedDevices field to given value.

### HasMaxAllowedDevices

`func (o *MFASettingsPairing) HasMaxAllowedDevices() bool`

HasMaxAllowedDevices returns a boolean if a field has been set.

### GetPairingKeyFormat

Expand All @@ -70,11 +65,6 @@ and a boolean to check if the value has been set.

SetPairingKeyFormat sets PairingKeyFormat field to given value.

### HasPairingKeyFormat

`func (o *MFASettingsPairing) HasPairingKeyFormat() bool`

HasPairingKeyFormat 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
Loading