User Logout

API to logout the user from IAM and SSMS, ssms query parameter is to decide whether to logout the user from SSMS or not.

Resource Informations

Name	Value
Requires authentication?	Yes
Rate limited?	No

Key	Value
Authorization	Bearer token
Content-Type	application/json

PUT https://{tenantId}.{hostname}/digitanium/v4/users/{userid}/logout?ssms=true

PUT https://{hostname}/auth/realms/{tenantId}/v3_user/{userid}/ssms/logout?ssms=true

note

At this moment, this API is applicable only for SSMS based installations.

note

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

Parameter Name	Type	Description
SSMS	Boolean	True - Enable, False - Disable

No request body fields are required.

Field Name	Type	Description
message	String	The message explains the result of the API call. Refer to 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.

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

Status Code	Status	Message
200	Success	User logged out successfully.
401	Unauthorized	HTTP 401 Unauthorized.
404	USER_NOT_FOUND	User does not exist.
409	USER_ALREADY_LOGGED_OUT	User is not logged in state to perform this action.