SSMS User Logout

API added to Kobil Extensions to support user logout from SSMS.

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}/ssms/logout

HTTP request URL for SHIFT

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

note

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

Parameters

No parameter fields are required.

Request body

No request body fields are required.

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.
data	Boolean	Indicates whether the user is enabled or not.

Sample Response

{
	"data": true,
	"message": "User logged out successfully",
	"status": "OK",
	"subSystem": 5
}

Response Status Information

Status Code	Status	Message
200	OK	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.