Read and Review Automation Anywhere Documentation

Automation 360

Close Contents

Contents

Open Contents

Update an existing user details API

  • Updated: 3/16/2021
    • Automation 360 v.x
    • Manage
    • RPA Workspace
    • API docs

Update an existing user details API

Use the Update user details API to update an existing user information in the Control Room.

Prerequisites

Ensure you have an admin role or a custom role with Edit Users permission.

Procedure

  1. Add the authentication token to the request header.
  2. Use the PUT method and endpoint URL:<your_control_room_url>/v1/usermanagement/users/744
  3. In the request header, add an existing user ID you want to update. To find a user ID you want to update, execute the Search for users API.
    If you want to add a new role ID to your request, perform the following steps:
    1. Execute the Search for users API. Use the POST method and endpoint URL: <your_control_room_url>/v1/usermanagement/users/list
    2. When you get all role IDs, add a new role to the existing role IDs. You will not able to add one role by itself, you must add it to the collection of role IDs.

    The following request body is for an existing user ID: 744 and the existing role IDs: 169, 2, and 26. Modify other parameters as needed.

    Request body

    {
        "roles": [
            {
                "id": 169
            },
            {
                "id": 2
            },
            {
                "id": 26
            }
        ],
        "email": "Joe.Smith@automationanywhere.com",
        "enableAutoLogin": false,
        "firstName": "FN",
        "lastName": "LN",
        "description": "test",
        "disabled": false,
        "licenseFeatures": [
            "RUNTIME"
        ]
    }
  4. Send the request.

    The response body returns the updated details for the user ID: 744.

    Response body:
    {
        "id": 744,
        "username": "cs_runner",
        "domain": null,
        "firstName": "FN",
        "lastName": "LN",
        "version": 60,
        "principalId": 744,
        "deleted": false,
        "roles": [
            {
                "name": "AAE_Basic",
                "id": 2,
                "version": 0
            },
            {
                "name": "cs_role2",
                "id": 169,
                "version": 3
            },
            {
                "name": "all",
                "id": 26,
                "version": 54
            }
        ],
        "sysAssignedRoles": [],
        "groupNames": [],
        "permissions": [
            {
                "id": 2912,
                "action": "upload",
                "resourceId": "34241",
                "resourceType": "repositorymanager"
            },
    ......................................................
    {
                "id": 4101,
                "action": "download",
                "resourceId": "34439",
                "resourceType": "repositorymanager"
            }
        ],
        "licenseFeatures": [
            "RUNTIME"
        ],
        "emailVerified": true,
        "passwordSet": true,
        "questionsSet": true,
        "enableAutoLogin": false,
        "disabled": false,
        "clientRegistered": false,
        "description": "test",
        "createdBy": 451,
        "createdOn": "2020-08-25T07:27:58Z",
        "updatedBy": 451,
        "updatedOn": "2021-03-16T17:15:19Z",
        "publicKey": null,
        "appType": null,
        "routingName": null,
        "appUrl": null,
        "email": "Joe.Smith@automationanywhere.com",
        "lastLoginTime": "2021-02-25T18:01:40Z",
        "deviceCredentialAttested": false
    }
    The REST API responds to each request with an HTTP response code. For details about the response codes, see API response codes.
Send Feedback