The following operation is supported on this resource:

  • POST - Terminate User Sessions
POST /terminate-user-sessions Version 3

Terminate User Sessions.

Sample Usage

This API makes an asynchronous method call; so, you can optionally specify queue and schedule parameters:

POST /terminate-user-sessions?queue=<queue>&schedule=<schedule>

Note: The queue URL denoted by <queue> must have been created already.

  • Parameters:
    Name Type URI Type Description Required
    queue Queue URL Query A fully qualified queue URL, where job progress notifications will be sent (See Asynchronous API Usage) N
    schedule cron-like-expression Query Schedule this API in the future, by specifying a cron-like-expression (See Job Scheduling) N
  • Sample Input XML:
                 <active-user-session href="/api/space/user-management/active-user-sessions/{id}"/>

  • Sample Output XML:
    <task href="/api/space/job-management/jobs/2392073">

  • Sample Input JSON:
         "terminate-user-sessions-request" : {
           "active-user-sessions" : {
             "active-user-session" : {
               "@href" : "/api/space/user-management/active-user-sessions/{id}"

  • Sample Output JSON:
       "task": {
         "@href": "/api/space/job-management/jobs/2392073",
         "id": "2392073"

  • Access Control

    The following capabilities are required to access this API: TerminateUserSession