Export Security

Exports the security records or access control list (ACL) records for specified users or groups to a Comma Separated Values (CSV) file. For information about access permissions to application artifacts, see Setting Up Access Permissions.

Using this REST API requires prerequisites, such as understanding how to use jobs. See Prerequisites. Be sure that you understand how to use jobs as described in Managing Jobs.

Required Roles

Service Administrator

Request

Supported Media Types: application/json

Parameters

The following table summarizes the client request parameters specific to this job. For additional parameters that are common to all jobs, see Execute a Job.

Table 8-25 Parameters

Name	Description	Required	Default
jobType	Export Security	Yes	None
jobName	The name of this job. Example: ExportSecurity	No	Export Security
fileName	The name of the file to which records should be exported. The file containing the exported data is stored in the Planning repository. If fileName is not specified, a file is auto-generated with a name containing the user name, current date, and time stamp. For example, test_admin_SecurityRecords_2019-02-26-04-34-45-420.csv.	No	The file name is auto-generated
exportUsers	Comma separated user names. Only ACL records related to the specified users are exported.	No	None
exportGroups	Comma separated user names. Only ACL records related to the specified groups are exported.	No	None

Notes:

• This job can take only exportGroups or exportUsers at one time. If you need to export groups and users, you must run the job twice, once with each parameter.
• If a user name or group name contains a comma, escape the comma in the request. For example, if a user name is test,User, the request should contain test\\,User.
• For the file format, see the definition in Import Security Records.

For a sample URL, see Sample URL and Payload in Execute a Job.

Sample Payload

Example 1: Exports all security records to the ExportSecurityRecordsFile.csv file.

{
    "jobType": "Export Security",
    "jobName": "ExportSecurity",
    "parameters": {
        "fileName": "ExportSecurityRecordsFile.csv"
    }
}

Example 2: Exports security records of two groups, group1 and group2, to the ExportSecurityRecordsFile.cv file.

{
    "jobType": "Export Security",
    "jobName": "ExportSecurity",
    "parameters": {
        "exportGroups": "group1,group2"
        "fileName": "ExportSecurityRecordsFile.csv"
    }
}

Example 3: Exports security records of two users, test1 and test,User2 to the ExportSecurityRecordsFile.csv file. Note that one user name contains a comma in it.

{
    "jobType": "Export Security",
    "jobName": "ExportSecurity",
    "parameters": {
        "exportUsers": "test1,test\\,User2"
        "fileName": "ExportSecurityRecordsFile.csv"
    }
}