PingAuthorize Server Documentation Index
Configuration Reference Home

Modifiable Password Policy State Plugin

Note: this component is designated "advanced", which means that objects of this type are not expected to be created or altered in most environments. If you believe that such a change is necessary, you may want to contact support in order to understand the potential impact of that change.

The Modifiable Password Policy State Plugin allows the server to maintain a ds-pwp-modifiable-state-json operational attribute whose value is a JSON object with elements of the user's password policy that can be altered by external clients.

The ds-pwp-modifiable-state-json operational attribute can be retrieved in search result entries, and it can be updated in modify operations. Updates to this attribute are subject to the following constraints:

Parent Component
Properties
dsconfig Usage

Parent Component

The Modifiable Password Policy State Plugin component inherits from the Plugin

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ description  None
↓ enabled
↓ base-dn
↓ filter

Basic Properties

description

Description
A description for this Plugin
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

enabled

Description
Indicates whether the plug-in is enabled for use.
Default Value
None
Allowed Values
true
false
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

base-dn

Description
A base DN that may be used to identify entries that should support the ds-pwp-modifiable-state-json operational attribute. If one or more values are provided, then the ds-pwp-modifiable-state-json attribute may only appear in entries below one of the specified base DNs. If no values are provided, then the location of the entry in the DIT will not be considered when determining whether to support the ds-pwp-modifiable-state-json attribute for that entry, and it may appear in any entry in the server.


Default Value
None
Allowed Values
A valid DN.
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action

filter

Description
A filter that may be used to identify entries that should support the ds-pwp-modifiable-state-json operational attribute. If one or more values are provided, then the ds-pwp-modifiable-state-json attribute will only appear in entries that match at least one of those filters. If no values are provided, then the content of the entry will not be considered when determining whether to support the ds-pwp-modifiable-state-json attribute, and it may appear in any entry in the server.
Default Value
None
Allowed Values
A string
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action


dsconfig Usage

To list the configured Plugins:

dsconfig list-plugins
     [--property {propertyName}] ...

To view the configuration for an existing Plugin:

dsconfig get-plugin-prop
     --plugin-name {name}
     [--tab-delimited]
     [--script-friendly]
     [--property {propertyName}] ...

To update the configuration for an existing Plugin:

dsconfig set-plugin-prop
     --plugin-name {name}
     (--set|--add|--remove) {propertyName}:{propertyValue}
     [(--set|--add|--remove) {propertyName}:{propertyValue}] ...

To create a new Modifiable Password Policy State Plugin:

dsconfig create-plugin
     --plugin-name {name}
     --type modifiable-password-policy-state
     --set enabled:{propertyValue}
     [--set {propertyName}:{propertyValue}] ...

To delete an existing Plugin:

dsconfig delete-plugin
     --plugin-name {name}