Destroy a session

delete/cas/sessions/{sessionId}

Destroy a session. The method used to end the session is determined by the value of the "command" option. For "endSession", the session is ended using the endSession action, and no output is returned upon success. For "cancel", the session is eonded using the cancelSession action (run in a transient session), and an empty JSON object is returned upon success. For "terminate", the session's processes are terminated on all of the CAS nodes and an empty JSON object is returned upon success.

Request Samples

1

Response Samples

1Not Available

Path Parameters

NameTypeRequiredDescription
sessionId
string
true

sessionId (UUID) of session.

Query Parameters

NameTypeRequiredDescription
command
string
true

Select the method used to end the session.

Allowed values:
endSessioncancelterminate

Responses

StatusMeaningDescription
200OK

OK

404Not Found

Unknown session.

Schema