API Reference

Create a user in an organization

Con este endpoint podremos añadir nuevos usuarios a una organización

Prerequisitos

OrganizationId

Siempre que levantemos un escritorio remoto necesitaremos conocer el organizacionId donde queremos asociar la suscripción.

Para obtener dicha información utilizaremos este endpoint :

GET : /api-gateway/core/v1/organizations

Ejemplo Respuesta

{
	"data": [
		{
			"id": "1",
			"name": "Nombre Organizacion"
		}
	],
	"meta": {
		"correlationId": "5b1c3dc2-ffe9-4a72-8944-a75d385094f1",
		"timestamp": "2025-05-05T14:26:10Z"
	}
}

Resumen

  • Verbo HTTPS : POST
  • Endpoint : /api-gateway/core/v1/organizations/{organizationId}/users
  • Parámetros en el path : organizationId
  • Parámetros en el body

Campo

Tipo

Obligatorio

Descripción

Ejemplo

email

string

El email del usuario

[email protected]

password

string

No

Contraseña del usuario

“securePassword”

name

string

Nombre del usuario

“John”

lastName

string

Apellido del usuario

“Doe”

twoFactorAuthRequired

bool

No

Indica si se desea activar el 2fa para dicho usuario

true|false

position

string

No

Cargo del usuario en la organización

“developer”

phone

string

No

Teléfono del usuario

“+34666555444“

language

string

No

Idioma enum:

en_EN|es_ES|fr_FR|pt_PT

“en_EN”

timezone

string

No

Zona horaria

"Europe/Madrid"

  • Request Body
{
  "data": {
    "email": "[email protected]",
    "password": "string (password)",
    "name": "John",
    "lastname": "Smith",
    "twoFactorAuthRequired": true,
    "position": "Developer",
    "phone": "+34666555444",
    "language": "en_EN",
    "timezone": "Europe/Madrid"
  },
  "meta": {
    "requestId": "f69da1e4-1fe3-44e7-83ad-036ce3419337",
    "timestamp": "2025-05-05T16:02:18Z"
  }
}
  • Response (201 Created)
{
  "data": {
    "userId": "1078"
  },
  "meta": {
    "correlationId": "f69da1e4-1fe3-44e7-83ad-036ce3419337",
    "timestamp": "2025-05-05T16:02:18Z"
  }
}
Language
URL
Click Try It! to start a request and see the response here!