API v2: UAG - Generating RDP Configuration 🆕¶

Data Structures¶

`RdpConfigModel`¶
Attribute	Type	Required	Description
`host`	string	yes	Destination host.
`port`	number	yes	Connection port.
`otp`	string	yes	One-time password for RDP connection.
`app`	string		RemoteApp name (if applicable).
`suffix`	string		Optional suffix for session URL.
`safe_id`	string		Identifier of the Safe.

Request for Retrieving Available Attributes of the RdpConfigModel¶

Request

Method	`GET`
Path	`/api/v2/objspec/rdp_config`

GET /api/v2/objspec/rdp_config

Example Request

curl -s -k -X GET \
  -H 'Authorization: sgfeea6jsaz4mum9su8w6' \
  'https://10.0.214.98/api/v2/objspec/rdp_config'

Generate RDP Configuration¶

Request

Method	`POST`
Path	`/api/v2/safe/rdp_config`
Headers	`Content-Type: application/json`
Body	`RdpConfigModel`

POST /api/v2/safe/rdp_config

Example Request

curl -s -k -X POST \
    -H 'Authorization: sgfeea6jsaz4mum9su8w6' \
    -H 'Content-Type: application/json' \
    https://10.0.0.1/api/v2/safe/rdp_config \
    -d '{
      "host": "10.31.116.195",
      "port": 3389,
      "otp": "80434736wemPxwmZnKsC8wQxjbUZ3axv",
      "app": "8169529724050079745",
      "suffix": "remoteapp-account",
      "safe_id": "8169529724050079745"
    }'

Note

The one-time password (otp) required in this request can be generated using the POST /api/v2/secret/otp endpoint. For more information, refer to the API v2: UAG - OTP Generation 🆕 section.

Response

full address:s:10.31.116.195:3389
username:s:80434736wemPxwmZnKsC8wQxjbUZ3axv
prompt for credentials:i:1
password:s:
remoteapplicationmode:i:1
remoteapplicationprogram:s:remoteapp:8169529724050079745%