Delete User
This request is used to delete the existing user.
Method: HTTP DELETE method
Endpoint: http://<host_address>:<port_address>/v1/user
| Parameter | Cardinality | Description | |
|---|---|---|---|
| X-API-AppId | Mandatory | The application ID is used for getting user details. The default ID is auth. | |
| X-API-Key | Mandatory | This key is used for getting user details. The default ID is auth. | |
| userInfo (Body) | enabled | Mandatory | The value can be true or false. The value true makes the user accessible through the configurator and Order Management System UI and false makes the user disable. |
| password | Mandatory | It specifies the password for the user to be deleted. | |
| tenantId | Mandatory | This is the tenant value as stored in users table in the database. | |
| userName | Mandatory | It specifies the user name to be deleted. | |
| userRoles | Mandatory | It specifies the role assigned to the user to be deleted. | |
Example for Delete User request:
{
"user": [
{
"enabled": true,
"password": "testpassword",
"tenantId": "testTenant",
"userName": "testuser",
"userRoles": [
"ROLE_ADMIN"
]
}
]
}
Copyright © 2021. Cloud Software Group, Inc. All Rights Reserved.
