Create a device with command string TL using the Rest API

book

Article ID: 103048

calendar_today

Updated On:

Products

CA Privileged Access Manager - Cloakware Password Authority (PA) PAM SAFENET LUNA HSM CA Privileged Access Manager (PAM)

Issue/Introduction

The information on the Settings > API Doc for the "POST /api.php/v1/devices.json" operation, specifically with regard to transparent login configurations using the Command String option, is not quite clear. It would be useful to have a sample JSON body showing how the parameters need to be entered. An example on how to configure access methods would be helpful as well.

Environment

PAM 3.X

Resolution

Below is a sample JSON body that will create a device with transparent login type "Command string", defining a few su commands for which PAM will insert a password transparently during an SSH access session. The example also shows how to configure access methods and tags for the device.

{
  "description":"RP RestApi test device",
  "targetServerDescription1":"Linux",
  "deviceAccessMethods":[
    {
      "port":"22",
      "type":"SSH",
      "customName":"",
      "taskProperty":null
    },
    {
      "port":"23",
      "type":"Telnet",
      "customName":"",
      "taskProperty":null
    }
  ],
  "transparentLoginType":"Command string",
  "transparentPrompts":{
    "commandStrings":["su","su -","su root","su - root"],
    "prompt":"Password:"
  },
  "deviceName":"rprestapidevice",
  "domainName":"rprestapidevice.ca.com",
  "os":"Linux",
  "targetServerDescription2":"RPResttsdesc",
  "typeAccess":"t",
  "typePassword":"t",
  "tags":[
    "Linux",
    "Provisioned"
  ]
}