12 Managing Users, Groups, and Roles
This section describes the REST APIs to manage users, groups, and roles.
Table 12-1 Manage Users
| Task | Request | REST Resource |
|---|---|---|
| Add Users to an Identity Domain (v1) | POST | /interop/rest/security/<api_version>/users |
| Add Users to an Identity Domain (v2) | POST | /interop/rest/security/v2/users/add |
| Remove Users from an Identity Domain (v1) | DELETE | /interop/rest/security/<api_version>/users?filename=<filename> |
| Remove Users from an Identity Domain (v2) | POST | /interop/rest/security/v2/users/remove |
| Assign Users to a Predefined Role or Application Role (v1) | PUT | /interop/rest/security/<api_version>/users |
| Assign Users to a Predefined Role or Application Role (v2) | PUT | /interop/rest/security/v2/role/assign/user |
| Remove Users' Role Assignment (v1) | PUT | /interop/rest/security/<api_version>/users |
| Remove Users' Role Assignment (v2) | PUT | /interop/rest/security/v2/role/unassign/user |
| Add Users to a Group (v1) | PUT | /interop/rest/security/<api_version>/groups |
| Add Users to a Group (v2) | PUT | /interop/rest/security/v2/groups/adduserstogroup |
| Remove Users from a Group (v1) | PUT | /interop/rest/security/<api_version>/groups |
| Remove Users from a Group (v2) | PUT | /interop/rest/security/v2/groups/removeusersfromgroup |
| Update Users | PUT | /interop/rest/security/<api_verion>/users |
| Add a User to a Batch of Groups | PUT | /interop/rest/security/<api_version>/groups |
| Remove a User from a Batch of Groups | PUT | /interop/rest/security/<api_version>/groups |
| Add Groups (v1) | POST | /interop/rest/security/<api_version>/groups |
| Add Groups (v2) | POST | /interop/rest/security/v2/groups/add |
| Remove Groups (v1) | DELETE | /interop/rest/security/<api_version>/groups |
| Remove Groups (v2) | POST | /interop/rest/security/v2/groups/remove |
| User Group Report (v1) | POST | /interop/rest/security/<api_version>/usergroupreport |
| User Group Report (v2) | GET | /interop/rest/security/v2/report/usergroupreport |
| User Access Report (v1) | POST | /interop/rest/{api_version}/reports?q={type:provisionreport,fileName:provreport.csv,format=simplified,usertype=serviceusers} |
| User Access Report (v2) | POST | /interop/rest/v2/reports/useraccess |
| User Audit Report (v1) | POST | /interop/rest/{api_version}/reports?q={type:userauditreport,fileName:userauditreport.csv,since=2017-12-10,until=2018-06-10} |
| User Audit Report (v2) | POST | /interop/rest/v2/reports/useraudit |
| Role Assignment Report (v1) | POST | /interop/rest/security/{api_version}/roleassignmentreport |
| Role Assignment Report for Users (v2) | GET | /interop/rest/security/v2/report/roleassignmentreport/user?userlogin=<userlogin>&rolename=<rolename> |
| Role Assignment Report for Groups (v2) | GET | /interop/rest/security/v2/report/roleassignmentreport/group?groupname=<groupname>&rolename=<rolename> |
| Get Available Roles | GET | /interop/rest/security/v2/role/getavailableroles |
| Role Assignment Audit Report for OCI (Gen 2) Environments | PUT | /interop/rest/security/{api_version}/roleassignmentauditreport/ |
| Invalid Login Report for OCI (Gen 2) Environments | PUT | /interop/rest/security/{api_version}/invalidloginreport/ |
| Group Assignment Audit Report | POST | /interop/rest/{api_version}/reports/groupaudit |
| Adding Users to a Team for Account Reconciliation | POST | /armARCS/rest/{version}/jobs |
| Adding Users to a Team for Financial Consolidation and Close and Tax Reporting | POST | /HyperionPlanning/rest/{api_version}/applications/{application}/fcmjobs |
| Removing Users from a Team for Account Reconciliation | POST | /armARCS/rest/{version}/jobs |
| Removing Users from a Team for Financial Consolidation and Close and Tax Reporting | POST | /HyperionPlanning/rest/{api_version}/applications/{application}/fcmjobs |