User

The User API allows you to search, create and edit existing users, as well as set their user configuration values.

API SUBPATH: eva-user

Pagination and Listings

Searches for all users through the organization informed.

get

/org/{orgUUID}/users

Path parameters

orgUUIDstringrequired

It is the organization the user is in.

Query parameters

pageinteger · int32required

It is the number of pages that will be returned, default value 0.

Example: 1

linesPerPageinteger · int32 · default: 5required

It is the number of users per page, default value 5.

Example: 1

orderBystring · default: createdAtrequired

It is the user attribute used for ordination the page, default attribute createdAt.

directionstring · default: DESCrequired

It is the sorting type, default value DESC.

searchTermsstringrequired

It is the parameter that contains the user data entry, that will be used to filter the users.

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/org/{orgUUID}/users?page=0&linesPerPage=5&orderBy=createdAt&direction=DESC&searchTerms=text'

200

400

401

403

404

409

422

500

200

{
  "totalPages": 1,
  "totalElements": 1,
  "pageable": {
    "paged": true,
    "unpaged": true,
    "pageNumber": 1,
    "pageSize": 1,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    },
    "offset": 1
  },
  "numberOfElements": 1,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "size": 1,
  "number": 1,
  "empty": true,
  "content": [
    {
      "name": "text",
      "image": "text",
      "email": "text",
      "company": "text",
      "admin": true,
      "orgUUID": "text",
      "createdAt": "2025-02-22T16:03:35.734Z",
      "rules": {
        "deletable": true
      },
      "uuid": "text",
      "environments": [
        {
          "role": "text",
          "environment": {
            "uuid": "text",
            "name": "text"
          }
        }
      ]
    }
  ]
}

Ok

Searches (greedily) for any User names that exists in an organization, matching the typed term, left-to-right, and returns a list of up to 6 Strings, ordered alphabetically.

get

/org/{orgUUID}/users/quicksearch

Path parameters

orgUUIDstringrequired

It is the organization where the user is, used to filter the user by organization

Query parameters

namestringrequired

It is the parameter used to search for users related to the entered value

limitinteger · int32 · default: 6

It is the max number of result, default value 6

Example: 6

Header parameters

x-request-idstring

It is an identifier provided by the API client that will be used to identify distributed logs

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/org/{orgUUID}/users/quicksearch?name=text'

200

400

401

403

404

409

422

500

200

[
  "text"
]

Ok

CRUD Operations

Searches for a user through the UUID and the organization informed.

get

/org/{orgUUID}/users/{userId}

Path parameters

orgUUIDstringrequired

It is the organization the user is in.

userIdstringrequired

It is the user id that will be used in the search process.

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/org/{orgUUID}/users/{userId}'

200

400

401

403

404

409

422

500

200

{
  "name": "text",
  "image": "text",
  "email": "text",
  "company": "text",
  "admin": true,
  "orgUUID": "text",
  "createdAt": "2025-02-22T16:03:35.734Z",
  "uuid": "text",
  "environments": [
    {
      "role": "text",
      "environment": {
        "uuid": "text",
        "name": "text"
      },
      "bots": [
        {
          "uuid": "text",
          "name": "text",
          "environmentUuid": "text",
          "image": "text"
        }
      ]
    }
  ]
}

Ok

Performs user creation allowing access to the chosen environment and bots. The user is also registered with our Identity Provider

post

/org/{orgUUID}/users

Path parameters

orgUUIDstringrequired

Is the organization that the user will be created.

Header parameters

x-request-idstring

It is an identifier provided by the API client that will be used to identify distributed logs.

Body

namestringrequired

Name of the user.

imagestring

Image of the user.

emailstringrequired

Email of the user.

companystring

Company of the user.

adminboolean

Flag that identifies if the user is admin.

passwordstring

Password of the user.

confirmPasswordstring

Confirmation of the user's password, both must have the same value.

environmentsobject[]

Environments of the user.

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/org/{orgUUID}/users' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text","email":"text","environments":[{"environment":{},"bots":[{}]}]}'

201

400

401

403

404

409

422

500

201

{
  "name": "text",
  "image": "text",
  "email": "text",
  "company": "text",
  "admin": true,
  "orgUUID": "text",
  "createdAt": "2025-02-22T16:03:35.734Z",
  "uuid": "text",
  "environments": [
    {
      "role": "text",
      "environment": {
        "uuid": "text",
        "name": "text"
      },
      "bots": [
        {
          "uuid": "text",
          "name": "text",
          "environmentUuid": "text",
          "image": "text"
        }
      ]
    }
  ]
}

Ok

Updates the user's base data and accesses the chosen environment and bots. The user is also up to date on our Identity Provider.

put

/org/{orgUUID}/users/{userId}

Path parameters

orgUUIDstringrequired

It is the organization the user is in.

userIdstringrequired

It is the id that will be used to search the user in the database for the update.

Header parameters

x-request-idstring

It is an identifier provided by the API client that will be used to identify distributed logs.

Body

namestringrequired

Name of the user.

imagestring

Image of the user.

emailstringrequired

Email of the user.

companystring

Company of the user.

adminboolean

Flag that identifies if the user is admin.

passwordstring

Password of the user.

confirmPasswordstring

Confirmation of the user's password, both must have the same value.

environmentsobject[]

Environments of the user.

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/org/{orgUUID}/users/{userId}' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text","email":"text","environments":[{"environment":{},"bots":[{}]}]}'

200

400

401

403

404

409

422

500

200

