removeUsersFromGroup

Removes users listed in an ANSI or UTF-8 encoded CSV file from a group maintained in Access Control.

The file format is as follows:

User Login
jdoe
john.doe@example.com

User Login values are not case-sensitive. For example, jane.doe@example.com is treated as being identical to Jane.Doe@Example.com or any variation in its case. Use the uploadFile command to upload the file containing user logins to the environment.

When the command execution finishes, EPM Automate prints information about each failed entry to the console. Review this information to understand why the command execution failed for some entries in the CSV file.

Applies to

Planning, Planning Modules, FreeForm, Financial Consolidation and Close, Tax Reporting, Profitability and Cost Management, Enterprise Profitability and Cost Management,Oracle Enterprise Data Management Cloud, Narrative Reporting, Oracle Sales Planning Cloud, and Oracle Strategic Workforce Planning Cloud.

Required Roles

Service Administrator

Usage

epmautomate removeUsersFromGroup FILE_NAME GROUP_NAME where:
  • FILE_NAME is the name of a CSV file containing the login names of users you want to remove from a group maintained in Access Control.
  • GROUP_NAME is the name of the Access Control group from which you want to remove users. This value is not case-sensitive.

Note:

User is removed from a group only if both these conditions are met:
  • User logins included in the file exist in the identity domain that services the environment
  • The user is assigned to a predefined role in the identity domain

Example

epmautomate removeUsersFromGroup user_file.CSV example_group