Skip to main content
Version: 7.2405.x.x LTS

IdmDeleteCredentialState

This AuthState is a processing AuthState.

This plug-in provides credential deletion functionality for an already authenticated user. All credential types are supported. The state is able to remove exactly one credential.

TopicDescription
Classch.nevis.idm.authstate.IdmDeleteCredentialState
LoggingIdmAuth
Auditingnone
MarkerNevisIDM:mutation
Propertiescred.type (String, -) Mandatory if the cred.value property is set, otherwise optional. Defines the credential type. All credential types are allowed.
cred.value (String, -) Optional. The value of the credential. If this property is set, the cred.type property is mandatory. This property is subject to variable substitution.
cred.extId (String, -) Optional. The extId of the credential. This property is subject to variable substitution.
cred.name (String, -) Optional. The name of the credential. This property is subject to variable substitution but usually not used.
cred.context (String, -) Optional. It is only used for context password credentials, for which it is mandatory.
Inputnone
Transitionsok: if credential was successfully deleted
failed: if an error occurred or the credential cannot be identified unambiguously by the given properties and the noCredential.
noCredential: if no credential or more than one credential exists with the given parameters.
clientNotFound: User uses an unsupported client ID, or the "default" client ID (see input above) is not available.
Outputnone
Errorsnone
Notesnone

Example

<AuthState name="DeleteCredential"
class="ch.nevis.idm.authstate.IdmDeleteCredentialState" final="false">
<ResultCond name="ok" next="NextState"/>
<ResultCond name="failed" next="ErrorState"/>
<ResultCond name="noCredential" next="ErrorState"/>
<Response value="AUTH_ERROR"/>
<property name="cred.type" value="GENERIC"/>
<property name="cred.extId" value="credential_extid"/>
<property name="cred.value" value="credential_value"/>
</AuthState>