User Management API

deviceCredentialAttested (optional)

Boolean any device credentials that are associated with the user

example: false

multipleLoginAllowed (optional)

Boolean allow multiple login for this user

example: true

roleIds (optional)

array[BigDecimal] Specify all the allocated role ids

example: [133,170]

`CreateUserResponse` Up

domain (optional)

String ActiveDirectory(LDAP) domain

example: AD-DOMAIN

email (optional)

String Email ID of the user

example: xyz@automationanywhere.com

enableAutoLogin (optional)

Boolean enable the user to login automatically. Set True or False.

username (optional)

String User login

example: bot_creator

firstName (optional)

String first name of the user

example: Mike

lastName (optional)

String last name of the user

example: Bot

description (optional)

String add a description associated with the user

example: User to run bots

disabled (optional)

Boolean Enable or disable the user with True or False

example: true

password (optional)

String only for create\update

emailVerified (optional)

passwordSet (optional)

Boolean this flag indicate that user set his password

questionsSet (optional)

Boolean this flag indicate that user set questions and answer

licenseFeatures (optional)

deviceCredentialAttested (optional)

Boolean any device credentials that are associated with the user

example: false

multipleLoginAllowed (optional)

Boolean allow multiple login for this user

example: true

clientRegistered (optional)

Boolean client/device is registered flag

createdBy (optional)

String Id of the user who created the object

example: 21

createdOn (optional)

String Creation date of the object

example: 2022-10-28T00:15:09.319997Z

updatedBy (optional)

String Id of the user who made a latest update on the object

example: 21

updatedOn (optional)

String Date when it was the latest update of the object

example: 2022-10-28T00:15:09.319999Z

version (optional)

String Version of the object, has to be provided by the client to track simultaneous updates

example: 0

deleted (optional)

lastLoginTime (optional)

String The timestamp of the user when last logged in

example: 2022-11-28T20:21:39.586090Z

apiKeyCreatedOn (optional)

String The timestamp when API key was created

example: 2022-07-25T20:21:39.586090Z

apiKeyExpirationTime (optional)

String The timestamp when API key will be expired

example: 2021-11-07T20:21:39.586090Z

roles (optional)

permissions (optional)

sysAssignedRoles (optional)

array[Long] Specify all the system assigned role ids format: int64

example: [133,170]

groupNames (optional)

array[String] Name of the group to which user is tagged to

example: ["adDirectory_Admin"]

routingName (optional)

publicKey (optional)

appType (optional)

`DeleteUserByIdResponse` Up

domain (optional)

String ActiveDirectory(LDAP) domain

example: AD-DOMAIN

email (optional)

String Email ID of the user

example: xyz@automationanywhere.com

enableAutoLogin (optional)

Boolean enable the user to login automatically. Set True or False.

username (optional)

String User login

example: bot_creator

firstName (optional)

String first name of the user

example: Mike

lastName (optional)

String last name of the user

example: Bot

description (optional)

String add a description associated with the user

example: User to run bots

disabled (optional)

Boolean Enable or disable the user with True or False

example: true

password (optional)

String only for create\update

emailVerified (optional)

passwordSet (optional)

Boolean this flag indicate that user set his password

questionsSet (optional)

Boolean this flag indicate that user set questions and answer

licenseFeatures (optional)

deviceCredentialAttested (optional)

Boolean any device credentials that are associated with the user

example: false

multipleLoginAllowed (optional)

Boolean allow multiple login for this user

example: true

clientRegistered (optional)

Boolean client/device is registered flag

createdBy (optional)

String Id of the user who created the object

example: 21

createdOn (optional)

String Creation date of the object

example: 2022-10-28T00:15:09.319997Z

updatedBy (optional)

String Id of the user who made a latest update on the object

example: 21

updatedOn (optional)

String Date when it was the latest update of the object

example: 2022-10-28T00:15:09.319999Z

version (optional)

String Version of the object, has to be provided by the client to track simultaneous updates

example: 0

deleted (optional)