{
  "name": "text",
  "image": "text",
  "email": "text",
  "company": "text",
  "admin": true,
  "orgUUID": "text",
  "createdAt": "2025-02-22T16:03:35.734Z",
  "uuid": "text",
  "environments": [
    {
      "role": "text",
      "environment": {
        "uuid": "text",
        "name": "text"
      },
      "bots": [
        {
          "uuid": "text",
          "name": "text",
          "environmentUuid": "text",
          "image": "text"
        }
      ]
    }
  ]
}

Ok

Reactivates a previously deleted user, thus enabling the user's access to the system.

put

/org/{orgUUID}/users/activate

Path parameters

orgUUIDstringrequired

It is the organization the user is in.

Header parameters

x-request-idstring

It is an identifier provided by the API client that will be used to identify distributed logs.

Body

namestringrequired

Name of the user.

imagestring

Image of the user.

emailstringrequired

Email of the user.

companystring

Company of the user.

adminboolean

Flag that identifies if the user is admin.

passwordstring

Password of the user.

confirmPasswordstring

Confirmation of the user's password, both must have the same value.

environmentsobject[]

Environments of the user.

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/org/{orgUUID}/users/activate' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text","email":"text","environments":[{"environment":{},"bots":[{}]}]}'

200

400

401

403

404

409

422

500

200

{
  "name": "text",
  "image": "text",
  "email": "text",
  "company": "text",
  "admin": true,
  "orgUUID": "text",
  "createdAt": "2025-02-22T16:03:35.734Z",
  "uuid": "text",
  "environments": [
    {
      "role": "text",
      "environment": {
        "uuid": "text",
        "name": "text"
      },
      "bots": [
        {
          "uuid": "text",
          "name": "text",
          "environmentUuid": "text",
          "image": "text"
        }
      ]
    }
  ]
}

Ok

Deletes a user. The delete is logical, thus allowing its reactivation in the future.

delete

/org/{orgUUID}/users/{userUuid}

Path parameters

orgUUIDstringrequired

It is the organization the user is in.

userUuidstringrequired

Header parameters

x-request-idstring

It is an identifier provided by the API client that will be used to identify distributed logs.

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/org/{orgUUID}/users/{userUuid}'

204

400

401

403

404

409

422

500

204

No body

No content

Auxiliary Methods

If you need to find a User and it's details by it's token, or to retrieve information abour the currently logged in user, this is the method you want.

Searches for a user through the data in the informed token.

get

/org/{orgUUID}/users/identity-provider

Path parameters

orgUUIDstringrequired

It is the organization the user is in.

Header parameters

Authorizationstringrequired

Access Token

Example: Bearer access_token

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/org/{orgUUID}/users/identity-provider' \
  --header 'Authorization: text'

200

400

401

403

404

409

422

500

200

{
  "name": "text",
  "image": "text",
  "email": "text",
  "company": "text",
  "admin": true,
  "orgUUID": "text",
  "createdAt": "2025-02-22T16:03:35.734Z",
  "uuid": "text",
  "environments": [
    {
      "role": "text",
      "environment": {
        "uuid": "text",
        "name": "text"
      },
      "bots": [
        {
          "uuid": "text",
          "name": "text",
          "environmentUuid": "text",
          "image": "text"
        }
      ]
    }
  ]
}

Ok

User Configurations

Returns all settings of the active user.

get

/org/{orgUUID}/configurations

Path parameters

orgUUIDstringrequired

Not used.

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/org/{orgUUID}/configurations'

200

400

401

403

404

409

422

500

200

[
  {
    "key": "text",
    "value": "text"
  }
]

Ok

Saves a User setting.

post

/org/{orgUUID}/configurations

Path parameters

orgUUIDstringrequired

Not used.

Body

keystring

A User Configuration Key, which can be any String

valuestring

The value being assigned to said key.

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/org/{orgUUID}/configurations' \
  --header 'Content-Type: application/json'

200

400

401

403

404

409

422

500

200

{
  "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-02-22T16:03:35.734Z",
    "updatedAt": "2025-02-22T16:03:35.734Z"
  },
  "key": "text",
  "value": "text"
}

Ok

Bulk 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;bot

• Email: 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"

A few rules to note:

• User emails must be unique There may be no other user with the same email in a whole organization.

• A user may only have one role.

• The password must follow the designated Keycloak policies (By standard, at least one uppercase character, a lowercase character, a special or numeral and it must have a minimum of 6 characters)

• When creating common users (viewer or editor) the environmentUuid, environmentName, and bot fields are mandatory

• When creating a supervisor user the environmentUuid and environmentName fields are mandatory

• The role column must be one of the following values: ADMIN, SUPERVISOR, EDITOR or VIEWER; and cannot be a null value.

• EnvironmentUuid, environmentName, and bot must exist in the database, be active and be related

The request is a Multipart Form POST with a property "file" where its value will be the csv file to be processed.

Bulk creates users, through a csv file, allowing access to the chosen environment and bots. Created users are also registered within our Identity Provider.

post

/org/{orgUUID}/users/bulk-create

Path parameters

orgUUIDstringrequired

Is the organization that the user will be created.

Header parameters

x-request-idstring

It is an identifier provided by the API client that will be used to identify distributed logs.

Body

filestring · binaryrequired

It is the file that contains the users data.

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/org/{orgUUID}/users/bulk-create' \
  --header 'Content-Type: application/json' \
  --data '{"file":"text"}'

200

400

401

403

404

409

422

500

200

{
  "errors": [
    {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  ]
}

OK

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":[
        {...},
        {
            "[e-mail]": "triggering cause of error message"
        }
        {...}
    ]
}