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, Oracle Sales Planning Cloud, and Oracle Strategic Workforce Planning Cloud.

Required Roles

Service Administrator

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.
    • If you are removing the assignment of users to predefined roles, ROLE should identify a predefined role applicable to the service. See Understanding Predefined Roles in Getting Started with Oracle Enterprise Performance Management Cloud for Administrators .

      Acceptable values for services other than Oracle Enterprise Data Management Cloud:

      • Service Administrator
      • Power User
      • User (do not use Planner, which was used in earlier versions of the service)
      • Viewer

      Acceptable values for Oracle Enterprise Data Management Cloud:

      • Service Administrator
      • User
    • If you are removing the assignment of users to an application role, ROLE should identify an application role listed in the Roles tab of Access Control.

      Acceptable values for Planning, Planning Modules, FreeForm, Sales Planning, Strategic Workforce Planning Financial Consolidation and Close, and Tax Reporting applications:

      • Approvals Administrator
      • Approvals Ownership Assigner
      • Approvals Supervisor
      • Approvals Process Designer
      • Ad Hoc Grid Creator
      • Ad Hoc Read Only User
      • Ad Hoc User
      • Calculation Manager Administrator
      • Create Integration
      • Drill Through
      • Run Integration
      • Mass Allocation
      • Task List Access Manager

      Acceptable values for Account Reconciliation applications:

      • Manage Alert Types
      • Manage Announcements
      • Manage Data Loads
      • Manage Organizations
      • Manage Periods
      • Manage Profiles and Reconciliations
      • Reconciliation Manage Currencies
      • Reconciliation Manage Public Filters and Lists
      • Reconciliation Manage Reports
      • Reconciliation Manage Teams
      • Reconciliation Manage Users
      • Reconciliation Commentator
      • Reconciliation Preparer
      • Reconciliation Reviewer
      • Reconciliation View Jobs
      • Reconciliation View Profiles
      • View Audit
      • View Periods

      Acceptable values for Oracle Enterprise Data Management Cloud

      • Application Creator
      • Auditor
      • View Creator

      Acceptable values for Enterprise Profitability and Cost Management applications

      • Ad Hoc Grid Creator
      • Ad Hoc Read Only User
      • Ad Hoc User
      • Clear POV Data
      • Copy POV Data
      • Create/Edit Rule
      • Create Integration
      • Create Model
      • Create POV
      • Create Profit Curve
      • Delete Calculation History
      • Delete Model
      • Delete POV
      • Delete Rule
      • Drill Through
      • Edit POV Status
      • Edit Profit Curve
      • Mass Edit of Rules
      • Run Calculation
      • Run Integration
      • Run Profit Curve
      • Run Rule Balancing
      • Run Trace Allocation
      • Run Validation
      • View Calculation History
      • View Model
      For a description of these roles, see Managing Role Assignments at the Application Level in Administering Access Control for Oracle Enterprise Performance Management Cloud .

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"