Class PasswordPolicy
PasswordPolicy resource.
Inherited Members
Namespace: Oci.IdentitydomainsService.Models
Assembly: OCI.DotNetSDK.Identitydomains.dll
Syntax
public class PasswordPolicyProperties
AllowedChars
Declaration
[JsonProperty(PropertyName = "allowedChars")]
public string AllowedChars { get; set; }Property Value
| Type | Description |
|---|---|
| string | A String value whose contents indicate a set of characters that can appear, in any sequence, in a password value
|
CompartmentOcid
Declaration
[JsonProperty(PropertyName = "compartmentOcid")]
public string CompartmentOcid { get; set; }Property Value
| Type | Description |
|---|---|
| string | OCI Compartment Id (ocid) in which the resource lives.
|
ConfiguredPasswordPolicyRules
Declaration
[JsonProperty(PropertyName = "configuredPasswordPolicyRules")]
public List<PasswordPolicyConfiguredPasswordPolicyRules> ConfiguredPasswordPolicyRules { get; set; }Property Value
| Type | Description |
|---|---|
| List<PasswordPolicyConfiguredPasswordPolicyRules> | List of password policy rules that have values set. This map of stringKey:stringValue pairs can be used to aid users while setting/resetting password
|
DeleteInProgress
Declaration
[JsonProperty(PropertyName = "deleteInProgress")]
public bool? DeleteInProgress { get; set; }Property Value
| Type | Description |
|---|---|
| bool? | 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.
|
Description
Declaration
[JsonProperty(PropertyName = "description")]
public string Description { get; set; }Property Value
| Type | Description |
|---|---|
| string | A String that describes the password policy
|
DictionaryDelimiter
Declaration
[JsonProperty(PropertyName = "dictionaryDelimiter")]
public string DictionaryDelimiter { get; set; }Property Value
| Type | Description |
|---|---|
| string | A delimiter used to separate characters in the dictionary file
|
DictionaryLocation
Declaration
[JsonProperty(PropertyName = "dictionaryLocation")]
public string DictionaryLocation { get; set; }Property Value
| Type | Description |
|---|---|
| string | A Reference value that contains the URI of a dictionary of words not allowed to appear within a password value
|
DictionaryWordDisallowed
Declaration
[JsonProperty(PropertyName = "dictionaryWordDisallowed")]
public bool? DictionaryWordDisallowed { get; set; }Property Value
| Type | Description |
|---|---|
| bool? | Indicates whether the password can match a dictionary word
|
DisallowedChars
Declaration
[JsonProperty(PropertyName = "disallowedChars")]
public string DisallowedChars { get; set; }Property Value
| Type | Description |
|---|---|
| string | A String value whose contents indicate a set of characters that cannot appear, in any sequence, in a password value
|
DisallowedSubstrings
Declaration
[JsonProperty(PropertyName = "disallowedSubstrings")]
public List<string> DisallowedSubstrings { get; set; }Property Value
| Type | Description |
|---|---|
| List<string> | A String value whose contents indicate a set of substrings that cannot appear, in any sequence, in a password value
|
DisallowedUserAttributeValues
Declaration
[JsonProperty(PropertyName = "disallowedUserAttributeValues")]
public List<string> DisallowedUserAttributeValues { get; set; }Property Value
| Type | Description |
|---|---|
| List<string> | List of User attributes whose values are not allowed in the password.
|
DistinctCharacters
Declaration
[JsonProperty(PropertyName = "distinctCharacters")]
public int? DistinctCharacters { get; set; }Property Value
| Type | Description |
|---|---|
| int? | The number of distinct characters between old password and new password
|
DomainOcid
Declaration
[JsonProperty(PropertyName = "domainOcid")]
public string DomainOcid { get; set; }Property Value
| Type | Description |
|---|---|
| string | OCI Domain Id (ocid) in which the resource lives.
|
ExternalId
Declaration
[JsonProperty(PropertyName = "externalId")]
public string ExternalId { get; set; }Property Value
| Type | Description |
|---|---|
| string | 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.
|
FirstNameDisallowed
Declaration
[JsonProperty(PropertyName = "firstNameDisallowed")]
public bool? FirstNameDisallowed { get; set; }Property Value
| Type | Description |
|---|---|
| bool? | Indicates a sequence of characters that match the user's first name of given name cannot be the password. Password validation against policy will be ignored if length of first name is less than or equal to 3 characters.
|
ForcePasswordReset
Declaration
[JsonProperty(PropertyName = "forcePasswordReset")]
public bool? ForcePasswordReset { get; set; }Property Value
| Type | Description |
|---|---|
| bool? | Indicates whether all of the users should be forced to reset their password on the next login (to comply with new password policy changes)
|
Groups
Declaration
[JsonProperty(PropertyName = "groups")]
public List<PasswordPolicyGroups> Groups { get; set; }Property Value
| Type | Description |
|---|---|
| List<PasswordPolicyGroups> | A list of groups that the password policy belongs to.
|
Id
Declaration
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }Property Value
| Type | Description |
|---|---|
| string | 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.
|
IdcsCreatedBy
Declaration
[JsonProperty(PropertyName = "idcsCreatedBy")]
public IdcsCreatedBy IdcsCreatedBy { get; set; }Property Value
| Type | Description |
|---|---|
| IdcsCreatedBy |
IdcsLastModifiedBy
Declaration
[JsonProperty(PropertyName = "idcsLastModifiedBy")]
public IdcsLastModifiedBy IdcsLastModifiedBy { get; set; }Property Value
| Type | Description |
|---|---|
| IdcsLastModifiedBy |
IdcsLastUpgradedInRelease
Declaration
[JsonProperty(PropertyName = "idcsLastUpgradedInRelease")]
public string IdcsLastUpgradedInRelease { get; set; }Property Value
| Type | Description |
|---|---|
| string | The release number when the resource was upgraded.
|
IdcsPreventedOperations
Declaration
[JsonProperty(PropertyName = "idcsPreventedOperations", ItemConverterType = typeof(ResponseEnumConverter))]
public List<IdcsPreventedOperations> IdcsPreventedOperations { get; set; }Property Value
| Type | Description |
|---|---|
| List<IdcsPreventedOperations> | Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.
|
LastNameDisallowed
Declaration
[JsonProperty(PropertyName = "lastNameDisallowed")]
public bool? LastNameDisallowed { get; set; }Property Value
| Type | Description |
|---|---|
| bool? | Indicates a sequence of characters that match the user's last name of given name cannot be the password. Password validation against policy will be ignored if length of last name is less than or equal to 3 characters.
|
LockoutDuration
Declaration
[JsonProperty(PropertyName = "lockoutDuration")]
public int? LockoutDuration { get; set; }Property Value
| Type | Description |
|---|---|
| int? | The time period in minutes to lock out a user account when the threshold of invalid login attempts is reached. The available range is from 5 through 1440 minutes (24 hours).
|
MaxIncorrectAttempts
Declaration
[JsonProperty(PropertyName = "maxIncorrectAttempts")]
public int? MaxIncorrectAttempts { get; set; }Property Value
| Type | Description |
|---|---|
| int? | An integer that represents the maximum number of failed logins before an account is locked
|
MaxLength
Declaration
[JsonProperty(PropertyName = "maxLength")]
public int? MaxLength { get; set; }Property Value
| Type | Description |
|---|---|
| int? | The maximum password length (in characters). A value of 0 or no value indicates no maximum length restriction.
|
MaxRepeatedChars
Declaration
[JsonProperty(PropertyName = "maxRepeatedChars")]
public int? MaxRepeatedChars { get; set; }Property Value
| Type | Description |
|---|---|
| int? | The maximum number of repeated characters allowed in a password. A value of 0 or no value indicates no such restriction.
|
MaxSpecialChars
Declaration
[JsonProperty(PropertyName = "maxSpecialChars")]
public int? MaxSpecialChars { get; set; }Property Value
| Type | Description |
|---|---|
| int? | The maximum number of special characters in a password. A value of 0 or no value indicates no maximum special characters restriction.
|
Meta
Declaration
[JsonProperty(PropertyName = "meta")]
public Meta Meta { get; set; }Property Value
| Type | Description |
|---|---|
| Meta |
MinAlphaNumerals
Declaration
[JsonProperty(PropertyName = "minAlphaNumerals")]
public int? MinAlphaNumerals { get; set; }Property Value
| Type | Description |
|---|---|
| int? | The minimum number of a combination of alphabetic and numeric characters in a password. A value of 0 or no value indicates no minimum alphanumeric character restriction.
|
MinAlphas
Declaration
[JsonProperty(PropertyName = "minAlphas")]
public int? MinAlphas { get; set; }Property Value
| Type | Description |
|---|---|
| int? | The minimum number of alphabetic characters in a password. A value of 0 or no value indicates no minimum alphas restriction.
|
MinLength
Declaration
[JsonProperty(PropertyName = "minLength")]
public int? MinLength { get; set; }Property Value
| Type | Description |
|---|---|
| int? | The minimum password length (in characters). A value of 0 or no value indicates no minimum length restriction.
|
MinLowerCase
Declaration
[JsonProperty(PropertyName = "minLowerCase")]
public int? MinLowerCase { get; set; }Property Value
| Type | Description |
|---|---|
| int? | The minimum number of lowercase alphabetic characters in a password. A value of 0 or no value indicates no minimum lowercase restriction.
|
MinNumerals
Declaration
[JsonProperty(PropertyName = "minNumerals")]
public int? MinNumerals { get; set; }Property Value
| Type | Description |
|---|---|
| int? | The minimum number of numeric characters in a password. A value of 0 or no value indicates no minimum numeric character restriction.
|
MinPasswordAge
Declaration
[JsonProperty(PropertyName = "minPasswordAge")]
public int? MinPasswordAge { get; set; }Property Value
| Type | Description |
|---|---|
| int? | Minimum time after which the user can resubmit the reset password request
|
MinSpecialChars
Declaration
[JsonProperty(PropertyName = "minSpecialChars")]
public int? MinSpecialChars { get; set; }Property Value
| Type | Description |
|---|---|
| int? | The minimum number of special characters in a password. A value of 0 or no value indicates no minimum special characters restriction.
|
MinUniqueChars
Declaration
[JsonProperty(PropertyName = "minUniqueChars")]
public int? MinUniqueChars { get; set; }Property Value
| Type | Description |
|---|---|
| int? | The minimum number of unique characters in a password. A value of 0 or no value indicates no minimum unique characters restriction.
|
MinUpperCase
Declaration
[JsonProperty(PropertyName = "minUpperCase")]
public int? MinUpperCase { get; set; }Property Value
| Type | Description |
|---|---|
| int? | The minimum number of uppercase alphabetic characters in a password. A value of 0 or no value indicates no minimum uppercase restriction.
|
Name
Declaration
[Required(ErrorMessage = "Name is required.")]
[JsonProperty(PropertyName = "name")]
public string Name { get; set; }Property Value
| Type | Description |
|---|---|
| string | A String that is the name of the policy to display to the user. This is the only mandatory attribute for a password policy.
|
Remarks
Required
NumPasswordsInHistory
Declaration
[JsonProperty(PropertyName = "numPasswordsInHistory")]
public int? NumPasswordsInHistory { get; set; }Property Value
| Type | Description |
|---|---|
| int? | The number of passwords that will be kept in history that may not be used as a password
|
Ocid
Declaration
[JsonProperty(PropertyName = "ocid")]
public string Ocid { get; set; }Property Value
| Type | Description |
|---|---|
| string | Unique OCI identifier for the SCIM Resource.
|
PasswordExpireWarning
Declaration
[JsonProperty(PropertyName = "passwordExpireWarning")]
public int? PasswordExpireWarning { get; set; }Property Value
| Type | Description |
|---|---|
| int? | An integer indicating the number of days before which the user should be warned about password expiry.
|
PasswordExpiresAfter
Declaration
[JsonProperty(PropertyName = "passwordExpiresAfter")]
public int? PasswordExpiresAfter { get; set; }Property Value
| Type | Description |
|---|---|
| int? | The number of days after which the password expires automatically
|
PasswordStrength
Declaration
[JsonProperty(PropertyName = "passwordStrength")]
[JsonConverter(typeof(ResponseEnumConverter))]
public PasswordPolicy.PasswordStrengthEnum? PasswordStrength { get; set; }Property Value
| Type | Description |
|---|---|
| PasswordPolicy.PasswordStrengthEnum? | Indicates whether the password policy is configured as Simple, Standard, or Custom.
|
Priority
Declaration
[JsonProperty(PropertyName = "priority")]
public int? Priority { get; set; }Property Value
| Type | Description |
|---|---|
| int? | Password policy priority
|
RequiredChars
Declaration
[JsonProperty(PropertyName = "requiredChars")]
public string RequiredChars { get; set; }Property Value
| Type | Description |
|---|---|
| string | A String value whose contents indicate a set of characters that must appear, in any sequence, in a password value
|
Schemas
Declaration
[Required(ErrorMessage = "Schemas is required.")]
[JsonProperty(PropertyName = "schemas")]
public List<string> Schemas { get; set; }Property Value
| Type | Description |
|---|---|
| List<string> | 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.
|
Remarks
Required
StartsWithAlphabet
Declaration
[JsonProperty(PropertyName = "startsWithAlphabet")]
public bool? StartsWithAlphabet { get; set; }Property Value
| Type | Description |
|---|---|
| bool? | Indicates that the password must begin with an alphabetic character
|
Tags
Declaration
[JsonProperty(PropertyName = "tags")]
public List<Tags> Tags { get; set; }Property Value
| Type | Description |
|---|---|
| List<Tags> | A list of tags on this resource.
|
TenancyOcid
Declaration
[JsonProperty(PropertyName = "tenancyOcid")]
public string TenancyOcid { get; set; }Property Value
| Type | Description |
|---|---|
| string | OCI Tenant Id (ocid) in which the resource lives.
|
UserNameDisallowed
Declaration
[JsonProperty(PropertyName = "userNameDisallowed")]
public bool? UserNameDisallowed { get; set; }Property Value
| Type | Description |
|---|---|
| bool? | Indicates a sequence of characters that match the username cannot be the password. Password validation against policy will be ignored if length of user name is less than or equal to 3 characters.
|