End a session

delete/servers/{serverName}/sessions/{sessionId}

Terminates a session. Sessions that can be terminated are consistent with the permissions of the user. Normally, only sessions owned by the authenticated user can be ended. If a user has administrative privileges, and has elevated their session to use those privileges (see CAS Access Management microservice), all sessions on the server can be ended.

Request Samples

Response Samples

1Not Available

Path Parameters

serverName
string
true

Server name containing the session.

sessionId
string
true

Session ID on which to perform the operation.

Query Parameters

force
string
false

Forces the termination of a running CAS action for this session. By default, a session does not terminate until all actions have completed.

superUserSessionId
string
false

Session ID being used to delete the specified sessionId with. Has to be a superuser.

Responses

StatusMeaningDescription
204No Content

The session was terminated.

400Bad Request

The request was invalid.

Schema
404Not Found

The requested session in the requested server name does not exist.

409Conflict

The request could not be completed due to a conflict with the current state of the resource. Details are included in the response body.