account_recovery_setting.go

// Copyright (c) 2016, 2018, 2024, Oracle and/or its affiliates.  All rights reserved.
// This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
// Code generated. DO NOT EDIT.

// Identity Domains API
//
// Use the Identity Domains API to manage resources within an identity domain, for example, users, dynamic resource groups, groups, and identity providers. For information about managing resources within identity domains, see Identity and Access Management (with identity domains) (https://docs.oracle.com/iaas/Content/Identity/home.htm). This REST API is SCIM compliant.
// Use the table of contents and search tool to explore the Identity Domains API.
//

package identitydomains

import (
	"fmt"
	"github.com/oracle/oci-go-sdk/v65/common"
	"strings"
)

// AccountRecoverySetting Account Recovery Settings
type AccountRecoverySetting struct {

	// REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \"enterprise\" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior.
	// **SCIM++ Properties:**
	//  - caseExact: false
	//  - idcsSearchable: false
	//  - multiValued: true
	//  - mutability: readWrite
	//  - required: true
	//  - returned: default
	//  - type: string
	//  - uniqueness: none
	Schemas []string `mandatory:"true" json:"schemas"`

	// The account recovery factor used (for example, email, mobile number (SMS), security questions, mobile application push or TOTP) to verify the identity of the user and reset the user's password.
	// **SCIM++ Properties:**
	//  - caseExact: true
	//  - idcsSearchable: true
	//  - multiValued: true
	//  - mutability: readWrite
	//  - required: true
	//  - returned: default
	//  - type: string
	//  - uniqueness: none
	Factors []AccountRecoverySettingFactorsEnum `mandatory:"true" json:"factors"`

	// Indicates the maximum number of failed account recovery attempts allowed for the user.
	// **SCIM++ Properties:**
	//  - caseExact: false
	//  - multiValued: false
	//  - mutability: readWrite
	//  - required: true
	//  - returned: default
	//  - type: integer
	//  - uniqueness: none
	//  - idcsMinValue: 1
	//  - idcsMaxValue: 99
	MaxIncorrectAttempts *int `mandatory:"true" json:"maxIncorrectAttempts"`

	// Indicates how many minutes to disable account recovery for the user. The default value is 30 metric minutes.
	// **SCIM++ Properties:**
	//  - caseExact: false
	//  - multiValued: false
	//  - mutability: readWrite
	//  - required: true
	//  - returned: default
	//  - type: integer
	//  - uniqueness: none
	//  - idcsMinValue: 5
	//  - idcsMaxValue: 9999
	LockoutDuration *int `mandatory:"true" json:"lockoutDuration"`

	// Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier.
	// **SCIM++ Properties:**
	//  - caseExact: false
	//  - idcsSearchable: true
	//  - multiValued: false
	//  - mutability: readOnly
	//  - required: false
	//  - returned: always
	//  - type: string
	//  - uniqueness: global
	Id *string `mandatory:"false" json:"id"`

	// Unique OCI identifier for the SCIM Resource.
	// **SCIM++ Properties:**
	//  - caseExact: true
	//  - idcsSearchable: true
	//  - multiValued: false
	//  - mutability: immutable
	//  - required: false
	//  - returned: default
	//  - type: string
	//  - uniqueness: global
	Ocid *string `mandatory:"false" json:"ocid"`

	Meta *Meta `mandatory:"false" json:"meta"`

	IdcsCreatedBy *IdcsCreatedBy `mandatory:"false" json:"idcsCreatedBy"`

	IdcsLastModifiedBy *IdcsLastModifiedBy `mandatory:"false" json:"idcsLastModifiedBy"`

	// Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.
	// **SCIM++ Properties:**
	//  - idcsSearchable: false
	//  - multiValued: true
	//  - mutability: readOnly
	//  - required: false
	//  - returned: request
	//  - type: string
	//  - uniqueness: none
	IdcsPreventedOperations []IdcsPreventedOperationsEnum `mandatory:"false" json:"idcsPreventedOperations,omitempty"`

	// A list of tags on this resource.
	// **SCIM++ Properties:**
	//  - idcsCompositeKey: [key, value]
	//  - idcsSearchable: true
	//  - multiValued: true
	//  - mutability: readWrite
	//  - required: false
	//  - returned: request
	//  - type: complex
	//  - uniqueness: none
	Tags []Tags `mandatory:"false" json:"tags"`

	// A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long.
	// **SCIM++ Properties:**
	//  - caseExact: false
	//  - idcsSearchable: true
	//  - multiValued: false
	//  - mutability: readOnly
	//  - required: false
	//  - returned: default
	//  - type: boolean
	//  - uniqueness: none
	DeleteInProgress *bool `mandatory:"false" json:"deleteInProgress"`

	// The release number when the resource was upgraded.
	// **SCIM++ Properties:**
	//  - caseExact: false
	//  - idcsSearchable: false
	//  - multiValued: false
	//  - mutability: readOnly
	//  - required: false
	//  - returned: request
	//  - type: string
	//  - uniqueness: none
	IdcsLastUpgradedInRelease *string `mandatory:"false" json:"idcsLastUpgradedInRelease"`

	// OCI Domain Id (ocid) in which the resource lives.
	// **SCIM++ Properties:**
	//  - caseExact: false
	//  - idcsSearchable: false
	//  - multiValued: false
	//  - mutability: readOnly
	//  - required: false
	//  - returned: default
	//  - type: string
	//  - uniqueness: none
	DomainOcid *string `mandatory:"false" json:"domainOcid"`

	// OCI Compartment Id (ocid) in which the resource lives.
	// **SCIM++ Properties:**
	//  - caseExact: false
	//  - idcsSearchable: false
	//  - multiValued: false
	//  - mutability: readOnly
	//  - required: false
	//  - returned: default
	//  - type: string
	//  - uniqueness: none
	CompartmentOcid *string `mandatory:"false" json:"compartmentOcid"`

	// OCI Tenant Id (ocid) in which the resource lives.
	// **SCIM++ Properties:**
	//  - caseExact: false
	//  - idcsSearchable: false
	//  - multiValued: false
	//  - mutability: readOnly
	//  - required: false
	//  - returned: default
	//  - type: string
	//  - uniqueness: none
	TenancyOcid *string `mandatory:"false" json:"tenancyOcid"`

	// An identifier for the Resource as defined by the Service Consumer. The externalId may simplify identification of the Resource between Service Consumer and Service Provider by allowing the Consumer to refer to the Resource with its own identifier, obviating the need to store a local mapping between the local identifier of the Resource and the identifier used by the Service Provider. Each Resource MAY include a non-empty externalId value. The value of the externalId attribute is always issued by the Service Consumer and can never be specified by the Service Provider. The Service Provider MUST always interpret the externalId as scoped to the Service Consumer's tenant.
	// **SCIM++ Properties:**
	//  - caseExact: false
	//  - multiValued: false
	//  - mutability: readWrite
	//  - required: false
	//  - returned: default
	//  - type: string
	//  - uniqueness: none
	ExternalId *string `mandatory:"false" json:"externalId"`
}

