Skip to main content

Lock or unlock live activity sessions

PUT 
/api/v1/ActivitySession/lock

Locks or unlocks one or more activity sessions. A locked session shows a message to the user until it is unlocked. You can also lock the user, or the user on one resource, so that new sessions are blocked too.

Permission required: Administrators and application accounts. An auditor needs a role that includes auditor permissions, and an auditor or an administrator in read-only view also needs the Lock Session permission for each session's user and resource.

Caution: Locking or unlocking takes effect immediately, and locking the user affects all of that user's active and pending sessions until you unlock them. Unlocking is not limited to the sessions you list. Sessions are processed in order, so if one fails, the sessions before it have already been changed.

Request​

Responses​

The lock or unlock was applied. The body repeats the request.