BIG-IQ APM kill active access sessions¶
Overview¶
API used to kill active access sessions on BIG-IP using a BIG-IQ Centralized Management system.
Version information¶
Version : 5.2, 5.3, 5.4
URI scheme¶
BasePath : /mgmt/cm/access/tasks
Schemes : HTTPS
Consumes¶
application/json
Produces¶
application/json
Paths¶
Kill all active sessions by access-group match.¶
POST /kill-sessions (access-groups)
Description¶
Kill all active access sessions by access-group match.
Parameters¶
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| Body | Json string for request body. | Input parameter list in json format. required ex. {{“action”:”KILL_BY_USER”, “userName”:”user2”, “accessGroupNames”:[“TestGroup1”, “TestGroup2”]}} | post_kill_access_by_access_group |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | POST to kill all active access session of a user. | properties_kill_access_session_collection |
| 400 | Error response Bad Request | 400_error_collection |
| 404 | Error response Public URI path not registered. | 404_error_collection |
List all kill-session tasks as part of a collection.¶
GET /kill-sessions (access-groups)
Description¶
Returns the collection of kill-session tasks.
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | GET collection of session tasks to kill. | properties_kill_access_session_collection |
| 400 | Error response “Bad Request” | 400_error_collection |
| 404 | Error response Public URI path not registered. | 404_error_collection |
Kill all active session for specified devices.¶
POST /kill-sessions (devices)
Description¶
Kill all active access sessions for specified devices.
Parameters¶
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| Body | Json string for request body. | Input parameter list in json format. required ex. {“action”:”KILL_ALL_SESSIONS”, “deviceReferences”:[{“link”:”https://localhost/mgmt/cm/system/machineid-resolver/901695c8-f405-489f-9996-54f7b21da642”}, {“link”:”https://localhost/mgmt/cm/system/machineid-resolver/3f320100-2177-42e0-8a46-2e33cd3366d”}]} | post_kill_access_all |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | POST to kill all active access sessions. | properties_kill_access_session_collection |
| 400 | Error response Bad Request | 400_error_collection |
| 404 | Error response Public URI path not registered. | 404_error_collection |
List all kill-session tasks as part of a collection.¶
GET /kill-sessions (devices)
Description¶
Returns the collection of kill-session tasks.
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | GET collection of session tasks to kill. | properties_kill_access_session_collection |
| 400 | Error response “Bad Request” | 400_error_collection |
| 404 | Error response Public URI path not registered. | 404_error_collection |
Kill all active kill-session by cluster-name match.¶
POST /kill-sessions (bigip clusters)
Description¶
Kill all active access kill-sessions by cluster-name match.
Parameters¶
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| Body | Json string for request body. | Input parameter list in json format. required ex. {{“action”:”KILL_BY_SESSIONS”, “userName”:”user2”, “clusterNames”:[“BlueCluster”, “RedCluster”]}} | post_kill_access_by_cluster_name |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | POST to kill all active access kill-session of a user. | properties_kill_access_session_collection |
| 400 | Error response Bad Request | 400_error_collection |
| 404 | Error response Public URI path not registered. | 404_error_collection |
List all kill-session tasks as part of a collection.¶
GET /kill-sessions (bigip clusters)
Description¶
Returns the collection of kill-session tasks.
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | GET collection of kill-session tasks to kill. | properties_kill_access_session_collection |
| 400 | Error response “Bad Request” | 400_error_collection |
| 404 | Error response Public URI path not registered. | 404_error_collection |
Kill all active kill-session by access-group match.¶
POST /kill-sessions (bigip clusters, access-groups and device reference)
Description¶
Kill all active access kill-sessions by access-group match.
Parameters¶
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| Body | Json string for request body. | Input parameter list in json format. required ex. {“action”:”KILL_BY_USER”, “userName”:”user2”, “accessGroupNames”:[“TestGroup1”, “TestGroup2”], “clusterNames”:[“BlueCluster”, “RedCluster”], “deviceReferences”: [{“link”:”https://localhost/mgmt/cm/system/machineid-resolver/901695c8-f405-489f-9996-54f7b21da642”}, {“link”:”https://localhost/mgmt/cm/system/machineid-resolver/3f320100-2177-42e0-8a46-2e33cd3366d”}]} | post_kill_access_by_cluster_name_access_group_device_reference |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | POST to kill all active access kill-session of a user. | properties_kill_access_session_collection |
| 400 | Error response Bad Request | 400_error_collection |
| 404 | Error response Public URI path not registered. | 404_error_collection |
List all kill-session tasks as part of a collection.¶
GET /kill-sessions (bigip clusters, access-groups and device reference)
Description¶
Returns the collection of kill-session tasks.
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | GET collection of kill-session tasks to kill. | properties_kill_access_session_collection |
| 400 | Error response “Bad Request” | 400_error_collection |
| 404 | Error response Public URI path not registered. | 404_error_collection |
Kill active sessions by session id.¶
POST /kill-sessions (session id)
Description¶
Kill active access sessions by session ID for a device.
Parameters¶
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| Body | Json string for request body. | Input parameter list in json format. required ex. {“action”:”KILL_BY_LIST_OF_SESSIONS”, “sessions”:[{“deviceReference”:{“link”:”https://localhost/mgmt/cm/system/machineid-resolver/901695c8-f405-489f-9996-54f7b21da642”}, “sessionIds”:[“2a5d7604”, “875f7fed”]}, {“deviceReference”:{“link”:”https://localhost/mgmt/cm/system/machineid-resolver/3f320100-2177-42e0-8a46-2e33cd3366d”}, “sessionIds”:[“2hjj234”, “9as3323”]}} | post_kill_access_by_sessions |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | POST to kill active access sessions by session id. | properties_kill_access_session_collection |
| 400 | Error response Bad Request | 400_error_collection |
| 404 | Error response Public URI path not registered. | 404_error_collection |
List all kill-session tasks as part of a collection.¶
GET /kill-sessions (session id)
Description¶
Returns the collection of kill-session tasks.
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | GET collection of session tasks to kill. | properties_kill_access_session_collection |
| 400 | Error response “Bad Request” | 400_error_collection |
| 404 | Error response Public URI path not registered. | 404_error_collection |
Kill all active session by a user.¶
POST /kill-sessions (user)
Description¶
Kill all active access sessions by a user.
Parameters¶
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| Body | Json string for request body. | Input parameter list in json format. required ex. {{“action”:”KILL_BY_USER”,”userName”:”user2”,”deviceReferences”:[{“link”:”https://localhost/mgmt/cm/system/machineid-resolver/901695c8-f405-489f-9996-54f7b21da642”}, {“link”:”https://localhost/mgmt/cm/system/machineid-resolver/3f320100-2177-42e0-8a46-2e33cd3366d”}}} | post_kill_access_by_user_body |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | POST to kill all active access session of a user. | properties_kill_access_session_collection |
| 400 | Error response Bad Request | 400_error_collection |
| 404 | Error response Public URI path not registered. | 404_error_collection |
List all kil-session tasks as part of a collection.¶
GET /kill-sessions (user)
Description¶
Returns the collection of kill-session tasks.
Responses2¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | GET collection of session tasks to kill. | properties_kill_access_session_collection |
| 400 | Error response “Bad Request” | 400_error_collection |
| 404 | Error response Public URI path not registered. | 404_error_collection |
Used to get a single instance of a kill access session task.¶
GET /kill-sessions/{objectId}
Description¶
Returns an object for kill access session task identified by ID for an endpoint URI.
Parameters¶
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| Path | objectId | required | string(UUID) |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | APM kill sessions task object. | properties_kill_access_session |
| 400 | Server error response “Bad Request”. | 400_error_collection |
| 404 | Error response Public URI path not registered. | 404_error_collection |
Definitions¶
400_error_collection¶
| Name | Description | Schema |
|---|---|---|
| errorStack | Error stack trace returned by java. optional, read-only | string |
| items | optional | < object > array |
| kind | Type information for a collection of tasks used to kill access sessions - cm:access:tasks:kill-sessions:accesskillsessionstaskcollectionstate. optional, read-only | string |
| message | Error message returned from server. optional, read-only | string |
| requestBody | The data in the request body. GET (None) optional, read-only | string |
| requestOperationId | Unique ID assigned to rest operation. optional, read-only | integer(int64) |
404_error_collection¶
| Name | Description | Schema |
|---|---|---|
| errorStack | Error stack trace returned by java. optional, read-only | string |
| items | optional | < object > array |
| kind | Type information for a collection of tasks used to kill access sessions - cm:access:tasks:kill-sessions:accesskillsessionstaskcollectionstate. optional, read-only | string |
| message | Error message returned from server. optional, read-only | string |
| requestBody | The data in the request body. GET (None) optional, read-only | string |
| requestOperationId | Unique ID assigned to rest operation. optional, read-only | integer(int64) |
post_kill_access_all¶
| Name | Description | Schema |
|---|---|---|
| action | Action used to kill all access sessions. ex. “KILL_ALL_SESSIONS” required | string |
| deviceReferences | Reference link to one or more devices in which active access sessions live. optional | string |
post_kill_access_by_access_group¶
| Name | Description | Schema |
|---|---|---|
| accessGroupNames | One or more access group names. All sessions in these groups will be killed by invoking task. optional | string |
| action | Action used to kill access session by access_group. ex action. “KILL_BY_USER” required | string |
| userName | User name defined to all sessions owned. optional | string |
post_kill_access_by_cluster_name¶
| Name | Description | Schema |
|---|---|---|
| action | Action used to kill access session by access_group. ex action. “KILL_BY_USER” required | string |
| clusterNames | One or more cluster names. All sessions in these bigip clusters will be killed by invoking task. optional | string |
| userName | User name defined to all sessions owned. optional | string |
post_kill_access_by_cluster_name_access_group_device_reference¶
| Name | Description | Schema |
|---|---|---|
| accessGroupNames | One or more access group names. All sessions in these groups will be killed by invoking task. optional | string |
| action | Action used to kill access session by access_group. ex action. “KILL_BY_USER” required | string |
| clusterNames | One or more cluster names. All sessions in these bigip clusters will be killed by invoking task. optional | string |
| deviceReferences | Reference link to one or more devices in which active access sessions live. optional | string |
| userName | User name defined to all sessions owned. optional | string |
post_kill_access_by_sessions¶
| Name | Description | Schema |
|---|---|---|
| action | Action used to kill all access sessions identified by a session id. ex. “KILL_ALL_SESSIONS” required | string |
| sessions | optional | < sessions > array |
sessions
| Name | Description | Schema |
|---|---|---|
| deviceReference | Reference link to one device in which active access sessions live. optional | deviceReference |
| sessionIds | Unique ID referencing a session. optional | < string > array |
deviceReference
| Name | Description | Schema |
|---|---|---|
| link | Reference link to device in resolver group. optional | string |
post_kill_access_by_user_body¶
| Name | Description | Schema |
|---|---|---|
| action | Action used to kill access session by a user. ex. “KILL_BY_USER” required | string |
| deviceReferences | Reference link to one or more devices in which active access sessions live. optional | string |
| userName | User name defined to all sessions owned. optional | string |
properties_kill_access_session¶
| Name | Description | Schema |
|---|---|---|
| action | Unique ID assigned to a access kill user session task object. required | string |
| currentStep | Current step used to track state of session. optional, read-only | string |
| deviceReferences | Reference link to one or more devices in which active access sessions live. optional | < deviceReferences > array |
| generation | A integer that will track change made to a kill-sessions task object. generation. optional, read-only | integer(int64) |
| id | Unique ID assocaited with kill-sessions task object. optional | string |
| identityReference | Reference link to the user who issued the rest call. optional | < identityReference > array |
| kind | Type information for access kill user session task object - cm:access:tasks:kill-sessions:accesskillsessionstaskitemstate. optional | string |
| lastUpdateMicros | Update time (micros) for last change made to a kill-sessions task object. time. optional, read-only | integer(int64) |
| name | Name of access kill user session task object. optional | string |
| ownerMachineId | Device machine ID used by the kill user session task object. Sessions that live on this device will be killed. optional | string |
| selfLink | A reference link URI to the kill-sessions task object. optional read-only | string |
| startDateTime | Date / Time of when this kill user session task began. optional | string |
| status | Status of kill user session task state. - ex. STARTED, FINISHED. optional | string |
| userName | User name defined to all sessions owned. optional | string |
| userReference | Refernece link to user issing the rest call to start kill-session task. optional | string |
| username | optional | string |
deviceReferences
| Name | Description | Schema |
|---|---|---|
| link | Reference link to device in resolver group. optional | string |
identityReference
| Name | Description | Schema |
|---|---|---|
| link | Reference link to user identity. optional | string |
properties_kill_access_session_collection¶
| Name | Description | Schema |
|---|---|---|
| generation | A integer that will track change made to the access kill user session task collection object. generation optional, read-only | integer(int64) |
| items | A collection of kill-session tasks. optional | < object > array |
| kind | Type information for access kill user session task collection object - cm:access:tasks:kill-sessions:accesskillsessionstaskcollectionstate. optional, read-only | string |
| lastUpdateMicros | Update time (micros) for last change to the access kill user session task collection object. time. optional, read-only | integer(int64) |
| selfLink | A reference link URI for the access kill user session task collection object. optional, read-only | string |