Copy User Settings

Prev Next
Post
/sys-rest-api/jersey/v1/copyusersettings

UI Location: SYSTEM DATA - Security- Users- User Maintenance
postman-to-openapi

Body Parameters
The POST request copies user settings from a source user to a destination user based on the provided payload. The payload includes various fields such as DestUser, SrcUser, CopyUserSecurity, ConfigGroups, Roles, SystemPrivileges, ConfigPrivileges, ConfigPrivilegesEdit, ConsolidationSecurity, CompanyAccess, DepartmentAccess, JobAccess, EmployeeAccess, ComplianceAccess, and UserDefaults.

Request Body

Field Description Data Type Required Example Value
DestUser Destination User string True ADAM1
SrcUser Source User string True SARA1
CopyUserSecurity Copy User Security string False Must be "Y" or "N"
ConfigGroups Configuration Groups string False Must be "Y" or "N"
Roles Roles string False Must be "Add" or "Replace"
SystemPrivileges System Privileges string False Must be "Add" or "Replace"
ConfigPrivileges Configuration Privileges string False Must be "Add" or "Replace"
ConfigPrivilegesEdit Configuration Privileges Editing Details string False Must be "Add" or "Replace"
ConsolidationSecurity Consolidation Security string False Must be "Add" or "Replace"
CompanyAccess Company Access string False Must be "Add" or "Replace"
DepartmentAccess Department Access string False Must be "Add" or "Replace"
JobAccess Job/Project Access string False Must be "Add" or "Replace"
EmployeeAccess Employee Access string False Must be "Add" or "Replace"
ComplianceAccess Compliance Access string False Must be "Add" or "Replace"
UserDefaults Copy User Defaults string False Must be "Add" or "Replace"

Sample Response Body

Settings have been successfully copied from SARA1 to ADAM1

Important Information:

  • PM default settings will not be copied if the number of Project Management licenses has already been reached.

  • When choosing "Replace" for company access, the existing department and job/project security groups will be deleted first.

  • If the CompanyAccess setting is excluded from the request payload, the DepartmentAccess and JobAccess settings will be ignored, even if their values are set to "Add" or "Replace".

  • If the CopyUserSecurity setting is set to "N" or omitted from the payload, all other security-related attributes (Roles, Privileges, Access settings,...) will be ignored, and only the UserDefaults setting will be applied.

Security
HTTP
Type basic

Basic authentication

Header parameters
Content-Type
string
Exampleapplication/vnd.oracle.adf.resourceItem+json
Body parameters
object
Example{ "DestUser": "ADAM1", "SrcUser": "SARA1", "CopyUserSecurity": "Y", "ConfigGroups": "Y", "Roles": "Replace", "SystemPrivileges": "Add", "ConfigPrivileges": "Add", "ConfigPrivilegesEdit": "Add", "ConsolidationSecurity": "Add", "CompanyAccess": "Add", "DepartmentAccess": "Replace", "JobAccess": "Replace", "EmployeeAccess": "Replace", "ComplianceAccess": "Add", "UserDefaults": "Replace" }
Responses
200

OK

Headers
Content-Type
string
Exampleapplication/json
{
  "error": "Settings have been successfully copied from SARA1 to ADAM1"
}
object
Copyright © 2024 CMiC All Rights Reserved