User
The User API allows you to search, create and edit existing users, as well as set their user configuration values.
Pagination and Listings
It is the organization the user is in.
It is the number of pages that will be returned, default value 0.
0Example: 1It is the number of users per page, default value 5.
5Example: 1It is the user attribute used for ordination the page, default attribute createdAt.
createdAtIt is the sorting type, default value DESC.
DESCIt is the parameter that contains the user data entry, that will be used to filter the users.
GET /org/{orgUUID}/users?page=0&linesPerPage=5&orderBy=createdAt&direction=DESC&searchTerms=text HTTP/1.1
Host:
Accept: */*
{
"totalPages": 1,
"totalElements": 1,
"pageable": {
"paged": true,
"pageNumber": 1,
"pageSize": 1,
"offset": 1,
"sort": {
"sorted": true,
"empty": true,
"unsorted": true
},
"unpaged": true
},
"numberOfElements": 1,
"size": 1,
"content": [
{
"name": "text",
"image": "text",
"environments": [
{
"role": "text",
"environment": {
"uuid": "text",
"name": "text"
}
}
],
"email": "text",
"company": "text",
"admin": true,
"orgUUID": "text",
"createdAt": "2025-07-10T20:33:21.399Z",
"rules": {
"deletable": true
},
"uuid": "text"
}
],
"number": 1,
"sort": {
"sorted": true,
"empty": true,
"unsorted": true
},
"first": true,
"last": true,
"empty": true
}It is the organization where the user is, used to filter the user by organization
It is the parameter used to search for users related to the entered value
It is the max number of result, default value 6
6Example: 6It is an identifier provided by the API client that will be used to identify distributed logs
GET /org/{orgUUID}/users/quicksearch?name=text HTTP/1.1
Host:
Accept: */*
[
"text"
]CRUD Operations
Performs user creation allowing access to the chosen environment and bots. The user is also registered with our Identity Provider
Is the organization that the user will be created.
It is an identifier provided by the API client that will be used to identify distributed logs.
The language that the email arriving for their created user will be. Possible values: 'en' - English 'es' - Spanish 'ja' - Japanese 'pt' - Portuguese
enA body containing all user data to be created, including the bots and environments the user has access to. See the template for instructions on how to build them.
Name of the user.
Image of the user.
Email of the user.
Company of the user.
Flag that identifies if the user is admin.
POST /org/{orgUUID}/users HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 177
{
"name": "text",
"image": "text",
"environments": [
{
"role": "text",
"environment": {
"uuid": "text",
"name": "text"
},
"bots": [
{
"uuid": "text"
}
]
}
],
"email": "text",
"company": "text",
"admin": true
}{
"name": "text",
"image": "text",
"environments": [
{
"role": "text",
"environment": {
"uuid": "text",
"name": "text"
},
"bots": [
{
"uuid": "text",
"name": "text",
"environmentUuid": "text",
"image": "text"
}
]
}
],
"email": "text",
"company": "text",
"admin": true,
"orgUUID": "text",
"createdAt": "2025-07-10T20:33:21.399Z",
"uuid": "text"
}It is the organization the user is in.
It is the user id that will be used in the search process.
GET /org/{orgUUID}/users/{userId} HTTP/1.1
Host:
Accept: */*
{
"name": "text",
"image": "text",
"environments": [
{
"role": "text",
"environment": {
"uuid": "text",
"name": "text"
},
"bots": [
{
"uuid": "text",
"name": "text",
"environmentUuid": "text",
"image": "text"
}
]
}
],
"email": "text",
"company": "text",
"admin": true,
"orgUUID": "text",
"createdAt": "2025-07-10T20:33:21.399Z",
"uuid": "text"
}Updated the user's base data and accesses the chosen environment and bots. The user is also up to date on our Identity Provider.
It is the organization the user is in.
It is the id that will be used to search the user in the database for the update.
It is an identifier provided by the API client that will be used to identify distributed logs.
A body containing all user data to be created, including the bots and environments the user has access to. See the template for instructions on how to build them.
Name of the user.
Image of the user.
Email of the user.
Company of the user.
Flag that identifies if the user is admin.
Password of the user.
Confirmation of the user's password, both must have the same value.
PUT /org/{orgUUID}/users/{userId} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 220
{
"name": "text",
"image": "text",
"environments": [
{
"role": "text",
"environment": {
"uuid": "text",
"name": "text"
},
"bots": [
{
"uuid": "text"
}
]
}
],
"email": "text",
"company": "text",
"admin": true,
"password": "text",
"confirmPassword": "text"
}{
"name": "text",
"image": "text",
"environments": [
{
"role": "text",
"environment": {
"uuid": "text",
"name": "text"
},
"bots": [
{
"uuid": "text",
"name": "text",
"environmentUuid": "text",
"image": "text"
}
]
}
],
"email": "text",
"company": "text",
"admin": true,
"orgUUID": "text",
"createdAt": "2025-07-10T20:33:21.399Z",
"uuid": "text"
}Service responsible for activating a deleted user, thus enabling the user's access to the system.
It is the organization the user is in.
It is an identifier provided by the API client that will be used to identify distributed logs.
The language that the email arriving for their created user will be. Possible values: 'en' - English 'es' - Spanish 'ja' - Japanese 'pt' - Portuguese
enA body containing all user data to be created, including the bots and environments the user has access to. See the template for instructions on how to build them.
Name of the user.
Image of the user.
Email of the user.
Company of the user.
Flag that identifies if the user is admin.
Password of the user.
Confirmation of the user's password, both must have the same value.
PUT /org/{orgUUID}/users/activate HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 220
{
"name": "text",
"image": "text",
"environments": [
{
"role": "text",
"environment": {
"uuid": "text",
"name": "text"
},
"bots": [
{
"uuid": "text"
}
]
}
],
"email": "text",
"company": "text",
"admin": true,
"password": "text",
"confirmPassword": "text"
}{
"name": "text",
"image": "text",
"environments": [
{
"role": "text",
"environment": {
"uuid": "text",
"name": "text"
},
"bots": [
{
"uuid": "text",
"name": "text",
"environmentUuid": "text",
"image": "text"
}
]
}
],
"email": "text",
"company": "text",
"admin": true,
"orgUUID": "text",
"createdAt": "2025-07-10T20:33:21.399Z",
"uuid": "text"
}Service responsible for deleting a user, the delete is logical thus enabling its activation in the future.
It is the organization the user is in.
It is an identifier provided by the API client that will be used to identify distributed logs.
DELETE /org/{orgUUID}/users/{userUuid} HTTP/1.1
Host:
Accept: */*
No content
Auxiliary Methods
It is the organization the user is in.
Access Token
Bearer access_tokenGET /org/{orgUUID}/users/identity-provider HTTP/1.1
Host:
Authorization: text
Accept: */*
{
"name": "text",
"image": "text",
"environments": [
{
"role": "text",
"environment": {
"uuid": "text",
"name": "text"
},
"bots": [
{
"uuid": "text",
"name": "text",
"environmentUuid": "text",
"image": "text"
}
]
}
],
"email": "text",
"company": "text",
"admin": true,
"orgUUID": "text",
"createdAt": "2025-07-10T20:33:21.399Z",
"uuid": "text"
}User Configurations
Not used.
A body containing the user's new configuration data.
A User Configuration Key, which can be any String
The value being assigned to said key.
Optional Value. If present, sets the configuration specifically for designated bot.
POST /org/{orgUUID}/configurations HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 46
{
"key": "text",
"value": "text",
"botUUID": "text"
}{
"id": 1,
"user": {
"uuid": "text",
"organizationUuid": "text",
"identityProviderReference": "text",
"name": "text",
"email": "text",
"imageUrl": "text",
"company": "text",
"admin": true,
"removed": true,
"createdBy": "text",
"updatedBy": "text",
"createdAt": "2025-07-10T20:33:21.399Z",
"updatedAt": "2025-07-10T20:33:21.399Z"
},
"key": "text",
"value": "text",
"botUuid": "text"
}Not used.
GET /org/{orgUUID}/configurations HTTP/1.1
Host:
Accept: */*
[
{
"key": "text",
"value": "text",
"botUUID": "text"
}
]Not used.
A key that represents a configuration, is this key that will be checked.
GET /org/{orgUUID}/configurations/userHasConf?key=text HTTP/1.1
Host:
Accept: */*
trueNot used.
Bot containing this configuration
GET /org/{orgUUID}/configurations/{botUUID} HTTP/1.1
Host:
Accept: */*
[
{
"key": "text",
"value": "text",
"botUUID": "text"
}
]Not used.
Bot containing this configuration
A key that represents a configuration, is this key that will be checked.
GET /org/{orgUUID}/configurations/{botUUID}/userHasConf?key=text HTTP/1.1
Host:
Accept: */*
trueBulk Operations
Bulk Create
This endpoint is responsible for the mass creation of users, through a csv file, with each line containing the following data, as follows:
email;name;company;role;password;environmentUuid;environmentName;botEmail: Email of the user being created.
Name: Name of the user being created
Company: It is company name
Password: The user's starting password.
Role: The Role assigned to each user.
EnvironmentUuid: Id of the environment that will be attached to role (viewer, editor or supervisor)
EnvironmentName: Environment Name
Bot: Bot uuid that will be attached to environment reported in the column "EnvironmentUuid"
The request is a Multipart Form POST with a property "file" where its value will be the csv file to be processed.
It performs the creation of users in bulk, through a csv file, allowing access to the chosen environment and bots. The user is also registered with our Identity Provider
Is the organization that the user will be created.
The language that the email arriving for their created user will be. Possible values: 'en' - English 'es' - Spanish 'ja' - Japanese 'pt' - Portuguese
enIt is an identifier provided by the API client that will be used to identify distributed logs.
It is the file that contains the users data.
POST /org/{orgUUID}/users/bulk-create HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 17
{
"file": "binary"
}{
"errors": [
{
"ANY_ADDITIONAL_PROPERTY": "text"
}
]
}If at least a single user was created, you'll receive a 200 success response, with a list of errors for whichever users failed to be created. Along with their emails, a message will inform the triggering issue, as follows:
{
"errors":[
{...},
{
"[email protected]": "triggering cause of error message"
}
{...}
]
}Is the organization that the user will be created.
It is an identifier provided by the API client that will be used to identify distributed logs.
DELETE /org/{orgUUID}/users/bulk-delete HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 8
[
"text"
]{
"errors": [
{
"ANY_ADDITIONAL_PROPERTY": "text"
}
]
}It performs the changes of users permissions in bulk, through a csv file, allowing access to the chosen environment and bots. The user is also registered with our Identity Provider
Is the organization that the user will be created.
It is an identifier provided by the API client that will be used to identify distributed logs.
It is the file that contains the users data.
POST /org/{orgUUID}/users/bulk-permissions HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 17
{
"file": "binary"
}{
"errors": [
{
"ANY_ADDITIONAL_PROPERTY": "text"
}
]
}It performs the exclusion of users permissions in bulk, restricting access to the chosen environment and bots.
Is the organization that the user will be created.
It is an identifier provided by the API client that will be used to identify distributed logs.
DELETE /org/{orgUUID}/users/bulk-permissions HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 101
[
{
"email": "text",
"permissions": [
{
"role": "ADMIN",
"envUUID": "text",
"removeAll": true,
"bots": [
"text"
]
}
]
}
]{
"errors": [
{
"ANY_ADDITIONAL_PROPERTY": "text"
}
]
}Last updated
Was this helpful?