Managing and Migrating Groups permission via REST API

Products

• CA Release Automation - Release Operations Center (Nolio)
• CA Release Automation - DataManagement Server (Nolio)

Issue/Introduction

CA Release Automation (CARA) have its public REST API, which can be used for various management and administration activity without login to Web-Interface. In this documents we are going to brief on REST API for Managing and Migrating Users permission.

Environment

Release : 6.6 or higher

Component : CA RELEASE AUTOMATION RELEASE OPERATIONS CENTER

Resolution

Note: Each REST API requires a basic authentication. The request should be having authentication token for invoking the API.

REST API Swagger: http://NAC-IP:NAC-PORT/datamanagement/apis/public.html

Get Users Groups:

• Request Method: GET
• API Version: v5
• API: /administration/v5/user-groups
• Example: http://NAC-IP:NAC-PORT/datamanagement/ra/administration/v5/user-groups

Get Group Permissions:

(The other query parameter can be used in this requests are application=My and applicationId)

• Request Method: GET
• API Version: v5
• API: /administration/v5/user-groups/{groupId}/permissions/applications
• Example: http://NAC-IP:NAC-PORT/datamanagement/ra/administration/v5/user-groups/5/permissions/applications

Create a New Group:

• Request Method: POST
• API Version: v5
• API: /administration/v5/user-groups
• Example: http://NAC-IP:NAC-PORT/ /datamanagement/ra/administration/v5/user-groups
• Example Request Body:

{
  "role": 
   {
       "type": "user",
       "applicationCreator": false,
       "artifactsManager": false
   },
      "isLdap": false,
      "name": "groupname4",
      "ldap": false
}

Add Users to Groups:

• Request Method: PUT
• API Version: v5
• API: /administration/v5/user-groups
• Example: http://NAC-IP:NAC-PORT/datamanagement/ra/administration/v5/user-groups
• Example Request Body:

{
  "groupIds": [
    7
  ],
  "userIds": [
    17,18
  ]
}

Update Group Permission:

• Request Method: PATCH
• API Version: v5
• API: administration/v5/user-groups/permissions/applications
• Example: http://NAC-IP:NAC-PORT/datamanagement/ra/administration/v5/user-groups/permissions/applications
• Example Request Body:

{
  "groupIds": [
    5
  ],
   "list": [
        {
            "owner": false,
            "canView": true,
            "designer": false,
            "publisher": false,
            "designViewer": false,
            "canExecuteProcessesInAllEnvironments": false,
            "canApproveReleasesInAllEnvironments": false,
            "canExecuteReleasesInAllEnvironments": false,
            "environmentPermissions": [
                {
                    "admin": false,
                    "templateCategoriesCanDeploy": [],
                    "canExecuteAllProcesses": true,
                    "releaseDesigner": false,
                    "processesCanExecute": [],
                    "canExecuteAllReleases": false,
                    "canApproveAllReleases": true,
                    "name": "Environment for Single Server Architecture",
                    "id": "2"
                }
            ],
            "deploymentPlanDesigner": true,
            "canViewExecutionComponents": false,
            "releasesTemplateDesigner": true,
            "name": "Test Application",
            "id": "3"
        },

        {
            "owner": false,
            "canView": true,
            "designer": true,
            "publisher": false,
            "designViewer": true,
            "canExecuteProcessesInAllEnvironments": false,
            "canApproveReleasesInAllEnvironments": true,
            "canExecuteReleasesInAllEnvironments": true,
            "deploymentPlanDesigner": false,
            "canViewExecutionComponents": false,
            "releasesTemplateDesigner": false,
            "name": "My",
            "id": "4"
        }
    ]
}

Delete User Groups:

• Request Method: DELETE
• API Version: v5
• API: /administration/v5/user-groups/{userGroupId}
• Example: http://NAC-IP:NAC-PORT/ datamanagement/ra/administration/v5/user-groups/21

Additional Information

• REST API Reference official documentation