Read and Review Automation Anywhere Documentation

Automation 360

Close Contents

Contents

Open Contents

Set device login credentials API

  • Updated: 1/25/2021
    • Automation 360 v.x
    • Manage
    • RPA Workspace
    • API docs

Set device login credentials API

Use the login setting endpoint of the Credential Vault API to programatically update the username and password for a device.

Prerequisites

Note: You can view the Control Room APIs in the Community Edition, but API functionality is limited. You need a licensed Automation 360 Edition to access the full functionality of the APIs.
  • Use the Authentication API to generate a JSON Web Token. See Authentication API.
  • 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.

Procedure

  1. Use the PUT method and endpoint URL: <control_room_URL>/v2/credentialvault/loginsetting.
    Request body:
    Note: If the username includes a domain, use a double backslash between the domain and user.
    {
     "loginUsername": "aai\\katherine.johnson",
     "loginPassword": "{{password}}"
    }
  2. Send the request.
    Response body:
    "Credentials updated for katherine"
    The REST API responds to each request with an HTTP response code. For details about the response codes, see API response codes.
Send Feedback