box-node-sdk

SessionTerminationManager

• Create jobs to terminate users session
• Create jobs to terminate user group session

Create jobs to terminate users session

Validates the roles and permissions of the user, and creates asynchronous jobs to terminate the user’s sessions. Returns the status for the POST request.

This operation is performed by calling function terminateUsersSessions.

See the endpoint docs at API Reference.

await client.sessionTermination.terminateUsersSessions({
  userIds: [getEnvVar('USER_ID')],
  userLogins: [user.login!],
} satisfies TerminateUsersSessionsRequestBody);

Arguments

• requestBody TerminateUsersSessionsRequestBody
  • Request body of terminateUsersSessions method
• optionalsInput TerminateUsersSessionsOptionalsInput

Returns

This function returns a value of type SessionTerminationMessage.

Returns a message about the request status.

Create jobs to terminate user group session

Validates the roles and permissions of the group, and creates asynchronous jobs to terminate the group’s sessions. Returns the status for the POST request.

This operation is performed by calling function terminateGroupsSessions.

See the endpoint docs at API Reference.

await client.sessionTermination.terminateGroupsSessions({
  groupIds: [group.id],
} satisfies TerminateGroupsSessionsRequestBody);

Arguments

• requestBody TerminateGroupsSessionsRequestBody
  • Request body of terminateGroupsSessions method
• optionalsInput TerminateGroupsSessionsOptionalsInput

Returns

This function returns a value of type SessionTerminationMessage.

Returns a message about the request status.

This site is open source. Improve this page.