curl -X POST "<base_url>/usermanagement/v1/users/disable" \
-H "X-AccessToken: YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"userName": "string",
"serviceName": "rmd"
}'
{
"header": {
"code": 1,
"message": "Account has been disabled successfully",
"response_code": 1
},
"body": {
"userName": "string",
"serviceName": "rmd",
"statusUpdated": "Disable"
}
}
User Management
Disable a User
Disables an active user.
POST
/
usermanagement
/
v1
/
users
/
disable
curl -X POST "<base_url>/usermanagement/v1/users/disable" \
-H "X-AccessToken: YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"userName": "string",
"serviceName": "rmd"
}'
{
"header": {
"code": 1,
"message": "Account has been disabled successfully",
"response_code": 1
},
"body": {
"userName": "string",
"serviceName": "rmd",
"statusUpdated": "Disable"
}
}
Disables an active user. If
See Errors for the response envelope and the full list of codes.
serviceName is supplied, only that user’s subscription to that service is disabled; if it is omitted, the user account and every service the user is already subscribed to are disabled.
- URL:
/usermanagement/v1/users/disable - Full URL:
<base_url>/usermanagement/v1/users/disable - Request Method: POST
Authentication
Send the Access Token in theX-AccessToken request header on every authenticated call:
X-AccessToken: YOUR_ACCESS_TOKEN
Request Body
string
required
Username generated when the user was created.
string
Optional. When omitted, disables the user and every service the user is subscribed to.
Sample Request
cURL
curl -X POST "<base_url>/usermanagement/v1/users/disable" \
-H "X-AccessToken: YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"userName": "string",
"serviceName": "rmd"
}'
curl -X POST "<base_url>/usermanagement/v1/users/disable" \
-H "X-AccessToken: YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"userName": "string",
"serviceName": "rmd"
}'
Response
object
object
Sample Response
Success
{
"header": {
"code": 1,
"message": "Account has been disabled successfully",
"response_code": 1
},
"body": {
"userName": "string",
"serviceName": "rmd",
"statusUpdated": "Disable"
}
}
{
"header": {
"code": 1,
"message": "Account has been disabled successfully",
"response_code": 1
},
"body": {
"userName": "string",
"serviceName": "rmd",
"statusUpdated": "Disable"
}
}
Status Codes
| Status | Meaning |
|---|---|
200 | Success. |
500 | Internal Server Error. |
Error codes
Returned inheader.response_code when the request fails.
| Code | Message |
|---|---|
998 | Internal server error |
1001 | Validation error |
1002 | You are not permitted to the resource! |
1003 | Invalid service slug provided |
1004 | Account is not subscribed to this service |
1005 | Invalid username or reseller |