removePrincipals command

Edit online
Draft comment:
This topic only applies to BAW, and is located in the BAW repository. Last updated on 2025-03-13 12:15
The removePrincipals command removes a user or group from a project area. Users who are not assigned to a project area cannot log in to Case Builder.

Syntax

The following syntax includes line breaks to format the command for reading. Enter the command and options on a single line without any line breaks.
configmgr_cl removePrincipals -projectAreaName project_area_name
 -profile myprofile
 [-users user_name] [-groups group_name]
 [-silent] [-force] [-help]

Parameters

-projectAreaName project_area_name
Specifies the name of the project area. The default project area is named dev_env_connection_definition.
-profile myprofile
Specifies the profile to use. The myprofile value can be one of the following items:
  • The name of the profile, such as develop1. The profile is located in the install_root/CaseManagement/configure/profiles directory. install_root is the location where IBM® Business Automation Workflow is installed.
  • The full path to the profile directory, such as "install_root\CaseManagement\configure\profiles\develop1" or /install_root/CaseManagement/configure/profiles/develop1.
  • The full path to the profile input file, such as "install_root\CaseManagement\configure\profiles\develop1\develop1.cfgp" or /install_root/CaseManagement/configure/profiles/develop1/develop1.cfgp.
-users user_name

Specifies the short name or display name of the user to remove. A user can belong to the default project area and one other project area.

You can remove multiple users at one time by adding additional -users user_name entries on the same command.

You can omit this option if you are removing only groups.

-groups group_name

Specifies the short name or display name of the group that you want to remove. Groups can belong to the default project area only.

You can remove multiple groups at one time by adding additional -groups group_name entries on the same command.

You can omit this option if you are removing only users.

-silent
Optional: When you specify the -silent parameter, no prompts or informational messages are shown in the console, but the errors are written to the log. Failure messages and validation error messages are shown as needed, such as messages about missing passwords or invalid port numbers. If you run the execute command to run all the activities in a profile and you specify the -silent parameter, you must also specify the -force parameter.
-force
Optional and applies only when the -silent parameter is used. When you specify the -force parameter, the activity is run without pausing for required responses to validation error messages, such as messages about missing passwords or invalid port numbers.
-help
Optional: Shows a brief message on the command syntax instead of running the command.

Sample commands

The following examples include line breaks to format the command for reading. Enter the command and options on a single line without any line breaks.
Remove a single user.
The following command removes the user MariaG from the project area MyProjectArea in the MyDevelop1 profile:
configmgr_cl removePrincipals -projectAreaName MyProjectArea
 -profile MyDevelop1
 -users MariaG
Remove a group from the default project area.
The following command removes the group CaseDevelopers from the default project area in the MyDevelop1 profile:
configmgr_cl removePrincipals 
 -projectAreaName dev_env_connection_definition
 -profile MyDevelop1
 -groups CaseDevelopers
Remove several users from a project area.
The following command removes the users MariaG, BarneyF, and JoseP from the project area MyProjectArea in the MyDevelop1 profile:
configmgr_cl removePrincipals -projectAreaName MyProjectArea
 -profile MyDevelop1
 -users MariaG -users BarneyF -users JoseP
Remove several users and a single group from the default project area.
The following command removes the users MariaG, BarneyF, and JoseP and the group CaseDevelopers from the default project area in the MyDevelop1 profile:
configmgr_cl removePrincipals -projectAreaName 
  dev_env_connection_definition
 -profile MyDevelop1
 -users MariaG -users BarneyF -users JoseP
 -groups CaseDevelopers
Show the help for the removePrincipals command.
The following command shows the help for the removePrincipals command:
configmgr_cl removePrincipals -help