security

Documentation

Index

• type LoginPolicy
  • func GetLoginAuthPolicy(client *golangsdk.ServiceClient, id string) (*LoginPolicy, error)
  • func UpdateLoginAuthPolicy(client *golangsdk.ServiceClient, id string, opts UpdateLoginPolicyOpts) (*LoginPolicy, error)
• type LoginProtectionConfig
  • func GetLoginProtectionConfiguration(client *golangsdk.ServiceClient, id string) (*LoginProtectionConfig, error)
  • func ListLoginProtectionConfigurations(client *golangsdk.ServiceClient) ([]LoginProtectionConfig, error)
  • func UpdateLoginProtectionConfiguration(client *golangsdk.ServiceClient, id string, opts LoginProtectionUpdateOpts) (*LoginProtectionConfig, error)
• type LoginProtectionUpdateOpts
• type MfaDeviceResult
  • func GetUserMfaDevice(client *golangsdk.ServiceClient, id string) (*MfaDeviceResult, error)
  • func ListUserMfaDevices(client *golangsdk.ServiceClient) ([]MfaDeviceResult, error)
• type PasswordPolicy
  • func GetPasswordPolicy(client *golangsdk.ServiceClient, id string) (*PasswordPolicy, error)
  • func UpdatePasswordPolicy(client *golangsdk.ServiceClient, id string, opts UpdatePasswordPolicyOpts) (*PasswordPolicy, error)
• type ProtectionPolicy
  • func GetOperationProtectionPolicy(client *golangsdk.ServiceClient, id string) (*ProtectionPolicy, error)
  • func UpdateOperationProtectionPolicy(client *golangsdk.ServiceClient, id string, opts UpdateProtectionPolicyOpts) (*ProtectionPolicy, error)
• type UpdateLoginPolicyOpts
• type UpdatePasswordPolicyOpts
• type UpdateProtectionPolicyOpts

Types

type LoginPolicy

type LoginPolicy struct {
	// Validity period (days) to disable users if they have not logged in within the period. Value range: 0-240.
	// Validity period (days) to disable users if they have not logged in within the period.
	// If this parameter is set to 0, no users will be disabled.
	AccountValidityPeriod *int `json:"account_validity_period"`
	// Custom information that will be displayed upon successful login.
	CustomInfoForLogin string `json:"custom_info_for_login"`
	// Duration (minutes) to lock users out.
	LockoutDuration int `json:"lockout_duration"`
	// Number of unsuccessful login attempts to lock users out.
	LoginFailedTimes int `json:"login_failed_times"`
	// Period (minutes) to count the number of unsuccessful login attempts.
	PeriodWithLoginFailures int `json:"period_with_login_failures"`
	// Session timeout (minutes) that will apply if you or users created using your account
	// do not perform any operations within a specific period.
	SessionTimeout int `json:"session_timeout"`
	// Indicates whether to display last login information upon successful login.
	ShowRecentLoginInfo *bool `json:"show_recent_login_info"`
}

func GetLoginAuthPolicy

func GetLoginAuthPolicy(client *golangsdk.ServiceClient, id string) (*LoginPolicy, error)

func UpdateLoginAuthPolicy

func UpdateLoginAuthPolicy(client *golangsdk.ServiceClient, id string, opts UpdateLoginPolicyOpts) (*LoginPolicy, error)

type LoginProtectionConfig

type LoginProtectionConfig struct {
	// Indicates whether login protection has been enabled for a user. The value can be true or false.
	Enabled *bool `json:"enabled"`
	// User ID.
	UserId string `json:"user_id"`
	// Login authentication method of the user.
	VerificationMethod string `json:"verification_method"`
}

func GetLoginProtectionConfiguration

func GetLoginProtectionConfiguration(client *golangsdk.ServiceClient, id string) (*LoginProtectionConfig, error)

func ListLoginProtectionConfigurations

func ListLoginProtectionConfigurations(client *golangsdk.ServiceClient) ([]LoginProtectionConfig, error)

func UpdateLoginProtectionConfiguration

func UpdateLoginProtectionConfiguration(client *golangsdk.ServiceClient, id string, opts LoginProtectionUpdateOpts) (*LoginProtectionConfig, error)

type LoginProtectionUpdateOpts

type LoginProtectionUpdateOpts struct {
	// Indicates whether login protection has been enabled for the user. The value can be true or false.
	Enabled *bool `json:"enabled" required:"true"`
	// Login authentication method of the user. Options: sms, email, and vmfa.
	VerificationMethod string `json:"verification_method" required:"true"`
}

type MfaDeviceResult

type MfaDeviceResult struct {
	// Virtual MFA device serial number.
	SerialNumber string `json:"serial_number"`
	// User ID.
	UserId string `json:"user_id"`
}

