retrieve User Actioning
GET {{baseUrl}}/api/user/action?userId=<string>&preventingLogin=<string>&active=<string>
Retrieves all the actions for the user with the given Id that are currently preventing the User from logging in. OR Retrieves all the actions for the user with the given Id. This will return all time based actions that are active, and inactive as well as non-time based actions. OR Retrieves all the actions for the user with the given Id that are currently active. An active action means one that is time based and has not been canceled, and has not ended. OR Retrieves all the actions for the user with the given Id that are currently inactive. An inactive action means one that is time based and has been canceled or has expired, or is not time based.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
userId | string | The Id of the user to fetch the actions for. | |
preventingLogin | string | ||
active | string |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"action":{"actioneeUserId":"\u003cuuid\u003e","actionerUserId":"\u003cuuid\u003e","applicationIds":["\u003cuuid\u003e","\u003cuuid\u003e"],"comment":"\u003cstring\u003e","emailUserOnEnd":"\u003cboolean\u003e","endEventSent":"\u003cboolean\u003e","expiry":"\u003clong\u003e","history":{"historyItems":[{"actionerUserId":"\u003cuuid\u003e","comment":"\u003cstring\u003e","createInstant":"\u003clong\u003e","expiry":"\u003clong\u003e"},{"actionerUserId":"\u003cuuid\u003e","comment":"\u003cstring\u003e","createInstant":"\u003clong\u003e","expiry":"\u003clong\u003e"}]},"id":"\u003cuuid\u003e","insertInstant":"\u003clong\u003e","localizedName":"\u003cstring\u003e","localizedOption":"\u003cstring\u003e","localizedReason":"\u003cstring\u003e","name":"\u003cstring\u003e","notifyUserOnEnd":"\u003cboolean\u003e","option":"\u003cstring\u003e","reason":"\u003cstring\u003e","reasonCode":"\u003cstring\u003e","userActionId":"\u003cuuid\u003e"},"actions":[{"actioneeUserId":"\u003cuuid\u003e","actionerUserId":"\u003cuuid\u003e","applicationIds":["\u003cuuid\u003e","\u003cuuid\u003e"],"comment":"\u003cstring\u003e","emailUserOnEnd":"\u003cboolean\u003e","endEventSent":"\u003cboolean\u003e","expiry":"\u003clong\u003e","history":{"historyItems":[{"actionerUserId":"\u003cuuid\u003e","comment":"\u003cstring\u003e","createInstant":"\u003clong\u003e","expiry":"\u003clong\u003e"},{"actionerUserId":"\u003cuuid\u003e","comment":"\u003cstring\u003e","createInstant":"\u003clong\u003e","expiry":"\u003clong\u003e"}]},"id":"\u003cuuid\u003e","insertInstant":"\u003clong\u003e","localizedName":"\u003cstring\u003e","localizedOption":"\u003cstring\u003e","localizedReason":"\u003cstring\u003e","name":"\u003cstring\u003e","notifyUserOnEnd":"\u003cboolean\u003e","option":"\u003cstring\u003e","reason":"\u003cstring\u003e","reasonCode":"\u003cstring\u003e","userActionId":"\u003cuuid\u003e"},{"actioneeUserId":"\u003cuuid\u003e","actionerUserId":"\u003cuuid\u003e","applicationIds":["\u003cuuid\u003e","\u003cuuid\u003e"],"comment":"\u003cstring\u003e","emailUserOnEnd":"\u003cboolean\u003e","endEventSent":"\u003cboolean\u003e","expiry":"\u003clong\u003e","history":{"historyItems":[{"actionerUserId":"\u003cuuid\u003e","comment":"\u003cstring\u003e","createInstant":"\u003clong\u003e","expiry":"\u003clong\u003e"},{"actionerUserId":"\u003cuuid\u003e","comment":"\u003cstring\u003e","createInstant":"\u003clong\u003e","expiry":"\u003clong\u003e"}]},"id":"\u003cuuid\u003e","insertInstant":"\u003clong\u003e","localizedName":"\u003cstring\u003e","localizedOption":"\u003cstring\u003e","localizedReason":"\u003cstring\u003e","name":"\u003cstring\u003e","notifyUserOnEnd":"\u003cboolean\u003e","option":"\u003cstring\u003e","reason":"\u003cstring\u003e","reasonCode":"\u003cstring\u003e","userActionId":"\u003cuuid\u003e"}]}