Metodo "POST /openapi/v1/users"

19 aprile 2024

ID 242752

Creazione di un utente aggiunto a un gruppo specificato.

Richiesta

Intestazione:

  • Autorizzazione: token API dell'azienda.

Corpo:

  • user – un oggetto: un oggetto che contiene informazioni personali sull'utente.
    • fullName – una stringa: nome e cognome dell'utente.
    • shortName – una stringa: nome dell'utente.
    • email – una stringa: indirizzo email dell'utente. Deve essere indicato in lettere minuscole. Un input come AdMiN@DomAn.com produrrà un errore di convalida dell'input.
  • group – un oggetto: un oggetto con informazioni sul gruppo a cui verrà assegnato l'utente.
    • iduna sequenza: identificativo del gruppo.

Esempio del corpo di una richiesta:

{

    user: {

        fullName: 'Andrea Rossi',

        shortName: 'Andrea',

        email: 'some@email.com'

    },

    group: {

        id: '627d5c63f0672a10fbac23bb'

    }

}

Risposta

  • user – un oggetto: un oggetto che contiene informazioni sull'utente creato.
    • id – una stringa: identificativo dell'utente.

Esempio di risposta:

{

    user: {

        id: '627b4aa62344090b598f7435'

    }

}

Possibili errori:

  • 400common-validation: si è verificato un errore di convalida della richiesta.
  • 401 - common-unauthorized: si è verificato un errore di autenticazione.
  • 402no-available-license: non sono disponibili licenze sufficienti per assegnare l'utente a un gruppo la cui formazione è iniziata.
  • 404group-does-not-exists: questa azienda non ha un gruppo con l'identificativo indicato.
  • 429too-many-requests: è presente un numero eccessivo di richieste.
  • 409user-email-already-exists-in-company: questa azienda presenta già un utente con l'indirizzo e-mail indicato.

Hai trovato utile questo articolo?
Cosa pensi che potremmo migliorare?
Grazie per il feedback! Ci stai aiutando a migliorare.
Grazie per il feedback! Ci stai aiutando a migliorare.