Unregister Authenticator App from User ID

This is the standard use case delivered by the Unregister Authenticator App Process. An authenticated user previously registered a RFC 6238-compliant authenticator app to their User ID. They now choose to remove that app.

In order to render meaningful options to the user, your client can retrieve User entity data with the GET /user API (either after the user authenticates, or when they navigate to their profile in your UI). Note: Although the user is already authenticated when they invoke this Process, Digital Identity Management requires them to provide their password to “raise” their authentication level before adding or removing an external MFA security option.

Initial Request

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

**REQUEST - POST https://\{your.url\}/process/start/userManagement.UnregisterAuthenticatorAppAsMFA.v1.0**
<no body>

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": "7e034cfd-85fb-464c-a995-8eee3acb98c2",
   "processName": "userManagement.UnregisterAuthenticatorAppAsMFA.v1.0",
   "stepName": "PasswordPrompt",
   "lastStep": false,
   "displayMessage": "Please provide your password.",
   "parameters": {
      "password": "String"
   }
}

Note: If the user does not have a password (i.e., they onboarded with a social account) 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.

Final Request: 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": "7e034cfd-85fb-464c-a995-8eee3acb98c2",
   "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

Digital Identity Management validates the user’s password and, if the password is correct, removes the authenticator app from the user’s corresponding User entity. The Process returns a 200 HTTP status, and ends.

**RESPONSE - body**
{
   "processId": "7e034cfd-85fb-464c-a995-8eee3acb98c2",
   "processName": "userManagement.UnregisterAuthenticatorAppAsMFA.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.
See Unregister authenticator app errors for error code details.

Parent topic:Unregister Authenticator App Process

Home

Guides

APIs

Initial Request

Response: Password prompt

Final Request: user provides password

Process Complete

​Initial Request

​Response: Password prompt

​Final Request: user provides password

​Process Complete

Initial Request

Response: Password prompt

Final Request: user provides password

Process Complete