Remove user email, mobile, or alias

This is the standard use case delivered by the Remove User Attribute Process. In this example flow, an authenticated end user removes an e-mail address (or mobile number) that was previously registered as an authN ID (i.e., as an attribute on the corresponding User entity). [product: dim]

[/product: dim]

Request

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

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

Response: Specify Attribute

Digital Identity Management responds with a request to specify the attribute to remove:

**RESPONSE - body**
{
   "processId": "9d8a22f5-dee8-4661-95a0-51ac272d819e",
   "processName": "userManagement.RemoveUserAttribute.v1.0",
   "displayMessage": "Please provide the user attribute to be removed.",
   "parameters": {
      "attributeValue": "String",
      "attributeProperty": "String",
      "attributeName": "String"
   },
   "stepName": "RemoveUserAttributePrompt",
   "lastStep": false
}

`processId`	Unique identifier for the current instance of this Process.
`processName`	Full name of the Process, including the category and version number.
`stepName`	The internal name of the step that the Process is currently on / just executed.
`lastStep`	Boolean that indicates whether or not this was the last step in the Process.
`parameters`	Object that specifies the info this Process requires to continue its task.
`attributeName`	The name of the overarching attribute from which to remove a value. Will be `emails`, `mobiles`, or `aliases`.
`attributeProperty`	The name of the property. Used in conjunction with the `attributeValue` to specify the attribute to remove.
`attributeValue`	The value of the attribute (i.e., the actual authN ID value). Used in conjunction with `attributeProperty` to specify the attribute to remove.
Note: A list of available attributes on the user can be obtained by querying the `GET /user` REST API. The following sample excerpt from the API displays the attribute in question:

attributes": [
   {
      "name": "emails",
      "value": [
         "status": "activated",
         "id": 2,
         "email": "ryan@example.com"
      ]
   }
]

Final Request

In order to determine the correct e-mail address to remove, the attribute name (“emails”) must be provided, as well as qualifiers to derive the specific e-mail address, as the user may have multiple e-mail addresses registered to their Digital Identity Management ID. In this example, we are searching for the attribute value “ryan@example.com” in the attribute’s property “email”. The client passes that info to the Process with the Process Step API:

**PUT https://\{your.url\}/process/step**
{
   "processId": "9d8a22f5-dee8-4661-95a0-51ac272d819e",
   "parameters": {
      "attributeValue": "ryan@example.com",
      "attributeProperty": "email",
      "attributeName": "emails"
   }
}

`processId`	Unique identifier for the current instance of this Process.
`parameters`	Object that contains the data that was requested in the previous Process response.
`attributeName`	The name of the overarching attribute from which to remove a value. Will be `emails`, `mobiles`, or `aliases`.
`attributeProperty`	The name of the property. Used in conjunction with the `attributeValue` to specify the attribute to remove.
`attributeValue`	The value of the attribute (i.e., the actual authN ID value). Used in conjunction with `attributeProperty` to specify the attribute to remove.

Process Complete

If the target authN ID is valid, Digital Identity Management removes the target attribute from the User entity. The Process completes and returns a 200 HTTP status:

**RESPONSE - body**
{
   "processId": "9d8a22f5-dee8-4661-95a0-51ac272d819e",
   "processName": "userManagement.RemoveUserAttribute.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.
The user can no longer use this authN ID for authentication purposes. It is removed entirely from the Digital Identity Management data store.

Parent topic:Remove User Attribute Process

Home

Guides

APIs

Request

Response: Specify Attribute

Final Request

Process Complete

​Request

​Response: Specify Attribute

​Final Request

​Process Complete

Request

Response: Specify Attribute

Final Request

Process Complete