func GetUserMfaDevice

func GetUserMfaDevice(client *golangsdk.ServiceClient, id string) (*MfaDeviceResult, error)

func ListUserMfaDevices

func ListUserMfaDevices(client *golangsdk.ServiceClient) ([]MfaDeviceResult, error)

type PasswordPolicy

type PasswordPolicy struct {
	// Maximum number of times that a character is allowed to consecutively present in a password.
	MaximumConsecutiveIdenticalChars int `json:"maximum_consecutive_identical_chars"`
	// Maximum number of characters that a password can contain.
	MaximumPasswordLength int `json:"maximum_password_length"`
	// Minimum period (minutes) after which users are allowed to make a password change.
	MinimumPasswordAge int `json:"minimum_password_age"`
	// Minimum number of characters that a password must contain.
	MinimumPasswordLength int `json:"minimum_password_length"`
	// Number of previously used passwords that are not allowed.
	NumberOfRecentPasswordsDisallowed int `json:"number_of_recent_passwords_disallowed"`
	// Indicates whether the password can be the username or the username spelled backwards.
	PasswordNotUsernameOrInvert *bool `json:"password_not_username_or_invert"`
	// Characters that a password must contain.
	PasswordRequirements string `json:"password_requirements"`
	// Password validity period (days).
	PasswordValidityPeriod int `json:"password_validity_period"`
}

func GetPasswordPolicy

func GetPasswordPolicy(client *golangsdk.ServiceClient, id string) (*PasswordPolicy, error)

func UpdatePasswordPolicy

func UpdatePasswordPolicy(client *golangsdk.ServiceClient, id string, opts UpdatePasswordPolicyOpts) (*PasswordPolicy, error)

type ProtectionPolicy

type ProtectionPolicy struct {
	// Indicates whether operation protection has been enabled. The value can be true or false.
	OperationProtection *bool `json:"operation_protection" required:"true"`
}

func GetOperationProtectionPolicy

func GetOperationProtectionPolicy(client *golangsdk.ServiceClient, id string) (*ProtectionPolicy, error)

func UpdateOperationProtectionPolicy

func UpdateOperationProtectionPolicy(client *golangsdk.ServiceClient, id string, opts UpdateProtectionPolicyOpts) (*ProtectionPolicy, error)

type UpdateLoginPolicyOpts

type UpdateLoginPolicyOpts struct {
	// Validity period (days) to disable users if they have not logged in within the period. Value range: 0-240.
	// Validity period (days) to disable users if they have not logged in within the period.
	// If this parameter is set to 0, no users will be disabled.
	AccountValidityPeriod *int `json:"account_validity_period,omitempty"`
	// Custom information that will be displayed upon successful login.
	CustomInfoForLogin string `json:"custom_info_for_login,omitempty"`
	// Duration (minutes) to lock users out.
	LockoutDuration int `json:"lockout_duration,omitempty"`
	// Number of unsuccessful login attempts to lock users out.
	LoginFailedTimes int `json:"login_failed_times,omitempty"`
	// Period (minutes) to count the number of unsuccessful login attempts.
	PeriodWithLoginFailures int `json:"period_with_login_failures,omitempty"`
	// Session timeout (minutes) that will apply if you or users created using your account
	// do not perform any operations within a specific period.
	SessionTimeout int `json:"session_timeout,omitempty"`
	// Indicates whether to display last login information upon successful login.
	ShowRecentLoginInfo *bool `json:"show_recent_login_info,omitempty"`
}

type UpdatePasswordPolicyOpts

type UpdatePasswordPolicyOpts struct {
	// Maximum number of times that a character is allowed to consecutively present in a password.
	MaximumConsecutiveIdenticalChars *int `json:"maximum_consecutive_identical_chars,omitempty"`
	// Minimum period (minutes) after which users are allowed to make a password change.
	MinimumPasswordAge *int `json:"minimum_password_age,omitempty"`
	// Minimum number of characters that a password must contain.
	MinimumPasswordLength *int `json:"minimum_password_length,omitempty"`
	// Number of previously used passwords that are not allowed.
	NumberOfRecentPasswordsDisallowed *int `json:"number_of_recent_passwords_disallowed,omitempty"`
	// Indicates whether the password can be the username or the username spelled backwards.
	PasswordNotUsernameOrInvert *bool `json:"password_not_username_or_invert,omitempty"`
	// Password validity period (days).
	PasswordValidityPeriod *int `json:"password_validity_period,omitempty"`
}

type UpdateProtectionPolicyOpts

type UpdateProtectionPolicyOpts struct {
	// Indicates whether operation protection has been enabled. The value can be true or false.
	OperationProtection *bool `json:"operation_protection"`
}