# CredentialsResetPolicyType (Complex Type)

### Namespace: http://midpoint.evolveum.com/xml/ns/public/common/common-3

Credentials reset management policy. It specifies the management details for each supported credentials reset type. It defines parameters such as reset method.

The idea is that all the password reset mechanisms have the same parts: request, authentication, credential source, delivery. This data structure is meant to configure those steps.

Item Summary
Name | Type | Multiplicity | Description
--- | --- | --- | ---
name | property string | [0,1] | Name of the password reset scheme.
description | property string | [0,1] | Free form description of the credential reset method (administrator comment).
documentation | property string | [0,1] | Technical documentation for a particular object or construct.
authenticationSequenceName | property string | [0,1] | Defined authentication sequence, which will be use for reset credential.
newCredentialSource | container CredentialSourceType | [0,1] | Source of a new credential value.
forceChange | property boolean | [0,1] | If set to true then the new credential will have the forceChange flag set.
formRef | reference ObjectReferenceType | [0,1] | Reference to form which is displayed for reset

- ### Items

  - #### name

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Name of the password reset scheme. This is a short name that acts both as an identifier of the scheme and also as a short name used for diagnostics.

  - #### description

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Free form description of the credential reset method (administrator comment).

  - #### documentation

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Technical documentation for a particular object or construct.

    The purpose of this element is to document system configuration and behavior. The documentation will not be presented to end users. In fact, it will probably not be presented at all in midPoint user interface. This documentation element is supposed to be a part of the technical documentation of midPoint deployment. The tools than generate deployment configuration will look for these elements and combine them to compiled documentation document.

    AsciiDoc formatting is assumed for this element. Any leading or trailing whitespace is skipped. Indentation equivalent to he indentation of the first non-blank line of text is also skipped.

  - #### authenticationSequenceName

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Defined authentication sequence, which will be use for reset credential.

  - #### newCredentialSource

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Source of a new credential value. This setting specifies whether the new credential value should be provided by the user, randomly generated, derived by a key-exchange protocol and so on.

  - #### forceChange

    Flags: RAM,runtime

    Multiplicity: [0,1]

    If set to true then the new credential will have the forceChange flag set. Which usually means that the user will have to change the credential on next logon.

  - #### formRef

    Flags: RAM

    Multiplicity: [0,1]

    Reference to form which is displayed for reset