Remove user from group

One end user, Jane, is sharing access to their associated accounts and services with another end user, John. John’s User entity is therefore in a Digital Identity Management Group (of which Jane is the Group Primary User), and he is associated directly to the Account and Subscription entities representing those accounts and services. Jane selects to remove John from her Group. By default, this also removes all associations between the target User (John) and any Account, Subscription, and Feature entities in the Group. [product: dim]

[/product: dim] Note: In this example, Jane only has one Digital Identity Management Group (which is the typical case). Therefore, Jane doesn’t need to specify the Group from which to remove John.

Initial Request

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

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

Response: Specify User

Digital Identity Management responds with a prompt to specify the end user to remove from the current end user’s Group:

**RESPONSE - body**
{
   "processId": "3bdd10d2-8f2e-499e-be8e-b6679855e131",
   "processName": "userManagement.RemoveUser.v1.0",
   "stepName": "SelectUserPrompt",
   "parameters": {
      "userId": "long"
   }
}

`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.
`parameters`	Object that specifies the info this Process requires to continue its task.
`userId`	Digital Identity Management’s unique internal identifier of the user to remove (i.e., the `id` property on that Digital Identity Management User entity)

Final Request: Specify User

Once the current end user specifies who to remove, the client passes the target User entity’s id number through the Process Step API request:

**PUT https://\{your.url\}/process/step**
{
   "processId": "3bdd10d2-8f2e-499e-be8e-b6679855e131",
   "parameters": {
      "userId": "6014"
   }
}

`processId`	Unique identifier for the current instance of this Process.
`parameters`	Data object that contains the data that was requested in the previous Process response.
`userId`	Digital Identity Management’s unique internal identifier of the user to remove.

Process Complete

The Process performs the removal, and returns a 200 HTTP status:

**RESPONSE - body**
{
   "processId": "3bdd10d2-8f2e-499e-be8e-b6679855e131",
   "processName": "userManagement.RemoveUser.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:Remove User from Group Process

Home

Guides

APIs

Initial Request

Response: Specify User

Final Request: Specify User

Process Complete

​Initial Request

​Response: Specify User

​Final Request: Specify User

​Process Complete

Initial Request

Response: Specify User

Final Request: Specify User

Process Complete