Crear usuario #

Crea un nuevo usuario asignado a un inquilino del cliente.

POST /v1.0/customers/{CUSTOMER_TENANT_ID}/users

Observaciones #

Cada vez que se cree un nuevo usuario, se le asignará el rol "cliente.usuario" que le permite iniciar sesión en el archivo Portal del cliente. Esto también enviará un correo electrónico de activación a la dirección proporcionada tan pronto como el Usuario se crea.

Ejemplo #

Esta solicitud creará un nuevo Usuario con los siguientes detalles:

Cliente: dentro del inquilino del cliente con el identificador de {CUSTOMER_TENANT_ID}
Correo electrónico: [email protected]
Nombre para mostrar: "Nuevo usuario",
Papeles:
- Administrador de usuarios (admin.user)
- Usuario del sitio web (cliente.usuario)
- Nivel de supervisor informante (customer.user.supervisorl1)
- Configuración del cliente (customer.settings)

Pedir #

POST <https://api.na.myreports.cloud/api/v1.0/customers/{CUSTOMER_TENANT_ID}/users> HTTP/1.1
Tipo de contenido: application/json
accept-charges: true
Autorización: portador {TOKEN}
Conexión: keep-alive
{
	"correo electrónico": "[[email protected]](mailto:[email protected])",
	"displayName": "Nuevo usuario",
	"Roles": [" admin.user", "customer.user", "customer.user.supervisorl1", "customer.settings"]["admin.user", "customer.user", "customer.user.supervisorl1", "customer.settings"]
}

Respuesta #

HTTP/1.1 201 Creado
Tipo de contenido: application/json; charset=utf-8
Longitud del contenido: xx
Ubicación: <https://api.na.myreports.cloud/api/v1.0/customers/{CUSTOMER_TENANT_ID}/users/{USER_ID}>
{
	"datos": {
		"id": "{USER_ID}",
		"displayName": "Nuevo usuario",
		"correo electrónico": "[[email protected]](mailto:[email protected])",
		"primaryTenant": "{CUSTOMER_TENANT_ID}",
		"Roles": [" admin.user", "customer.user", "customer.user.supervisorl1", "customer.settings"]["admin.user", "customer.user", "customer.user.supervisorl1", "customer.settings"]
	},
	"status": "éxito",
	"timestamp": "2019-11-29T16:03:23.9251680Z"
}

Errores #

Desautorizado #

Cuando el token no se proporciona, no es válido o ha caducado

HTTP/1.1 401 No autorizado

Mala solicitud #

Cuando el identificador de inquilino proporcionado no está en el formato correcto

HTTP/1.1 400 Solicitud incorrecta
Fecha: Thu, 06 Feb 2020 12:45:27 GMT
Tipo de contenido: application/json; charset=utf-8
Longitud del contenido: 149
{
	"error": 400,
	"message": "El valor '<tenant id>' no es válido.",
	"status": "error",
	"timestamp": "2020-02-06T12:45:27.5903465Z"
}

Cuando se haya superado el importe de las licencias de usuario

HTTP/1.1 400 Solicitud incorrecta
Fecha: Thu, 06 Feb 2020 12:45:27 GMT
Tipo de contenido: application/json; charset=utf-8
Longitud del contenido: 149
{
	"error": 400,
	"message": "No hay suficientes licencias de usuario disponibles.",
	"status": "error",
	"timestamp": "2020-02-06T12:45:27.5903465Z"
}

No encontrado #

Cuando no hay clientes que tengan un identificador de inquilino coincidente

HTTP/1.1 404 No encontrado
Fecha: Thu, 06 Feb 2020 12:46:58 GMT
Tipo de contenido: application/json; charset=utf-8
Contenido-Longitud: 95
{
	"error": 404,
	"message": "No encontrado",
	"status": "error",
	"marca de tiempo": "2020-02-06T12:46:58.7669535Z"
}

Pago requerido #

Si esta solicitud puede incurrir en cargos adicionales, consulte Cargos.

HTTP/1.1 402 Pago requerido
Fecha: Thu, 06 Feb 2020 13:01:00 GMT
Tipo de contenido: application/json; charset=utf-8
Longitud del contenido: 274
{
	"datos": {
		"id": "{USER_ID}",
		"displayName": "Nuevo usuario",
		"correo electrónico": "[[email protected]](mailto:[email protected])",
		"primaryTenant": "{CUSTOMER_TENANT_ID}",
		"Roles": [" admin.user", "customer.user", "customer.user.supervisorl1", "customer.settings"]["admin.user", "customer.user", "customer.user.supervisorl1", "customer.settings"]
	},
	"error": 402,
	"message": "se aplican cargos adicionales",
	"status": "error",
	"marca de tiempo": "2020-02-06T13:01:01.1302340Z"
}

Conflicto #

Si la dirección de correo electrónico de este nuevo usuario ya se cierra para otro usuario en este inquilino del cliente

HTTP/1.1 409 Conflicto
Fecha: Thu, 06 Feb 2020 13:05:39 GMT
Tipo de contenido: application/json; charset=utf-8
Longitud del contenido: 178
{
	"error": 409,
	"errorCode": "EmailConflict",
	"message": "Un usuario con la dirección de correo electrónico [[email protected]](mailto:[email protected]) ya existe.",
	"status": "error",
	"timestamp": "2020-02-06T13:05:39.5486342Z"
}