Read and Review Automation Anywhere Documentation

Automation 360

Close Contents

Contents

Open Contents

Create a new user API

  • Updated: 7/27/2021
    • Automation 360 v.x
    • Manage
    • RPA Workspace
    • API docs

Create a new user API

Use the Create user API to create a new user in the Control Room.

Prerequisites

View and manage users and roles

Authenticate with a user that has the following ADMINISTRATION permissions:

  • View users

    You need an administrator permission to create and manage users and roles. It is recommended that non-administrator users be given limited permissions for creating and managing users. Learn how to create a role with limited permissions that can be assigned to users.

  • Create users

    Create new users in the Control Room.

  • Edit users

    Edit all users in the Control Room, including users created by other administrators.

  • Delete users

    Delete any user in the Control Room.

  • View roles

    Users with this permission can view roles to which they have access.

  • Manage roles

    Users can create, edit and delete roles to which they have access.

  • View licenses

    Users with these permissions are able to view and manage device licenses. Device licenses are required to enable users to perform specific tasks. For example, Bot Creators require a DEVELOPMENT device license in order to create bots.

  • Manage users device license

    Users with this permission can assign device licenses to other users.

Minimum required parameters
  • Roles: Each user must have at least one role.

    Role based accessibility enables appropriate access to relevant data and actions.

    In the request body, we assigned this permission AAE_Basic (ID: 2)

    Roles and permissions

  • username: String (255 max)
  • email: Must conform to standard email format (username@domain.com)
  • password: String: 8-15 characters in length. Allowable characters: a-z, A-Z, 0-9, @, -, _, !, #, $, %, &, and . (period)
Optional parameters
  • "enableAutoLogin": true
  • "username": "AnyUser"
  • "firstName": "Tester"
  • "lastName": "Writer"
  • "email": "username@mydomain.com"
  • "password": "anypassword"
  • "description": "Testing User Management APIs"
  • "deviceCredentialAttested": true
  • "licenseFeatures": [ DEVELOPMENT, CITIZENDEVELOPER, RUNTIME, ATTENDEDRUNTIME, AARIUSER, DISCOVERYBOTANALYZER, DISCOVERYBOTRECORDER, ANALYTICSCLIENT, ANALYTICSAPI ]

    Users can be created without an assigned device license. There are Roles and permissions that enable privileges for specific users and roles.

  • URL: http://<your_control_room_url>/v1/usermanagement/users

    Replace the content in the angle brackets with your Control Room URL.

  • Method: POST
  • Use the Swagger installed with your Control Room to test the APIs. View the available APIs at: http://<your_control_room_url>/swagger/
  • You can also use a REST client to complete this task.

Procedure

  1. Add the authentication token to the request header.
  2. Use the POST method and endpoint URL:<your_control_room_url>/v1/usermanagement/users
  3. In the request body, enter the mandatory and optional parameters.
    For SAML-based single sign-on (SSO) or Active Directory (AD) access, the password is not required. The password is mandatory for a database authentication.

    Request body :

    {
     {
      "roles": [
        {
          "id": 2
        }
      ],
      "domain": "string",
      "email": "ad@ma.com",
      "enableAutoLogin": true,
      "username": "mdadmin1",
      "firstName": "MDadmin2",
      "lastName": "ADadmin",
      "description": "string",
      "disabled": true,
      "password": "changeme",
      "licenseFeatures": [
        "DEVELOPMENT"
      ]
    }
    
  4. Send the request.
    Response body:
    {
        "id": 2075,
        "username": "mdadmin1",
        "domain": "string",
        "firstName": "MDadmin2",
        "lastName": "ADadmin",
        "version": 0,
        "principalId": 2075,
        "deleted": false,
        "roles": [
            {
                "name": "AAE_Basic",
                "id": 2,
                "version": 0
            }
        ],
        "sysAssignedRoles": [],
        "groupNames": [],
        "permissions": [
            {
                "id": 7526,
                "action": "viewuserrolebasicinfo",
                "resourceId": null,
                "resourceType": "usermanagement"
            },
            {
                "id": 7,
                "action": "run",
                "resourceId": null,
                "resourceType": "repositorymanager"
            },
            {
                "id": 94,
                "action": "view",
                "resourceId": null,
                "resourceType": "botstore"
            },
            {
                "id": 61,
                "action": "createstandard",
                "resourceId": null,
                "resourceType": "credentialattribute"
            },
            {
                "id": 92,
                "action": "view",
                "resourceId": null,
                "resourceType": "packagemanager"
            },
            {
                "id": 97,
                "action": "register",
                "resourceId": null,
                "resourceType": "devices"
            },
            {
                "id": 29,
                "action": "view",
                "resourceId": null,
                "resourceType": "repositorymanager"
            },
            {
                "id": 120,
                "action": "view",
                "resourceId": null,
                "resourceType": "dashboard"
            }
        ],
        "licenseFeatures": [
            "DEVELOPMENT"
        ],
        "emailVerified": false,
        "passwordSet": false,
        "questionsSet": false,
        "enableAutoLogin": true,
        "disabled": true,
        "clientRegistered": false,
        "description": "string",
        "createdBy": 1513,
        "createdOn": "2020-11-20T20:17:26Z",
        "updatedBy": 1513,
        "updatedOn": "2020-11-20T20:17:26Z",
        "publicKey": null,
        "appType": null,
        "routingName": null,
        "appUrl": null,
        "email": "ad@ma.com"
    }
    The REST API responds to each request with an HTTP response code. For details about the response codes, see API response codes.
Send Feedback