Benachrichtigungseinstellung des authentifizierten Nutzenden ändern¶

Note

Die Benachrichtigungseinstellung steht nur für eine Organisation mit aktivierter Funktion Anomalien und nur für Nutzende zur Verfügung, die weder SOC-Administration noch SOC-Nutzende sind. SOC-Administration und SOC-Nutzende tragen ihre E-Mail-Adresse stattdessen in die Liste der Benachrichtigungsadressen der betreffenden Organisation ein.

Senden einer PATCH-Anfrage an den Endpunkt /users/me/notification-preferences.

Beschreibung¶

Mit der Change-Notification-Preferences-Anfrage ändern Sie die Einstellung für Benachrichtigungs-E-Mails zu Mitigationen und Anomalien der aktuell authentifizierten Nutzenden.

Voraussetzungen¶

Werte der Anfrage: keine

Objekte: NotificationPreferencesVO

Anfrage¶

Um die Benachrichtigungseinstellung zu ändern, ist im Pfad der Anfrage keine zusätzliche Information erforderlich.

Für eine detaillierte Spezifikation, welche Informationen zum Ändern der Benachrichtigungseinstellung erforderlich sind, muss im Body ein Objekt NotificationPreferencesVO mit dem folgenden Attribut definiert werden:

Attribut	Beschreibung	Werte
`notificationsEnabled`	Definiert, ob die Nutzenden Benachrichtigungs-E-Mails zu Mitigationen und Anomalien erhalten.	`true` `false`

Das System gibt als Antwort das Objekt ApiUser mit den geänderten Informationen zurück.

Das Objekt liefert die folgenden Informationen:

Attribut	Beschreibung	Werte
`id`	Die ID der Nutzenden.	`string`
`name`	Der vollständige Name der Nutzenden.	`string`
`email`	Die E-Mail-Adresse der Nutzenden.	`string`
`notificationsEnabled`	Definiert, ob die Nutzenden Benachrichtigungs-E-Mails zu Mitigationen und Anomalien erhalten.	`true` `false`
`activeOrganisation`	Der Organisationskontext, in dem das Token verwendet wird.	`object`

Beispiel¶

Beispiel-Request-Body:

{
  "notificationsEnabled": true
}

Antworten¶

Die folgenden Antworten sind möglich:

STATUSCODE	BESCHREIBUNG
200	Die Anfrage war erfolgreich.
401	Die Anfrage war nicht erfolgreich, da die Authentifizierung fehlerhaft war.
403	Die Anfrage war nicht erfolgreich, da die erforderlichen Berechtigungen fehlen.
422	Die Anfrage war nicht erfolgreich, da die übermittelten Daten nicht verarbeitet werden konnten.