API

Request Type URL
DELETE /v1/ProfessionalSession/{sessionKey}

Description

Logs out of the Professional Session and closes the dialogue.

Input

The Session ID / Key of the session to be deleted should be provided as the sessionKey path parameter. The Session ID is that returned in ProfessionalSession.id.

Provide ASID of the end-point system and equivalent Session Key generated for the SSO Token-ID.

Example

XAPI_ASID:200000000220
HTTP_X_SESSION_KEY:{sessionKey}

Output

If successful the response code 204 (No Content) is returned. This response has no body.

Notes

Consuming application must have a valid session in order to access this endpoint.

Used to delete a Professional Session after it has been created.

Once deleted the associate Session ID will become invalid.

Session is initially created using the Create Session / Select Role endpoints.