Package com.oracle.bmc.identitydomains.model

Class PasswordPolicy.Builder

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • id

        public PasswordPolicy.Builder id​(String id)
        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

        Parameters:
        id - the value to set
        Returns:
        this builder

      • ocid

        public PasswordPolicy.Builder ocid​(String ocid)
        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

        Parameters:
        ocid - the value to set
        Returns:
        this builder

      • schemas

        public PasswordPolicy.Builder schemas​(List<String> schemas)
        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

        Parameters:
        schemas - the value to set
        Returns:
        this builder

      • idcsPreventedOperations

        public PasswordPolicy.Builder idcsPreventedOperations​(List<IdcsPreventedOperations> idcsPreventedOperations)
        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

        Parameters:
        idcsPreventedOperations - the value to set
        Returns:
        this builder

      • tags

        public PasswordPolicy.Builder tags​(List<Tags> tags)
        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

        Parameters:
        tags - the value to set
        Returns:
        this builder

      • deleteInProgress

        public PasswordPolicy.Builder deleteInProgress​(Boolean deleteInProgress)
        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

        Parameters:
        deleteInProgress - the value to set
        Returns:
        this builder

      • idcsLastUpgradedInRelease

        public PasswordPolicy.Builder idcsLastUpgradedInRelease​(String idcsLastUpgradedInRelease)
        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

        Parameters:
        idcsLastUpgradedInRelease - the value to set
        Returns:
        this builder

      • domainOcid

        public PasswordPolicy.Builder domainOcid​(String domainOcid)
        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

        Parameters:
        domainOcid - the value to set
        Returns:
        this builder

      • compartmentOcid

        public PasswordPolicy.Builder compartmentOcid​(String compartmentOcid)
        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

        Parameters:
        compartmentOcid - the value to set
        Returns:
        this builder

      • tenancyOcid

        public PasswordPolicy.Builder tenancyOcid​(String tenancyOcid)
        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

        Parameters:
        tenancyOcid - the value to set
        Returns:
        this builder

      • externalId

        public PasswordPolicy.Builder externalId​(String externalId)
        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

        Parameters:
        externalId - the value to set
        Returns:
        this builder

      • name

        public PasswordPolicy.Builder name​(String name)
        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

        Parameters:
        name - the value to set
        Returns:
        this builder

      • description

        public PasswordPolicy.Builder description​(String description)
        A String that describes the password policy

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

        Parameters:
        description - the value to set
        Returns:
        this builder

      • maxLength

        public PasswordPolicy.Builder maxLength​(Integer maxLength)
        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

        Parameters:
        maxLength - the value to set
        Returns:
        this builder

      • minLength

        public PasswordPolicy.Builder minLength​(Integer minLength)
        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

        Parameters:
        minLength - the value to set
        Returns:
        this builder

      • minAlphas

        public PasswordPolicy.Builder minAlphas​(Integer minAlphas)
        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

        Parameters:
        minAlphas - the value to set
        Returns:
        this builder

      • minNumerals

        public PasswordPolicy.Builder minNumerals​(Integer minNumerals)
        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

        Parameters:
        minNumerals - the value to set
        Returns:
        this builder

      • minAlphaNumerals

        public PasswordPolicy.Builder minAlphaNumerals​(Integer minAlphaNumerals)
        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

        Parameters:
        minAlphaNumerals - the value to set
        Returns:
        this builder

      • minSpecialChars

        public PasswordPolicy.Builder minSpecialChars​(Integer minSpecialChars)
        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

        Parameters:
        minSpecialChars - the value to set
        Returns:
        this builder

      • maxSpecialChars

        public PasswordPolicy.Builder maxSpecialChars​(Integer maxSpecialChars)
        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

        Parameters:
        maxSpecialChars - the value to set
        Returns:
        this builder

      • minLowerCase

        public PasswordPolicy.Builder minLowerCase​(Integer minLowerCase)
        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

        Parameters:
        minLowerCase - the value to set
        Returns:
        this builder

      • minUpperCase

        public PasswordPolicy.Builder minUpperCase​(Integer minUpperCase)
        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

        Parameters:
        minUpperCase - the value to set
        Returns:
        this builder

      • minUniqueChars

        public PasswordPolicy.Builder minUniqueChars​(Integer minUniqueChars)
        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

        Parameters:
        minUniqueChars - the value to set
        Returns:
        this builder

      • maxRepeatedChars

        public PasswordPolicy.Builder maxRepeatedChars​(Integer maxRepeatedChars)
        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

        Parameters:
        maxRepeatedChars - the value to set
        Returns:
        this builder

      • startsWithAlphabet

        public PasswordPolicy.Builder startsWithAlphabet​(Boolean startsWithAlphabet)
        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

        Parameters:
        startsWithAlphabet - the value to set
        Returns:
        this builder

      • firstNameDisallowed

        public PasswordPolicy.Builder firstNameDisallowed​(Boolean firstNameDisallowed)
        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

        Parameters:
        firstNameDisallowed - the value to set
        Returns:
        this builder

      • lastNameDisallowed

        public PasswordPolicy.Builder lastNameDisallowed​(Boolean lastNameDisallowed)
        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

        Parameters:
        lastNameDisallowed - the value to set
        Returns:
        this builder

      • userNameDisallowed

        public PasswordPolicy.Builder userNameDisallowed​(Boolean userNameDisallowed)
        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

        Parameters:
        userNameDisallowed - the value to set
        Returns:
        this builder

      • disallowedUserAttributeValues

        public PasswordPolicy.Builder disallowedUserAttributeValues​(List<String> disallowedUserAttributeValues)
        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

        Parameters:
        disallowedUserAttributeValues - the value to set
        Returns:
        this builder

      • minPasswordAge

        public PasswordPolicy.Builder minPasswordAge​(Integer minPasswordAge)
        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

        Parameters:
        minPasswordAge - the value to set
        Returns:
        this builder

      • passwordExpiresAfter

        public PasswordPolicy.Builder passwordExpiresAfter​(Integer passwordExpiresAfter)
        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

        Parameters:
        passwordExpiresAfter - the value to set
        Returns:
        this builder

      • passwordExpireWarning

        public PasswordPolicy.Builder passwordExpireWarning​(Integer passwordExpireWarning)
        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

        Parameters:
        passwordExpireWarning - the value to set
        Returns:
        this builder

      • requiredChars

        public PasswordPolicy.Builder requiredChars​(String requiredChars)
        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

        Parameters:
        requiredChars - the value to set
        Returns:
        this builder

      • disallowedChars

        public PasswordPolicy.Builder disallowedChars​(String disallowedChars)
        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

        Parameters:
        disallowedChars - the value to set
        Returns:
        this builder

      • allowedChars

        public PasswordPolicy.Builder allowedChars​(String allowedChars)
        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

        Parameters:
        allowedChars - the value to set
        Returns:
        this builder

      • disallowedSubstrings

        public PasswordPolicy.Builder disallowedSubstrings​(List<String> disallowedSubstrings)
        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

        Parameters:
        disallowedSubstrings - the value to set
        Returns:
        this builder

      • dictionaryWordDisallowed

        public PasswordPolicy.Builder dictionaryWordDisallowed​(Boolean dictionaryWordDisallowed)
        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

        Parameters:
        dictionaryWordDisallowed - the value to set
        Returns:
        this builder

      • dictionaryLocation

        public PasswordPolicy.Builder dictionaryLocation​(String dictionaryLocation)
        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

        Parameters:
        dictionaryLocation - the value to set
        Returns:
        this builder

      • dictionaryDelimiter

        public PasswordPolicy.Builder dictionaryDelimiter​(String dictionaryDelimiter)
        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

        Parameters:
        dictionaryDelimiter - the value to set
        Returns:
        this builder

      • maxIncorrectAttempts

        public PasswordPolicy.Builder maxIncorrectAttempts​(Integer maxIncorrectAttempts)
        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

        Parameters:
        maxIncorrectAttempts - the value to set
        Returns:
        this builder

      • lockoutDuration

        public PasswordPolicy.Builder lockoutDuration​(Integer lockoutDuration)
        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

        Parameters:
        lockoutDuration - the value to set
        Returns:
        this builder

      • numPasswordsInHistory

        public PasswordPolicy.Builder numPasswordsInHistory​(Integer numPasswordsInHistory)
        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

        Parameters:
        numPasswordsInHistory - the value to set
        Returns:
        this builder

      • passwordStrength

        public PasswordPolicy.Builder passwordStrength​(PasswordPolicy.PasswordStrength passwordStrength)
        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

        Parameters:
        passwordStrength - the value to set
        Returns:
        this builder

      • forcePasswordReset

        public PasswordPolicy.Builder forcePasswordReset​(Boolean forcePasswordReset)
        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

        Parameters:
        forcePasswordReset - the value to set
        Returns:
        this builder

      • distinctCharacters

        public PasswordPolicy.Builder distinctCharacters​(Integer distinctCharacters)
        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

        Parameters:
        distinctCharacters - the value to set
        Returns:
        this builder

      • priority

        public PasswordPolicy.Builder priority​(Integer priority)
        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

        Parameters:
        priority - the value to set
        Returns:
        this builder

      • groups

        public PasswordPolicy.Builder groups​(List<PasswordPolicyGroups> groups)
        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

        Parameters:
        groups - the value to set
        Returns:
        this builder

      • configuredPasswordPolicyRules

        public PasswordPolicy.Builder configuredPasswordPolicyRules​(List<PasswordPolicyConfiguredPasswordPolicyRules> configuredPasswordPolicyRules)
        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

        Parameters:
        configuredPasswordPolicyRules - the value to set
        Returns:
        this builder