clear-user-session

Details

ID	`clear-user-session`
Language	python
From Version	6.10.0
Docker Image	`demisto/python3:3.12.13.10404775`

README

This script clears user sessions across multiple integrations for a list of usernames.

Script Data

Name	Description
Script Type	python3
Cortex XSOAR Version	6.10.0

Inputs

Argument Name	Description
user_name	A list of usernames to run the session clearance operation for.
user_id	A list of user ids to run the session clearance operation for.
brands	Which integrations brands to run the command for. If not provided, the command will run for all available integrations. For multi-select provide a comma-separated list. For example: “Okta v2,Microsoft Graph User”.
verbose	Whether to retrieve human readable entry for every command or only the final result. True means to retrieve human readable entry for every command. False means to retrieve human readable entry only for the final result.

Outputs

Path	Description	Type
SessionClearResults.Message	Additional information or error details if the session clearing process failed.	String
SessionClearResults.Result	The result of the session clearing process for the user (Success or Failed).	String
SessionClearResults.Brand	The integration (e.g., Microsoft Graph, Okta v2) where the session clearing succeeded.	String
SessionClearResults.UserName	The username for which the session clearing process was executed.	String
SessionClearResults.UserId	The user id for which the session clearing process was executed.	String

Source

ClearUserSession.py ClearUserSession_test.py ClearUserSession.yml

Download History Raw

args:
- description: A list of usernames to run the session clearance operation for.
  name: user_name
  isArray: true
- description: A list of user ids to run the session clearance operation for.
  name: user_id
  isArray: true
- description: |-
    Select which integrations you want the script to run for. If you don't choose any, the command will run for all available integrations. To select multiple integrations, enter their names separated by commas."
  name: brands
  auto: PREDEFINED
  predefined:
  - 'Okta v2'
  - 'Microsoft Graph User'
- description: Set to true to display human-readable output for each step of the command. Set to false (default) to only display the final result.
  name: verbose
  auto: PREDEFINED
  predefined:
  - 'true'
  - 'false'
comment: This script clears user sessions across multiple integrations for a list of usernames.
commonfields:
  id: clear-user-session
  version: -1
name: clear-user-session
outputs:
- contextPath: SessionClearResults.UserName
  description: The username for which the session clearance operation was performed.
  type: string
- contextPath: SessionClearResults.UserId
  description: The user id for which the session clearance operation was performed.
  type: string
- contextPath: SessionClearResults.Message
  description: A message indicating the outcome of the session clearance operation, such as success confirmation or error details.
  type: string
- contextPath: SessionClearResults.Result
  description: The status of the session clearance process. Possible values are "Success" or "Failed".
  type: string
- contextPath: SessionClearResults.Brand
  description: The vendor or system source from which the session clearance result was obtained.
  type: list
script: '-'
timeout: '0'
type: python
compliantpolicies:
  - User Soft Remediation
subtype: python3
dockerimage: demisto/python3:3.12.13.10404775
fromversion: 6.10.0
tests:
- ClearUserSession - Test