POST Add User Proxy

The Add User Proxy API is used to add a new proxy definition.

Method	URI
`POST`	/cdwebconsole/svc/userproxies

The following example shows the Command:

curl -X 'POST' \
  'https://172.20.185.95:9443/cdwebconsole/svc/userproxies' \
  -H 'Authorization: eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJhZG1pbmlzdHJhdG9yOjE3Mi4yMC4xODUuOTU6MTM2Mzo5MWEyNDVlZC1iYTA1LTQ5NWQtYWFjNy1mYmJkNzE4ODY5NDAiLCJleHAiOjE3MTUwNzkxMTh9.7kqYDA0PRUTBvgM4YfsTAZQTppCRYoutNobIkZ3xxMkHKQTOsgwVnOnYBFVImx4mPcOy_zHZQgWAgBzqMK4kgQ' \
  -H 'Content-Type: application/json' \
  -H 'X-XSRF-TOKEN: 6aa1810c-9e3f-47d1-816e-d813a7c63f5a' \
  -d '{"proxyName":"Test@CD595W","localUserId":"Test1","localPassword":"","authorizedToUpload":"yes","authorizedToDownload":"yes","fileDownloadDirectory":"","processDirectory":"","programDirectory":"","fileUploadDirectory":"","authorizedToRunProcessUsingProxyServiceAccount":"","authorizedToPswdExit":""}'

Table 1. Input Parameters
Parameter Name	Required/Optional	Description	Valid values
`proxyName`	`Required`	Specifies the proxyName in form of UserName@NodeName.
`localUserId`	`Required`	The local user ID to map to the remote node or a specific user ID
`localPassword`	`Optional`	The password associated with the local user ID to which the proxy is mapped.
`authorizedToUpload`	`Required`	Specifies the upload permissions for proxy user. *Mandatory for Connect:Direct for Unix only	For Windows: Valid values : yes or no or user. Default value : yes For Unix: Valid values : y or n.
`authorizedToDownload`	`Required`	Specifies the download permissions for proxy user.	For Windows: Valid values : yes or no or user. Default value : yes For Unix: Valid values : y or n.
`fileDownloadDirectory`	`Optional`	Specifies directory the user can use to copy files to and use as destination directory. If no directory is specified, restriction defaults to the local user ID specified for the proxy. Note: To reset the value, use None in update(put) request.
`processDirectory`	`Optional`	Specifies directory containing the Processes the user has authority to submit. If no directory is specified, restriction defaults to the local user ID specified for the proxy. Note: To reset the value, use None in update(put) request.
`programDirectory`	`Optional`	Specifies directory containing the programs the user has authority to run. If no directory is specified, restriction defaults to the local user ID specified for the proxy. Note: To reset the value, use None in update(put) request.
`fileUploadDirectory`	`Optional`	Specifies directory the user can use to copy files from and use as a source directory. If no directory is specified, restriction defaults to the local user ID specified for the proxy. Note: To reset the value, use None in update(put) request.
`authorizedToRunProcessUsingProxyServiceAccount`	`Optional`	Specifies to run process using proxy service account.	Valid values : yes or no or user. Default value : no
`authorizedToPswdExit`	`Optional`	Specifies to allow own plugin to manage password.	Valid values : yes or no or user. Default value : user

The following example shows the HTTP User Request:

{
 "proxyName": "Test@CD595W",
 "localUserId": "Test1",
 "localPassword": "",
 "authorizedToUpload": "yes",
 "authorizedToDownload": "yes",
 "fileDownloadDirectory": "",
 "processDirectory": "",
 "programDirectory": "",
 "fileUploadDirectory": "",
 "authorizedToRunProcessUsingProxyServiceAccount": "",
 "authorizedToPswdExit": ""
}

The following example shows the Sample Response:

[
  {
    "messageCode": 201,
    "message": "The User Proxy has been successfully added"
  }
]