Identity Data Store Documentation Index
Configuration Reference Home

Error Log Account Status Notification Handler

The Error Log Account Status Notification Handler is a notification handler that writes information to the server error log whenever an appropriate account status event occurs.

Parent Component
Properties
dsconfig Usage

Parent Component

The Error Log Account Status Notification Handler component inherits from the Account Status Notification Handler

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ description  None
↓ enabled
↓ account-status-notification-type

Basic Properties

description

Description
A description for this Account Status Notification Handler
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 Account Status Notification Handler is enabled. Only enabled handlers are invoked whenever a related event occurs in the server.
Default Value
None
Allowed Values
true
false
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

account-status-notification-type

Description
Indicates which types of event can trigger an account status notification.
Default Value
None
Allowed Values
account-temporarily-locked - Generate a notification whenever a user account has been temporarily locked after too many failed attempts.

account-permanently-locked - Generate a notification whenever a user account has been permanently locked after too many failed attempts.

account-unlocked - Generate a notification whenever a user account has been unlocked by an administrator.

account-idle-locked - Generate a notification whenever a user account has been locked because it was idle for too long.

account-reset-locked - Generate a notification whenever a user account has been locked, because the password had been reset by an administrator but not changed by the user within the required interval.

account-disabled - Generate a notification whenever a user account has been disabled by an administrator.

account-enabled - Generate a notification whenever a user account has been enabled by an administrator.

account-expired - Generate a notification whenever a user authentication has failed because the account has expired.

password-expired - Generate a notification whenever a user authentication has failed because the password has expired.

password-expiring - Generate a notification whenever a password expiration warning is encountered for a user password for the first time.

password-reset - Generate a notification whenever a user's password is reset by an administrator.

password-changed - Generate a notification whenever a user changes his/her own password.
Multi-Valued
Yes
Required
Yes
Admin Action Required
None. Modification requires no further action


dsconfig Usage

To list the configured Account Status Notification Handlers:

dsconfig list-account-status-notification-handlers
     [--property {propertyName}] ...

To view the configuration for an existing Account Status Notification Handler:

dsconfig get-account-status-notification-handler-prop
     --handler-name {name}
     [--tab-delimited]
     [--script-friendly]
     [--property {propertyName}] ...

To update the configuration for an existing Account Status Notification Handler:

dsconfig set-account-status-notification-handler-prop
     --handler-name {name}
     (--set|--add|--remove) {propertyName}:{propertyValue}
     [(--set|--add|--remove) {propertyName}:{propertyValue}] ...

To create a new Error Log Account Status Notification Handler:

dsconfig create-account-status-notification-handler
     --handler-name {name}
     --type error-log
     --set enabled:{propertyValue}
     --set account-status-notification-type:{propertyValue}
     [--set {propertyName}:{propertyValue}] ...

To delete an existing Account Status Notification Handler:

dsconfig delete-account-status-notification-handler
     --handler-name {name}