lastLoginTime (optional)

String The timestamp of the user when last logged in

example: 2022-11-28T20:21:39.586090Z

apiKeyCreatedOn (optional)

String The timestamp when API key was created

example: 2022-07-25T20:21:39.586090Z

apiKeyExpirationTime (optional)

String The timestamp when API key will be expired

example: 2021-11-07T20:21:39.586090Z

roles (optional)

permissions (optional)

sysAssignedRoles (optional)

array[Long] Specify all the system assigned role ids format: int64

example: [133,170]

groupNames (optional)

array[String] Name of the group to which user is tagged to

example: ["adDirectory_Admin"]

routingName (optional)

publicKey (optional)

appType (optional)

`Error` Up

code (optional)

String Error code

message (optional)

String Message describing error

details (optional)

String More details of the error message

`Filter` Up

Filters the result based on operator, field, or value.

operator (optional)

String Operator

Enum:

NONE

lt

le

eq

ne

ge

gt

substring

and

or

not

example: and

operands (optional)

array[Filter]

field (optional)

String Filtering field can be either name, lastModified, path, or folder.

example: name

value (optional)

String Filter value

example: device

`FilterRequest` Up

Filter request, which includes filtering, sorting, and pagination rules.

filter (optional)

Filter

sort (optional)

array[Sort] Sort directions

page (optional)

PageRequest

`FindUserByIdResponse` Up

domain (optional)

String ActiveDirectory(LDAP) domain

example: AD-DOMAIN

email (optional)

String Email ID of the user

example: xyz@automationanywhere.com

enableAutoLogin (optional)

Boolean enable the user to login automatically. Set True or False.

username (optional)

String User login

example: bot_creator

firstName (optional)

String first name of the user

example: Mike

lastName (optional)

String last name of the user

example: Bot

description (optional)

String add a description associated with the user

example: User to run bots

disabled (optional)

Boolean Enable or disable the user with True or False

example: true

password (optional)

String only for create\update

emailVerified (optional)

passwordSet (optional)

Boolean this flag indicate that user set his password

questionsSet (optional)

Boolean this flag indicate that user set questions and answer

licenseFeatures (optional)

deviceCredentialAttested (optional)

Boolean any device credentials that are associated with the user

example: false

multipleLoginAllowed (optional)

Boolean allow multiple login for this user

example: true

clientRegistered (optional)

Boolean client/device is registered flag

createdBy (optional)

String Id of the user who created the object

example: 21

createdOn (optional)

String Creation date of the object

example: 2022-10-28T00:15:09.319997Z

updatedBy (optional)

String Id of the user who made a latest update on the object

example: 21

updatedOn (optional)

String Date when it was the latest update of the object

example: 2022-10-28T00:15:09.319999Z

version (optional)

String Version of the object, has to be provided by the client to track simultaneous updates

example: 0

deleted (optional)

lastLoginTime (optional)

String The timestamp of the user when last logged in

example: 2022-11-28T20:21:39.586090Z

apiKeyCreatedOn (optional)

String The timestamp when API key was created

example: 2022-07-25T20:21:39.586090Z

apiKeyExpirationTime (optional)

String The timestamp when API key will be expired

example: 2021-11-07T20:21:39.586090Z

roles (optional)

permissions (optional)

sysAssignedRoles (optional)

array[Long] Specify all the system assigned role ids format: int64

example: [133,170]

groupNames (optional)

array[String] Name of the group to which user is tagged to

example: ["adDirectory_Admin"]

routingName (optional)

publicKey (optional)

appType (optional)

`GetRoleV2Response` Up

id (optional)

BigDecimal Unique identifier representing a specific role

example: 264.0

name

String Name of the role

example: Finance role

description (optional)

String Description of the role

example: Finance role to manage the org finances

createdBy (optional)

BigDecimal Id of the user who created the role.

example: 10.0

createdOn (optional)

String The creation timestamp of the role.

example: 2022-11-21T16:22:02.697Z

