Class PasswordPolicy


  • @Generated(value="OracleSDKGenerator",
               comments="API Version: v1")
    public final class PasswordPolicy
    extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    PasswordPolicy resource.
    Note: Objects should always be created or deserialized using the PasswordPolicy.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the PasswordPolicy.Builder, which maintain a set of all explicitly set fields called PasswordPolicy.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).
    • Method Detail

      • getId

        public String getId()
        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

        Returns:
        the value
      • getOcid

        public String getOcid()
        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

        Returns:
        the value
      • getSchemas

        public List<String> getSchemas()
        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

        Returns:
        the value
      • getMeta

        public Meta getMeta()
      • getIdcsPreventedOperations

        public List<IdcsPreventedOperations> getIdcsPreventedOperations()
        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

        Returns:
        the value
      • getTags

        public List<Tags> getTags()
        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

        Returns:
        the value
      • getDeleteInProgress

        public Boolean getDeleteInProgress()
        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

        Returns:
        the value
      • getIdcsLastUpgradedInRelease

        public String getIdcsLastUpgradedInRelease()
        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

        Returns:
        the value
      • getDomainOcid

        public String getDomainOcid()
        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

        Returns:
        the value
      • getCompartmentOcid

        public String getCompartmentOcid()
        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

        Returns:
        the value
      • getTenancyOcid

        public String getTenancyOcid()
        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

        Returns:
        the value
      • getExternalId

        public String getExternalId()
        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

        Returns:
        the value
      • getName

        public String getName()
        A String that is the name of the policy to display to the user.

        This is the only mandatory attribute for a password policy.

        *SCIM++ Properties:** - caseExact: false - idcsSearchable: true - multiValued: false - mutability: immutable - required: true - returned: always - type: string - uniqueness: server

        Returns:
        the value
      • getDescription

        public String getDescription()
        A String that describes the password policy

        *SCIM++ Properties:** - caseExact: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

        Returns:
        the value
      • getMaxLength

        public Integer getMaxLength()
        The maximum password length (in characters).

        A value of 0 or no value indicates no maximum length restriction.

        *SCIM++ Properties:** - caseExact: false - idcsSearchable: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: integer - uniqueness: none

        Returns:
        the value
      • getMinLength

        public Integer getMinLength()
        The minimum password length (in characters).

        A value of 0 or no value indicates no minimum length restriction.

        *SCIM++ Properties:** - caseExact: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: integer - uniqueness: none

        Returns:
        the value
      • getMinAlphas

        public Integer getMinAlphas()
        The minimum number of alphabetic characters in a password.

        A value of 0 or no value indicates no minimum alphas restriction.

        *SCIM++ Properties:** - caseExact: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: integer - uniqueness: none

        Returns:
        the value
      • getMinNumerals

        public Integer getMinNumerals()
        The minimum number of numeric characters in a password.

        A value of 0 or no value indicates no minimum numeric character restriction.

        *SCIM++ Properties:** - caseExact: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: integer - uniqueness: none

        Returns:
        the value
      • getMinAlphaNumerals

        public Integer getMinAlphaNumerals()
        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.

        *SCIM++ Properties:** - caseExact: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: integer - uniqueness: none

        Returns:
        the value
      • getMinSpecialChars

        public Integer getMinSpecialChars()
        The minimum number of special characters in a password.

        A value of 0 or no value indicates no minimum special characters restriction.

        *SCIM++ Properties:** - caseExact: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: integer - uniqueness: none

        Returns:
        the value
      • getMaxSpecialChars

        public Integer getMaxSpecialChars()
        The maximum number of special characters in a password.

        A value of 0 or no value indicates no maximum special characters restriction.

        *SCIM++ Properties:** - caseExact: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: integer - uniqueness: none

        Returns:
        the value
      • getMinLowerCase

        public Integer getMinLowerCase()
        The minimum number of lowercase alphabetic characters in a password.

        A value of 0 or no value indicates no minimum lowercase restriction.

        *SCIM++ Properties:** - caseExact: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: integer - uniqueness: none

        Returns:
        the value
      • getMinUpperCase

        public Integer getMinUpperCase()
        The minimum number of uppercase alphabetic characters in a password.

        A value of 0 or no value indicates no minimum uppercase restriction.

        *SCIM++ Properties:** - caseExact: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: integer - uniqueness: none

        Returns:
        the value
      • getMinUniqueChars

        public Integer getMinUniqueChars()
        The minimum number of unique characters in a password.

        A value of 0 or no value indicates no minimum unique characters restriction.

        *SCIM++ Properties:** - caseExact: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: integer - uniqueness: none

        Returns:
        the value
      • getMaxRepeatedChars

        public Integer getMaxRepeatedChars()
        The maximum number of repeated characters allowed in a password.

        A value of 0 or no value indicates no such restriction.

        *SCIM++ Properties:** - caseExact: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: integer - uniqueness: none

        Returns:
        the value
      • getStartsWithAlphabet

        public Boolean getStartsWithAlphabet()
        Indicates that the password must begin with an alphabetic character

        *SCIM++ Properties:** - caseExact: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean - uniqueness: none

        Returns:
        the value
      • getFirstNameDisallowed

        public Boolean getFirstNameDisallowed()
        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.

        *SCIM++ Properties:** - caseExact: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean - uniqueness: none

        Returns:
        the value
      • getLastNameDisallowed

        public Boolean getLastNameDisallowed()
        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.

        *SCIM++ Properties:** - caseExact: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean - uniqueness: none

        Returns:
        the value
      • getUserNameDisallowed

        public Boolean getUserNameDisallowed()
        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.

        *SCIM++ Properties:** - caseExact: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean - uniqueness: none

        Returns:
        the value
      • getDisallowedUserAttributeValues

        public List<String> getDisallowedUserAttributeValues()
        List of User attributes whose values are not allowed in the password.

        *Added In:** 2303212224

        *SCIM++ Properties:** - idcsSearchable: false - multiValued: true - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

        Returns:
        the value
      • getMinPasswordAge

        public Integer getMinPasswordAge()
        Minimum time after which the user can resubmit the reset password request

        *SCIM++ Properties:** - caseExact: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: integer - uniqueness: none

        Returns:
        the value
      • getPasswordExpiresAfter

        public Integer getPasswordExpiresAfter()
        The number of days after which the password expires automatically

        *SCIM++ Properties:** - caseExact: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: integer - uniqueness: none

        Returns:
        the value
      • getPasswordExpireWarning

        public Integer getPasswordExpireWarning()
        An integer indicating the number of days before which the user should be warned about password expiry.

        *SCIM++ Properties:** - caseExact: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: integer - uniqueness: none

        Returns:
        the value
      • getRequiredChars

        public String getRequiredChars()
        A String value whose contents indicate a set of characters that must appear, in any sequence, in a password value

        *SCIM++ Properties:** - caseExact: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

        Returns:
        the value
      • getDisallowedChars

        public String getDisallowedChars()
        A String value whose contents indicate a set of characters that cannot appear, in any sequence, in a password value

        *SCIM++ Properties:** - caseExact: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

        Returns:
        the value
      • getAllowedChars

        public String getAllowedChars()
        A String value whose contents indicate a set of characters that can appear, in any sequence, in a password value

        *SCIM++ Properties:** - caseExact: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

        Returns:
        the value
      • getDisallowedSubstrings

        public List<String> getDisallowedSubstrings()
        A String value whose contents indicate a set of substrings that cannot appear, in any sequence, in a password value

        *SCIM++ Properties:** - caseExact: false - multiValued: true - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

        Returns:
        the value
      • getDictionaryWordDisallowed

        public Boolean getDictionaryWordDisallowed()
        Indicates whether the password can match a dictionary word

        *SCIM++ Properties:** - caseExact: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean - uniqueness: none

        Returns:
        the value
      • getDictionaryLocation

        public String getDictionaryLocation()
        A Reference value that contains the URI of a dictionary of words not allowed to appear within a password value

        *SCIM++ Properties:** - caseExact: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

        Returns:
        the value
      • getDictionaryDelimiter

        public String getDictionaryDelimiter()
        A delimiter used to separate characters in the dictionary file

        *SCIM++ Properties:** - caseExact: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

        Returns:
        the value
      • getMaxIncorrectAttempts

        public Integer getMaxIncorrectAttempts()
        An integer that represents the maximum number of failed logins before an account is locked

        *SCIM++ Properties:** - caseExact: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: integer - uniqueness: none

        Returns:
        the value
      • getLockoutDuration

        public Integer getLockoutDuration()
        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).

        *SCIM++ Properties:** - caseExact: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: integer - uniqueness: none

        Returns:
        the value
      • getNumPasswordsInHistory

        public Integer getNumPasswordsInHistory()
        The number of passwords that will be kept in history that may not be used as a password

        *SCIM++ Properties:** - caseExact: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: integer - uniqueness: none

        Returns:
        the value
      • getPasswordStrength

        public PasswordPolicy.PasswordStrength getPasswordStrength()
        Indicates whether the password policy is configured as Simple, Standard, or Custom.

        *SCIM++ Properties:** - caseExact: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

        Returns:
        the value
      • getForcePasswordReset

        public Boolean getForcePasswordReset()
        Indicates whether all of the users should be forced to reset their password on the next login (to comply with new password policy changes)

        *SCIM++ Properties:** - caseExact: false - multiValued: false - mutability: writeOnly - required: false - returned: never - type: boolean - uniqueness: none

        Returns:
        the value
      • getDistinctCharacters

        public Integer getDistinctCharacters()
        The number of distinct characters between old password and new password

        *Added In:** 2303212224

        *SCIM++ Properties:** - caseExact: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: integer - uniqueness: none

        Returns:
        the value
      • getPriority

        public Integer getPriority()
        Password policy priority

        *Added In:** 20.1.3

        *SCIM++ Properties:** - caseExact: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: integer - idcsMinValue: 1 - uniqueness: server

        Returns:
        the value
      • getGroups

        public List<PasswordPolicyGroups> getGroups()
        A list of groups that the password policy belongs to.

        *Added In:** 20.1.3

        *SCIM++ Properties:** - caseExact: false - idcsCompositeKey: [value] - idcsSearchable: true - multiValued: true - mutability: readWrite - required: false - returned: default - type: complex - uniqueness: none

        Returns:
        the value
      • getConfiguredPasswordPolicyRules

        public List<PasswordPolicyConfiguredPasswordPolicyRules> getConfiguredPasswordPolicyRules()
        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

        *SCIM++ Properties:** - caseExact: false - idcsCompositeKey: [key] - multiValued: true - mutability: readOnly - required: false - returned: request - type: complex - uniqueness: none

        Returns:
        the value
      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation
      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel