Disable User

This API is used to disable a mID user temporarily. Disabled users will not be allowed to login.

Resource Informations

Name	Value
Requires authentication?	Yes
Rate limited?	No

Request

Request headers

Key	Value
Authorization	Bearer token
Content-Type	application/json

HTTP request URL for SSMS

PUT https://{tenantId}.{hostname}/digitanium/v4/users/{userName}/disable

HTTP request URL for SHIFT

PUT https://{hostname}/auth/realms/{tenantId}/v3_user/{userName}/disable

note

API requests must be made over https. Calls made over plain http will fail.

Parameters

No parameter fields are required.

Request body (*Required)

Field Name	Type	Description
*enabled	Boolean	False - Disable user

Sample Request

{
	"enabled" : false
}

Response

Field Name	Type	Description
message	String	Message explains result of the API call. Refer Response status Information for details.
status	String	The status of the API call. Refer Response status Information for details.
subSystem	Integer	subSystem categorizes the type of API that has been called. Refer Subsystem details for details.

Sample Response

{
    "message": "User updated successfully",
    "status": "Success",
    "subSystem": 5
}

Response Status Information

Status Code	Status	Message
200	Success	User updated successfully
400	BAD_REQUEST	Username should not be null or empty
401	Unauthorized	HTTP 401 Unauthorized
404	USER_NOT_FOUND	User does not exist