Set device login credentials API
Use the login setting endpoint of the Credential Vault API to update
the user name and password for a device. You can use this endpoint to set or update the
login credentials for your own device without additional permissions. To set or update the
login credentials on other users' devices, for example, to deploy bots on
unattended Bot Runners, you must have the AAE_admin role or a custom role
with the Bot Auto-Login Credentials API permission.
Request
To update the credentials for your own device, you only need the device
username and password:
PUT http://{{ControlRoolURL}}/v2/credentialvault/loginsettingRequest body:
{
"loginUsername":"aai\\jane.doe",
"loginPassword":"Automation123"
}To update the credentials for
another user's device, you must also include either the
username
or
userid
of that
user, as demonstrated in this code example:
{
"loginUsername":"aai\\jane.doe",
"loginPassword":"Automation123",
"username":"john-doe"
}Request Parameters
| Parameter | Type | Description |
|---|---|---|
| loginUsername | String | Enter the device login user name. |
| loginPassword | String | Enter the device login password. |
| username | String | Enter the user name of the user's device you want to update/set. |
Response
"Credentials updated for jane"Note: For an Control Room that is deployed on Cloud and has SAML authentication enabled, generate the web
token with your
username and apikey.