disable-user

Details

ID	`disable-user`
Language	python
From Version	6.10.0
Docker Image	`demisto/python3:3.12.13.10116658`

README

This script disables users for multiple services.

Script Data

Name	Description
Script Type	python3
Cortex XSOAR Version	6.1.0

Dependencies

This script uses the following commands and scripts.

get-user-data

Inputs

Argument Name	Description
user_id	List of users IDs of the users to disable. At least one of “user_id”, “user_name” or “user_email” is required.
user_name	List of names of the users to disable. At least one of “user_id”, “user_name” or “user_email” is required.
user_email	List of emails of the users to disable. At least one of “user_id”, “user_name” or “user_email” is required.
brands	List of brands to disable users from.
verbose	Whether to fetch a human-readable entry for each command or just the final result. If set to true, all commands will have human-readable entries. If set to false, only the final result will be human-readable.

Outputs

Path	Description	Type
DisableUser.Brand	The brand (integration) used to disable the user.	String
DisableUser.Instance	The integration instance used to disable the user.	String
DisableUser.Disabled	Whether the user is disabled.	Boolean
DisableUser.Result	Whether the disable action was successful. The result does not indicate whether the user is disabled. Possible values are: “Success”, “Failed”	String
DisableUser.Message	The output message of the disable action.	String
DisableUser.UserProfile.Username	The username of the user.	String
DisableUser.UserProfile.ID	The ID of the user.	String
DisableUser.UserProfile.Email	The Email address of the user.	String

Source

DisableUser.py DisableUser_test.py DisableUser.yml

Download History Raw

args:
- description: List of users IDs of the users to disable. At least one of "user_id", "user_name" or "user_email" is required.
  name: user_id
  isArray: true
- description: List of names of the users to disable. At least one of "user_id", "user_name" or "user_email" is required.
  name: user_name
  isArray: true
- description: List of emails of the users to disable. At least one of "user_id", "user_name" or "user_email" is required.
  name: user_email
  isArray: true
- description: List of brands to disable users from.
  isArray: true
  name: brands
  auto: PREDEFINED
  predefined:
  - 'Active Directory Query v2'
  - 'Microsoft Graph User'
  - 'Okta v2'
  - 'Okta IAM'
  - 'AWS-ILM'
  - 'GSuiteAdmin'
  defaultValue: "Active Directory Query v2,Microsoft Graph User,Okta v2,Okta IAM,AWS-ILM,GSuiteAdmin"
- description: Whether to fetch a human-readable entry for each command or just the final result. If set to true, all commands will have human-readable entries. If set to false, only the final result will be human-readable.
  name: verbose
  defaultValue: 'false'
  auto: PREDEFINED
  predefined:
  - 'true'
  - 'false'
comment: This script disables users for multiple services.
commonfields:
  id: disable-user
  version: -1
enabled: false
name: disable-user
outputs:
- contextPath: DisableUser.Brand
  description: The brand (integration) used to disable the user.
  type: String
- contextPath: DisableUser.Instance
  description: The integration instance used to disable the user.
  type: String
- contextPath: DisableUser.Disabled
  description: Whether the user is disabled.
  type: Boolean
- contextPath: DisableUser.Result
  description: 'Whether the disable action was successful. The result does not indicate whether the user is disabled. Possible values are: "Success", "Failed".'
  type: String
- contextPath: DisableUser.Message
  description: The output message of the disable action.
  type: String
- contextPath: DisableUser.UserProfile.Username
  description: The username of the user.
  type: String
- contextPath: DisableUser.UserProfile.ID
  description: The ID of the user.
  type: String
- contextPath: DisableUser.UserProfile.Email
  description: The Email address of the user.
  type: String
script: '-'
system: false
timeout: '0'
type: python
subtype: python3
compliantpolicies:
  - User Hard Remediation
dockerimage: demisto/python3:3.12.13.10116658
fromversion: 6.10.0
tests:
- DisableUser - Test
marketplaces:
- xsoar
- marketplacev2
- platform