Método «POST /openapi/v1/users»

19 de abril de 2024

ID 242752

Crear un usuario que se añade a un grupo especificado.

Solicitud

Encabezado:

  • Authorization: El token de la API de la empresa.

Cuerpo:

  • userun objeto: Un objeto que contiene información personal sobre el usuario.
    • fullNameuna cadena: El nombre completo del usuario.
    • shortNameuna cadena: El nombre corto del usuario.
    • emailuna cadena: La dirección de correo electrónico del usuario. Se debe escribir en minúsculas. Si se escribe algo como AdMiN@DomAn.com se producirá un error de validación de entrada.
  • groupun objeto: Un objeto con información sobre el grupo al que se asignará al usuario.
    • iduna cadena: El identificador del grupo.

Ejemplo del cuerpo de una solicitud:

{

    user: {

        fullName: 'John Doe',

        shortName: 'John',

        email: 'un@correo.com'

    },

    group: {

        id: '627d5c63f0672a10fbac23bb'

    }

}

Respuesta

  • userun objeto: Un objeto con información sobre el usuario creado.
    • iduna cadena: El identificador del usuario.

Ejemplo de una respuesta:

{

    user: {

        id: '627b4aa62344090b598f7435'

    }

}

Posibles errores:

  • 400common-validation: Ha ocurrido un error de validación de la solicitud.
  • 401 - common-unauthorized: Ha ocurrido un error de autenticación.
  • 402no-available-license: No hay suficientes licencias para asignar al usuario a un grupo cuya formación ha comenzado.
  • 404group-does-not-exists: Esta empresa no tiene un grupo con el identificador indicado.
  • 429too-many-requests: Había demasiadas solicitudes.
  • 409user-email-already-exists-in-company: Esta empresa ya tiene un usuario con la dirección de correo electrónico indicada.

¿Le ha resultado útil este artículo?
¿Qué podemos mejorar?
¡Gracias por darnos su opinión! Nos está ayudando a mejorar.
¡Gracias por darnos su opinión! Nos está ayudando a mejorar.