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

orgUUID*string

It is the organization the user is in.

Query parameters

Response

200400401403404409422500

Ok

Body

*/*

totalPagesinteger (int32)

totalElementsinteger (int64)

pageablePageableObject (object)

numberOfElementsinteger (int32)

sortSort (object)

firstboolean

lastboolean

sizeinteger (int32)

contentarray of UserRuleDTOUserEnvironmentDTO (object)

numberinteger (int32)

emptyboolean

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/users?orderBy=createdAt&direction=DESC&searchTerms=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

{
  "pageable": {
    "paged": false,
    "unpaged": false,
    "sort": {
      "unsorted": false,
      "sorted": false,
      "empty": false
    }
  },
  "sort": {
    "unsorted": false,
    "sorted": false,
    "empty": false
  },
  "first": false,
  "last": false,
  "content": [
    {
      "name": "text",
      "image": "text",
      "environments": [
        {
          "role": "text",
          "environment": {
            "uuid": "text",
            "name": "text"
          }
        }
      ],
      "email": "text",
      "company": "text",
      "admin": false,
      "orgUUID": "text",
      "createdAt": "2024-11-21T06:27:12.320Z",
      "rules": {
        "deletable": false
      },
      "uuid": "text"
    }
  ],
  "empty": false
}

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

orgUUID*string

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

Query parameters

Header parameters

Response

200400401403404409422500

Ok

Body

*/*

itemsstring

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/users/quicksearch?name=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

[
  "text"
]

CRUD Operations

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

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

Path parameters

orgUUID*string

It is the organization the user is in.

userId*string

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

Response

200400401403404409422500

Ok

Body

*/*

name*string

Name of the user.

imagestring

Image of the user.

environmentsarray of UserEnvironmentDataDTOBotPropertiesDTO (object)

Environments of the user.

email*string

Email of the user.

companystring

Company of the user.

adminboolean

Flag that identifies if the user is admin.

orgUUIDstring

Organization where the user is.

createdAtstring (date-time)

It is the user creation date.

uuidstring

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/users/{userId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

{
  "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": false,
  "orgUUID": "text",
  "createdAt": "2024-11-21T06:27:12.320Z",
  "uuid": "text"
}

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

orgUUID*string

Is the organization that the user will be created.

Header parameters

Body

application/json

name*string

Name of the user.

imagestring

Image of the user.

environmentsarray of UserEnvironmentDataDTOBotDTO (object)

Environments of the user.

email*string

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.

Response

201400401403404409422500

Ok

Body

*/*

name*string

Name of the user.

imagestring

Image of the user.

environmentsarray of UserEnvironmentDataDTOBotPropertiesDTO (object)

Environments of the user.

email*string

Email of the user.

companystring

Company of the user.

adminboolean

Flag that identifies if the user is admin.

orgUUIDstring

Organization where the user is.

createdAtstring (date-time)

It is the user creation date.

uuidstring

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/users', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "email": "text",
      "name": "text"
    }),
});
const data = await response.json();

Response

201400401403404409422500

{
  "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": false,
  "orgUUID": "text",
  "createdAt": "2024-11-21T06:27:12.320Z",
  "uuid": "text"
}

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

orgUUID*string

It is the organization the user is in.

userId*string

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

Header parameters

Body

application/json

name*string

Name of the user.

imagestring

Image of the user.

environmentsarray of UserEnvironmentDataDTOBotDTO (object)

Environments of the user.

email*string

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.

Response

200400401403404409422500

Ok

Body

