Managing and Migrating Users 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 All Users:

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

Get User:

• Request Method: GET
• API Version: v5
• API: /administration/v5/users/{userId}
• Example: http://NAC-IP:NAC-PORT/datamanagement/ra/administration/v5/users/21

Create a New User:

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

For role Superuser
{
"role": {
        "type": "superuser"
      },
      "username": "apiuser2",
      "password": "password",
      "email": "[email protected]",
      "firstName": "apiuser1",
      "lastName": "user1",
      "isLocalUser": true
    }
}

For role User
{
"role": {
        "type": "user",
        "applicationCreator": false,
        "artifactsManager": false
      },
      "username": "apiuser2",
      "password": "password",
      "email": "[email protected]",
      "firstName": "apiuser1",
      "lastName": "user1",
      "isLocalUser": true
    }
}

For role Administrator
{
      "role": {
        "type": "administrator",
        "securityAdministrator": true,
        "serversAdministrator": true,
        "generalAdministrator": true
      },
      "username": "testadmin",
      "password": "password",
      "email": "[email protected]",
      "firstName": "testadmin",
      "lastName": "admin",
      "isLocalUser": true,
    }

Update User Permission:

• Request Method: PATCH
• API Version: v5
• API: /administration/v5/users/{userId}
• Example: http://NAC-IP:NAC-PORT/ datamanagement/ra/administration/v5/users/21
• Example Request Body:

{
  "role": {
    "type": "administrator",
    "securityAdministrator": false,
    "serversAdministrator": true,
    "generalAdministrator": true
  },
  "password": "***",
  "email": "[email protected]",
  "firstName": "testadmin",
  "lastName": "admin",
  "isLocalUser": true
}

Delete User:

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

Additional Information

• REST API Reference official documentation