User
The User API allows you to search, create and edit existing users, as well as set their user configuration values.
Was this helpful?
The User API allows you to search, create and edit existing users, as well as set their user configuration values.
Was this helpful?
This endpoint is responsible for the mass creation of users, through a csv file, with each line containing the following data, as follows:
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"
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:
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.
It is the organization the user is in.
It is the number of pages that will be returned, default value 0.
1
It is the number of users per page, default value 5.
1
It is the user attribute used for ordination the page, default attribute createdAt.
It is the sorting type, default value DESC.
It is the parameter that contains the user data entry, that will be used to filter the users.
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
6
It is an identifier provided by the API client that will be used to identify distributed logs
It is the organization the user is in.
It is the user id that will be used in the search process.
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.
No body
It is the organization the user is in.
Access Token
Bearer access_token
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.
Name of the user.
Image of the user.
Environments 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.
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.
Name of the user.
Image of the user.
Environments 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.
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.
Name of the user.
Image of the user.
Environments 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.