Skip to main content

Function: endUserSession()

endUserSession(client, props): Promise<void>

Ends a user session by marking it as deleted.

Parameters​

client​

ApiClient

The API client instance

props​

The request properties

params​

{ userName: string; sessionId: number; } = endUserSessionParamsSchema

Path parameters (userName, sessionId)

params.userName​

string = userNameSchema

params.sessionId​

number = ...

Returns​

Promise<void>

Promise resolving when the session is ended

Operation Id​

end-user-session

Example​

await endUserSession(client, {
  params: { userName: 'john-doe', sessionId: '...' }
});