*/*

name*string

Name of the user.

imagestring

Image of the user.

environmentsarray of UserEnvironmentDataDTOBotPropertiesDTO (object)

Environments of the user.

email*string

Email of the user.

companystring

Company of the user.

adminboolean

Flag that identifies if the user is admin.

orgUUIDstring

Organization where the user is.

createdAtstring (date-time)

It is the user creation date.

uuidstring

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/users/{userId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "email": "text",
      "name": "text"
    }),
});
const data = await response.json();

Response

200400401403404409422500

{
  "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": false,
  "orgUUID": "text",
  "createdAt": "2024-11-21T06:27:12.320Z",
  "uuid": "text"
}

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

PUT/org/{orgUUID}/users/activate

Path parameters

orgUUID*string

It is the organization the user is in.

Header parameters

Body

application/json

name*string

Name of the user.

imagestring

Image of the user.

environmentsarray of UserEnvironmentDataDTOBotDTO (object)

Environments of the user.

email*string

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.

Response

200400401403404409422500

Ok

Body

*/*

name*string

Name of the user.

imagestring

Image of the user.

environmentsarray of UserEnvironmentDataDTOBotPropertiesDTO (object)

Environments of the user.

email*string

Email of the user.

companystring

Company of the user.

adminboolean

Flag that identifies if the user is admin.

orgUUIDstring

Organization where the user is.

createdAtstring (date-time)

It is the user creation date.

uuidstring

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/users/activate', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "email": "text",
      "name": "text"
    }),
});
const data = await response.json();

Response

200400401403404409422500

{
  "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": false,
  "orgUUID": "text",
  "createdAt": "2024-11-21T06:27:12.320Z",
  "uuid": "text"
}

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

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

Path parameters

orgUUID*string

It is the organization the user is in.

userUuid*string

Header parameters

Response

204400401403404409422500

No content

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/users/{userUuid}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

400401403404409422500

{
  "errorCode": "text",
  "errorType": "API_ERROR",
  "message": "text",
  "path": "text"
}

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

orgUUID*string

It is the organization the user is in.

Header parameters

Response

200400401403404409422500

Ok

Body

*/*

name*string

Name of the user.

imagestring

Image of the user.

environmentsarray of UserEnvironmentDataDTOBotPropertiesDTO (object)

Environments of the user.

email*string

Email of the user.

companystring

Company of the user.

adminboolean

Flag that identifies if the user is admin.

orgUUIDstring

Organization where the user is.

createdAtstring (date-time)

It is the user creation date.

uuidstring

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/users/identity-provider', {
    method: 'GET',
    headers: {
      "Authorization": "text"
    },
});
const data = await response.json();

Response

200400401403404409422500

{
  "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": false,
  "orgUUID": "text",
  "createdAt": "2024-11-21T06:27:12.320Z",
  "uuid": "text"
}

User Configurations

Returns all settings of the active user.

GET/org/{orgUUID}/configurations

Path parameters

orgUUID*string

Not used.

Response

200400401403404409422500

Ok

Body

*/*

keystring

A User Configuration Key, which can be any String

valuestring

The value being assigned to said key.

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/configurations', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

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

Saves a User setting.

POST/org/{orgUUID}/configurations

Path parameters

orgUUID*string

Not used.

Body

application/json

keystring

A User Configuration Key, which can be any String

valuestring

The value being assigned to said key.

Response

200400401403404409422500

Ok

Body

*/*

idinteger (int64)

userUser (object)

keystring

valuestring

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/configurations', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400401403404409422500

{
  "user": {
    "uuid": "text",
    "organizationUuid": "text",
    "identityProviderReference": "text",
    "name": "text",
    "email": "text",
    "imageUrl": "text",
    "company": "text",
    "admin": false,
    "removed": false,
    "createdBy": "text",
    "updatedBy": "text",
    "createdAt": "2024-11-21T06:27:12.320Z",
    "updatedAt": "2024-11-21T06:27:12.320Z"
  },
  "key": "text",
  "value": "text"
}

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

orgUUID*string

Is the organization that the user will be created.

Header parameters

Body

application/json

file*string (binary)

It is the file that contains the users data.

Response

200400401403404409422500

OK

Body

*/*

errorsarray of object

List of errors.

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/users/bulk-create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "file": "binary"
    }),
});
const data = await response.json();

Response

200400401403404409422500

{
  "errors": []
}

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"
        }
        {...}
    ]
}