func (m AccountRecoverySetting) String() string {
	return common.PointerString(m)
}

// ValidateEnumValue returns an error when providing an unsupported enum value
// This function is being called during constructing API request process
// Not recommended for calling this function directly
func (m AccountRecoverySetting) ValidateEnumValue() (bool, error) {
	errMessage := []string{}
	for _, val := range m.Factors {
		if _, ok := GetMappingAccountRecoverySettingFactorsEnum(string(val)); !ok && val != "" {
			errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for Factors: %s. Supported values are: %s.", val, strings.Join(GetAccountRecoverySettingFactorsEnumStringValues(), ",")))
		}
	}

	for _, val := range m.IdcsPreventedOperations {
		if _, ok := GetMappingIdcsPreventedOperationsEnum(string(val)); !ok && val != "" {
			errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for IdcsPreventedOperations: %s. Supported values are: %s.", val, strings.Join(GetIdcsPreventedOperationsEnumStringValues(), ",")))
		}
	}

	if len(errMessage) > 0 {
		return true, fmt.Errorf(strings.Join(errMessage, "\n"))
	}
	return false, nil
}

// AccountRecoverySettingFactorsEnum Enum with underlying type: string
type AccountRecoverySettingFactorsEnum string

// Set of constants representing the allowable values for AccountRecoverySettingFactorsEnum
const (
	AccountRecoverySettingFactorsEmail        AccountRecoverySettingFactorsEnum = "email"
	AccountRecoverySettingFactorsSms          AccountRecoverySettingFactorsEnum = "sms"
	AccountRecoverySettingFactorsSecquestions AccountRecoverySettingFactorsEnum = "secquestions"
	AccountRecoverySettingFactorsPush         AccountRecoverySettingFactorsEnum = "push"
	AccountRecoverySettingFactorsTotp         AccountRecoverySettingFactorsEnum = "totp"
)

var mappingAccountRecoverySettingFactorsEnum = map[string]AccountRecoverySettingFactorsEnum{
	"email":        AccountRecoverySettingFactorsEmail,
	"sms":          AccountRecoverySettingFactorsSms,
	"secquestions": AccountRecoverySettingFactorsSecquestions,
	"push":         AccountRecoverySettingFactorsPush,
	"totp":         AccountRecoverySettingFactorsTotp,
}

var mappingAccountRecoverySettingFactorsEnumLowerCase = map[string]AccountRecoverySettingFactorsEnum{
	"email":        AccountRecoverySettingFactorsEmail,
	"sms":          AccountRecoverySettingFactorsSms,
	"secquestions": AccountRecoverySettingFactorsSecquestions,
	"push":         AccountRecoverySettingFactorsPush,
	"totp":         AccountRecoverySettingFactorsTotp,
}

// GetAccountRecoverySettingFactorsEnumValues Enumerates the set of values for AccountRecoverySettingFactorsEnum
func GetAccountRecoverySettingFactorsEnumValues() []AccountRecoverySettingFactorsEnum {
	values := make([]AccountRecoverySettingFactorsEnum, 0)
	for _, v := range mappingAccountRecoverySettingFactorsEnum {
		values = append(values, v)
	}
	return values
}

// GetAccountRecoverySettingFactorsEnumStringValues Enumerates the set of values in String for AccountRecoverySettingFactorsEnum
func GetAccountRecoverySettingFactorsEnumStringValues() []string {
	return []string{
		"email",
		"sms",
		"secquestions",
		"push",
		"totp",
	}
}

// GetMappingAccountRecoverySettingFactorsEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingAccountRecoverySettingFactorsEnum(val string) (AccountRecoverySettingFactorsEnum, bool) {
	enum, ok := mappingAccountRecoverySettingFactorsEnumLowerCase[strings.ToLower(val)]
	return enum, ok
}