Unregister AuthN ID as MFA

An user removes the MFA configuration from their registered authN ID (email address or mobile number). [product: dim]

[/product: dim]

Request

Your client calls the Process Start API to initialize the Process:

**REQUEST - POST https://\{your.url\}/process/start/userManagement.UnregisterAuthnIdentifierAsMFA.v1.0?authnIdentifier=bob@example.com**
<no body>

Note: Unlike most Processes, this Process requires the client to provide the target authN ID upfront in the initial Process Start request. The client can specify the authN ID either directly in the request URL, or in the request body like this:

**REQUEST - POST https://\{your.url\}/process/start/userManagement.UnregisterAuthnIdentifierAsMFA.v1.0**
{
   "authnIdentifier": "bob@example.com"
}

Response: password prompt

Digital Identity Management checks to see if the current user has a registered password. If they do, then the Process returns a prompt for that password.

**RESPONSE - body**
{
   "processId": "15fc9b7a-308e-4660-83ed-fb6781e1614a",
   "processName": "userManagement.UnregisterAuthnIdentifierAsMFA.v1.0",
   "stepName": "PasswordPrompt",
   "lastStep": false,
   "displayMessage": "Please provide your password.",
   "parameters": {
      "password": "String"
   }
}

Note: If the user onboarded with their social account, and do not have a registered password, then the Process returns an error, and ends.

`processId`	Unique identifier for the current instance of this Process.
`processName`	Full name of the Process, including the category and version number.
`stepName`	Name of the specific step that the Process is currently on.
`lastStep`	Boolean that indicates whether or not this was the last step in the Process.
`displayMessage`	Optional message the client can render for the user.
`parameters`	Object that specifies the info this Process requires to continue its task.
`password`	The current Digital Identity Management User’s registered password.

Next Step: User provides password

The user enters their password, and your client passes it to Digital Identity Management in a Process Step API request:

**PUT https://\{your.url\}/process/step**
{
   "processId": "15fc9b7a-308e-4660-83ed-fb6781e1614a",
   "parameters": {
      "password": "L3tm3inplease"
   }
}

`processId`	Unique identifier for the current instance of this Process.
`parameters`	Object that contains the data that was requested in the previous Process response.
`password`	The current Digital Identity Management User’s registered password.

Process Complete

The Process completes its task, and returns an HTTP 200 status:

**RESPONSE - body**
{
   "processId": "15fc9b7a-308e-4660-83ed-fb6781e1614a",
   "processName": "userManagement.UnregisterAuthnIdentifierAsMFA.v1.0",
   "lastStep": true, 
}

`processId`	Unique identifier for the current instance of this Process.
`processName`	Full name of the Process, including the category and version number.
`lastStep`	Boolean that indicates whether or not this was the last step in the Process.
Parent topic:Unregister Email or Mobile as MFA

Home

Guides

APIs

Request

Response: password prompt

Next Step: User provides password

Process Complete

​Request

​Response: password prompt

​Next Step: User provides password

​Process Complete

Request

Response: password prompt

Next Step: User provides password

Process Complete