Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace PasswordPolicy

PasswordPolicy resource.

Properties

Optional allowedChars

allowedChars: undefined | string

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

Optional compartmentOcid

compartmentOcid: undefined | string

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

Optional configuredPasswordPolicyRules

configuredPasswordPolicyRules: Array<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

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

Optional deleteInProgress

deleteInProgress: undefined | false | true

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

Optional description

description: undefined | string

A String that describes the password policy

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

Optional dictionaryDelimiter

dictionaryDelimiter: undefined | string

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

Optional dictionaryLocation

dictionaryLocation: undefined | string

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

Optional dictionaryWordDisallowed

dictionaryWordDisallowed: undefined | false | true

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

Optional disallowedChars

disallowedChars: undefined | string

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

Optional disallowedSubstrings

disallowedSubstrings: Array<string>

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

Optional disallowedUserAttributeValues

disallowedUserAttributeValues: Array<string>

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

Optional distinctCharacters

distinctCharacters: undefined | number

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 Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional domainOcid

domainOcid: undefined | string

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

Optional externalId

externalId: undefined | 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.

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

Optional firstNameDisallowed

firstNameDisallowed: undefined | false | true

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

Optional forcePasswordReset

forcePasswordReset: undefined | false | true

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

Optional 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

Optional id

id: undefined | 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.

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

Optional idcsCreatedBy

idcsCreatedBy: model.IdcsCreatedBy

Optional idcsLastModifiedBy

idcsLastModifiedBy: model.IdcsLastModifiedBy

Optional idcsLastUpgradedInRelease

idcsLastUpgradedInRelease: undefined | string

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

Optional idcsPreventedOperations

idcsPreventedOperations: Array<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

Optional lastNameDisallowed

lastNameDisallowed: undefined | false | true

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

Optional lockoutDuration

lockoutDuration: undefined | number

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 Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional maxIncorrectAttempts

maxIncorrectAttempts: undefined | number

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 Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional maxLength

maxLength: undefined | number

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 Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional maxRepeatedChars

maxRepeatedChars: undefined | number

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 Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional maxSpecialChars

maxSpecialChars: undefined | number

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 Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional meta

meta: model.Meta

Optional minAlphaNumerals

minAlphaNumerals: undefined | number

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 Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional minAlphas

minAlphas: undefined | number

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 Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional minLength

minLength: undefined | number

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 Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional minLowerCase

minLowerCase: undefined | number

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 Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional minNumerals

minNumerals: undefined | number

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 Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional minPasswordAge

minPasswordAge: undefined | number

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 Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional minSpecialChars

minSpecialChars: undefined | number

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 Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional minUniqueChars

minUniqueChars: undefined | number

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 Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional minUpperCase

minUpperCase: undefined | number

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 Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

name

name: 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.

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

Optional numPasswordsInHistory

numPasswordsInHistory: undefined | number

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 Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional ocid

ocid: undefined | string

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

Optional passwordExpireWarning

passwordExpireWarning: undefined | number

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 Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional passwordExpiresAfter

passwordExpiresAfter: undefined | number

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 Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional passwordStrength

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

Optional priority

priority: undefined | number

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 Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional requiredChars

requiredChars: undefined | string

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

schemas

schemas: Array<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.

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

Optional startsWithAlphabet

startsWithAlphabet: undefined | false | true

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

Optional tags

tags: Array<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

Optional tenancyOcid

tenancyOcid: undefined | string

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

Optional userNameDisallowed

userNameDisallowed: undefined | false | true

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

Functions

getDeserializedJsonObj

getJsonObj