Kaspersky Automated Security Awareness Platform

"POST /openapi/v1/users"-Methode

19. April 2024

ID 242752

Erstellt einen Benutzer, der zu einer bestimmten Gruppe hinzugefügt wird.

Anfrage

Kopfzeile:

  • Authorization – API-Token des Unternehmens.

Körper:

  • user – ein Objekt – Ein Objekt, das persönliche Informationen über den Benutzer enthält.
    • fullName – eine Zeichenfolge – Der vollständige Name des Benutzers.
    • shortName – eine Zeichenfolge – Der Kurzname des Benutzers.
    • email – eine Zeichenfolge – Die E-Mail-Adresse des Benutzers. Muss in Kleinbuchstaben angegeben werden. Eingaben wie beispielsweise AdMiN@DomAin.com erzeugen einen Eingabevalidierungsfehler.
  • group – ein Objekt – Ein Objekt mit Informationen über die Gruppe, der der Benutzer zugewiesen wird.
    • id – eine Zeichenfolge – Die Gruppen-ID.

Beispiel für den Körper einer Anfrage:

{

    user: {

        fullName: 'Max Mustermann',

        shortName: 'Max',

        email: 'jemand@email.com'

    },

    group: {

        id: '627d5c63f0672a10fbac23bb'

    }

}

Antwort

  • user – ein Objekt – Ein Objekt mit persönlichen Daten über den erstellten Benutzer.
    • id – eine Zeichenfolge – Die Benutzer-ID.

Beispiel einer Antwort:

{

    user: {

        id: '627b4aa62344090b598f7435'

    }

}

Mögliche Fehler:

  • 400common-validation – Es ist ein Anfrage-Validierungsfehler aufgetreten.
  • 401 – common-unauthorized – Es ist ein Authentifizierungsfehler aufgetreten.
  • 402 – no-available-license – Es gibt nicht genügend Lizenzen, um den Benutzer einer Gruppe zuzuweisen, deren Training begonnen hat.
  • 404 – group-does-not-exists – Dieses Unternehmen hat keine Gruppe mit der angegebenen Kennung.
  • 429 – too-many-requests – Es gab zu viele Abfragen.
  • 409 – user-email-already-exists-in-company – In diesem Unternehmen gibt es bereits einen Benutzer mit der angegebenen E-Mail-Adresse.

War dieser Artikel hilfreich?
Helfen Sie uns, diesen Artikel zu verbessern. Wählen Sie den Grund für Ihre Bewertung:
Danke für Ihr Feedback! Sie helfen uns, besser zu werden.
Danke für Ihr Feedback! Sie helfen uns, besser zu werden.