updatedBy (optional)

BigDecimal Id of the user who last updated the role.

example: 10.0

updatedOn (optional)

String Timestamp when the role was last updated.

example: 2022-11-21T16:22:02.697Z

permissions (optional)

array[Permission] Collection of unique permissions that have been assigned to the role.

userIds (optional)

array[BigDecimal] An array of unique users that have been assigned to the role.

example: [21,8,32]

`GlobalPermission` Up

action (optional)

String The action that the user is allowed to perform

example: View

resourceType (optional)

String The resource on which the action is allowed

example: Settings

`LicenseFeature` Up

License feature

`PageRequest` Up

Pagination rules, allows you to filter based on desired page

offset (optional)

Integer Page starting index

total (optional)

Integer Total number of items to display

example: 100

totalFilter (optional)

Integer Total number of items matching filter

example: 100

`Permission` Up

id (optional)

BigDecimal The numeric value that uniquely identifies the permission.

example: 59.0

action (optional)

String The action the permission enables.

example: managecredentials

resourceId (optional)

String The resource id to which the action belongs.

resourceType (optional)

String The resource group to which the action belongs. Typically a user is given the role permission in conjunction with user management permission.

example: credentials

`Principal` Up

id (optional)

BigDecimal Unique identifier representing a principal

example: 3.0

username (optional)

String user login

example: Bot_manager

subjectId (optional)

String user id

example: 27

domain (optional)

String active directory domain, if Principal represents AD User

autoLoginEnabled (optional)

deleted (optional)

emailVerified (optional)

pwdExpired (optional)

`Role` Up

id (optional)

BigDecimal Unique identifier representing a specific role

example: 27.0

name (optional)

String Name of role

example: device_admin

description (optional)

String Description of role

example: This is a device admin role

countPrincipals (optional)

BigDecimal Count of Principals (users) who are granted with this role

example: 1.0

version (optional)

BigDecimal Version of the role instance

example: 1.0

createdBy (optional)

BigDecimal Id of the user who created the role

example: 27.0

createdOn (optional)

String Date when the role was created

example: 2022-11-21T16:22:02.697Z

updatedBy (optional)

BigDecimal Id of the user who made a latest update to the role

example: 29.0

updatedOn (optional)

String Date when it was the latest update made to the role

example: 2022-11-21T16:22:02.697Z

systemRole (optional)

Boolean Flag to indicate if this role is system role or not

example: false

`RoleBasic` Up

id (optional)

BigDecimal Unique identifier representing a specific role

name

String Name of role

`RoleBasicV2` Up

name

String Name of role

`RoleFilterResponse` Up

Filtered role list

page (optional)

PageRequest

list (optional)

array[Role]

`Sort` Up

By default, search results are sorted in descending order with respect to their IDs. An alternative sorting is specified by using the sort query parameter.

field (optional)

String Field name to sort by

example: name

direction (optional)

String Sorting direction

Enum:

asc

desc

`UpdateRoleV2Request` Up

name

String Name of the role

example: Trigger Manager

description (optional)

String Description of the role

example: View and Manage the triggers

permissions (optional)

array[Permission] An array of permissions that will be granted for the role. Each permission requires the mandatory parameters.

userIds (optional)

array[BigDecimal] An array/collection of user IDs who will be granted access with the role.

example: [23,8,7]

`UpdateRoleV2Response` Up

id (optional)

BigDecimal Unique identifier representing a specific role

example: 264.0

name

String Name of the role

example: Finance role

description (optional)

String Description of the role

example: Finance role to manage the org finances

createdBy (optional)

BigDecimal Id of the user who created the role.

example: 10.0

createdOn (optional)

String The creation timestamp of the role.

example: 2022-11-21T16:22:02.697Z

updatedBy (optional)

BigDecimal Id of the user who last updated the role.

example: 10.0

updatedOn (optional)

String Timestamp when the role was last updated.

example: 2022-11-21T16:22:02.697Z

permissions (optional)

