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

CRUD Operations

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.

User Configurations

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.

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":[
        {...},
        {
            "example@email.com": "triggering cause of error message"
        }
        {...}
    ]
}

Last updated