Create user
curl --request POST \
--url https://api.dev.impactu.colav.co/admin/users/{email} \
--header 'Content-Type: application/json' \
--data '
{
"institution": "<string>",
"ror_id": "<string>",
"role": "<string>"
}
'import requests
url = "https://api.dev.impactu.colav.co/admin/users/{email}"
payload = {
"institution": "<string>",
"ror_id": "<string>",
"role": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({institution: '<string>', ror_id: '<string>', role: '<string>'})
};
fetch('https://api.dev.impactu.colav.co/admin/users/{email}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.dev.impactu.colav.co/admin/users/{email}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'institution' => '<string>',
'ror_id' => '<string>',
'role' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.dev.impactu.colav.co/admin/users/{email}"
payload := strings.NewReader("{\n \"institution\": \"<string>\",\n \"ror_id\": \"<string>\",\n \"role\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.dev.impactu.colav.co/admin/users/{email}")
.header("Content-Type", "application/json")
.body("{\n \"institution\": \"<string>\",\n \"ror_id\": \"<string>\",\n \"role\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.dev.impactu.colav.co/admin/users/{email}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"institution\": \"<string>\",\n \"ror_id\": \"<string>\",\n \"role\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"msg": "Usuario usuario@example.com Creado exitosamente y contraseña enviada por correo electrónico."
}
{ "success": false, "msg": "Faltan: ror_id" }
{ "success": false, "msg": "El correo 'usuario@example' no es válido." }
{
"success": false,
"msg": "Para la institución: Universidad Ejemplo ya existe un correo registrado: otro@example.com. Si deseas asignar un nuevo correo, edita el usuario existente."
}
{ "success": false, "msg": "El usuario con correo usuario@example.com ya existe." }
{"msg": "Token no proporcionado o inválido. Por favor, inicia sesión nuevamente.", "success": false}
{ "success": false, "msg": "Permiso denegado: No pueden realizar esta acción." }
{ "success": false, "msg": "No se pueden crear usuarios con el role 'admin'." }
{ "success": false, "msg": "No se pudo enviar el correo con las credenciales. No se guardó ningún cambio." }
Users
Create user
Creates a new user on the platform and emails them their password. Only accessible with the admin role.
POST
/
admin
/
users
/
{email}
Create user
curl --request POST \
--url https://api.dev.impactu.colav.co/admin/users/{email} \
--header 'Content-Type: application/json' \
--data '
{
"institution": "<string>",
"ror_id": "<string>",
"role": "<string>"
}
'import requests
url = "https://api.dev.impactu.colav.co/admin/users/{email}"
payload = {
"institution": "<string>",
"ror_id": "<string>",
"role": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({institution: '<string>', ror_id: '<string>', role: '<string>'})
};
fetch('https://api.dev.impactu.colav.co/admin/users/{email}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.dev.impactu.colav.co/admin/users/{email}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'institution' => '<string>',
'ror_id' => '<string>',
'role' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.dev.impactu.colav.co/admin/users/{email}"
payload := strings.NewReader("{\n \"institution\": \"<string>\",\n \"ror_id\": \"<string>\",\n \"role\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.dev.impactu.colav.co/admin/users/{email}")
.header("Content-Type", "application/json")
.body("{\n \"institution\": \"<string>\",\n \"ror_id\": \"<string>\",\n \"role\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.dev.impactu.colav.co/admin/users/{email}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"institution\": \"<string>\",\n \"ror_id\": \"<string>\",\n \"role\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"msg": "Usuario usuario@example.com Creado exitosamente y contraseña enviada por correo electrónico."
}
{ "success": false, "msg": "Faltan: ror_id" }
{ "success": false, "msg": "El correo 'usuario@example' no es válido." }
{
"success": false,
"msg": "Para la institución: Universidad Ejemplo ya existe un correo registrado: otro@example.com. Si deseas asignar un nuevo correo, edita el usuario existente."
}
{ "success": false, "msg": "El usuario con correo usuario@example.com ya existe." }
{"msg": "Token no proporcionado o inválido. Por favor, inicia sesión nuevamente.", "success": false}
{ "success": false, "msg": "Permiso denegado: No pueden realizar esta acción." }
{ "success": false, "msg": "No se pueden crear usuarios con el role 'admin'." }
{ "success": false, "msg": "No se pudo enviar el correo con las credenciales. No se guardó ningún cambio." }
Requires an active session with the
admin role. The email with the
credentials is sent first and then the user is saved: if the email cannot
be sent, it returns 502 and nothing is created, so it can be retried.Path parameters
string
required
Email address of the new user. If it doesn’t have a valid format, it returns
400.Request body
It must have exactly these three fields, with non-empty text: if any is missing, extra or empty, it returns400.
string
required
Name of the institution the user belongs to.
string
required
ROR identifier of the institution. Example:
059yx9a68. Each institution
has a single user: if one already exists for that ror_id, it returns 409.string
required
User’s role on the platform. Example:
staff. It cannot be admin: it returns 403.Response
boolean
true if the user was created successfully.string
Confirmation or error message.
{
"success": true,
"msg": "Usuario usuario@example.com Creado exitosamente y contraseña enviada por correo electrónico."
}
{ "success": false, "msg": "Faltan: ror_id" }
{ "success": false, "msg": "El correo 'usuario@example' no es válido." }
{
"success": false,
"msg": "Para la institución: Universidad Ejemplo ya existe un correo registrado: otro@example.com. Si deseas asignar un nuevo correo, edita el usuario existente."
}
{ "success": false, "msg": "El usuario con correo usuario@example.com ya existe." }
{"msg": "Token no proporcionado o inválido. Por favor, inicia sesión nuevamente.", "success": false}
{ "success": false, "msg": "Permiso denegado: No pueden realizar esta acción." }
{ "success": false, "msg": "No se pueden crear usuarios con el role 'admin'." }
{ "success": false, "msg": "No se pudo enviar el correo con las credenciales. No se guardó ningún cambio." }