array[Permission] Collection of unique permissions that have been assigned to the role.

userIds (optional)

array[BigDecimal] An array of unique users that have been assigned to the role.

example: [21,8,32]

`UpdateUserRequest` Up

username (optional)

String User login

example: bot_creator

firstName (optional)

String first name of the user

example: Mike

lastName (optional)

String last name of the user

example: Bot

domain (optional)

String ActiveDirectory(LDAP) domain

example: AD-DOMAIN

email (optional)

String Email ID of the user

example: xyz@automationanywhere.com

enableAutoLogin (optional)

Boolean enable the user to login automatically. Set True or False.

description (optional)

String add a description associated with the user

example: User to run bots

disabled (optional)

Boolean Enable or disable the user with True or False

example: false

password (optional)

String only for create\update

licenseFeatures (optional)

deviceCredentialAttested (optional)

Boolean any device credentials that are associated with the user

example: false

multipleLoginAllowed (optional)

Boolean allow multiple login for this user

example: true

roleIds (optional)

array[Long] Specify all the allocated role ids format: int64

example: [133,170]

`UpdateUserResponse` Up

domain (optional)

String ActiveDirectory(LDAP) domain

example: AD-DOMAIN

email (optional)

String Email ID of the user

example: xyz@automationanywhere.com

enableAutoLogin (optional)

Boolean enable the user to login automatically. Set True or False.

username (optional)

String User login

example: bot_creator

firstName (optional)

String first name of the user

example: Mike

lastName (optional)

String last name of the user

example: Bot

description (optional)

String add a description associated with the user

example: User to run bots

disabled (optional)

Boolean Enable or disable the user with True or False

example: true

password (optional)

String only for create\update

emailVerified (optional)

passwordSet (optional)

Boolean this flag indicate that user set his password

questionsSet (optional)

Boolean this flag indicate that user set questions and answer

licenseFeatures (optional)

deviceCredentialAttested (optional)

Boolean any device credentials that are associated with the user

example: false

multipleLoginAllowed (optional)

Boolean allow multiple login for this user

example: true

clientRegistered (optional)

Boolean client/device is registered flag

createdBy (optional)

String Id of the user who created the object

example: 21

createdOn (optional)

String Creation date of the object

example: 2022-10-28T00:15:09.319997Z

updatedBy (optional)

String Id of the user who made a latest update on the object

example: 21

updatedOn (optional)

String Date when it was the latest update of the object

example: 2022-10-28T00:15:09.319999Z

version (optional)

String Version of the object, has to be provided by the client to track simultaneous updates

example: 0

deleted (optional)

lastLoginTime (optional)

String The timestamp of the user when last logged in

example: 2022-11-28T20:21:39.586090Z

apiKeyCreatedOn (optional)

String The timestamp when API key was created

example: 2022-07-25T20:21:39.586090Z

apiKeyExpirationTime (optional)

String The timestamp when API key will be expired

example: 2021-11-07T20:21:39.586090Z

roles (optional)

permissions (optional)

sysAssignedRoles (optional)

array[Long] Specify all the system assigned role ids format: int64

example: [133,170]

groupNames (optional)

array[String] Name of the group to which user is tagged to

example: ["adDirectory_Admin"]

routingName (optional)

publicKey (optional)

appType (optional)

`UserDetails` Up

id (optional)

BigDecimal Unique identifier representing a specific permission

example: 110.0

roles (optional)

array[RoleBasic]

permissions (optional)

array[Permission]

licenseFeatures (optional)

principalId (optional)

BigDecimal

example: 110.0

domain (optional)

String ActiveDirectory(LDAP) domain

email (optional)

example: xyz@automationanywhere.com

emailVerified (optional)

passwordSet (optional)

Boolean this flag indicate that user set his password

questionsSet (optional)

Boolean this flag indicate that user set questions and answer

enableAutoLogin (optional)

username (optional)

String User login

example: bot_creator

firstName (optional)

example: Mike

lastName (optional)

example: Bots

description (optional)