unassignRole

Removes a role currently assigned to the users, including the user who runs this command, whose login IDs are included in the ANSI or UTF-8 encoded CSV file that is used with this command. You can use this command to remove the assignment of a predefined role or an application role.

Note:

You cannot use this command to remove application role assignments from Account Reconciliation and Profitability and Cost Management applications, which do not support the assigning of application roles to users.

The CSV file format is as follows:

User Login
jane.doe@example.com
jdoe

Use the uploadFile command to upload the file to the environment.

Note:

Use double quotation marks to enclose role names that contain the space character.

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, Account Reconciliation, Profitability and Cost Management, Enterprise Profitability and Cost Management, Oracle Enterprise Data Management Cloud, Narrative Reporting, Sales Planning, and Strategic Workforce Planning.

Required Roles

To remove predefined role assignments:

  • Classic environments: Identity Domain Administrator and any predefined role (Service Administrator, Power User, User or Viewer)
  • OCI environments: Service Administrator, or Identity Domain Administrator and any predefined role (Service Administrator, Power User, User, or Viewer)

To remove application role assignments: Service Administrator or Access Control Manager

Usage

epmautomate unassignRole FILE_NAME ROLE where:
  • FILE_NAME is the name of a CSV file containing the login IDs of the users whose role assignment is to be revoked. Specify the CSV extension in lower case.

    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.

  • ROLE identifies one of the following. Role names are not case-sensitive.

Examples

  • Unassign users from a predefined identity domain role:

    epmautomate unassignRole remove_roles.csv "Service Administrator"

  • Unassign users from an application role:

    epmautomate unassignRole example_file.csv "Task List Access Manager"