Benachrichtigungseinstellung des authentifizierten Nutzenden ändern

Note

Die Benachrichtigungseinstellung steht nur für eine Organisation mit aktivierter Anomaliefunktion und nur für Nutzende zur Verfügung, die weder SOC-Administrierende noch SOC-Nutzende sind. SOC-Administrierende und SOC-Nutzende tragen ihre E-Mail-Adresse stattdessen in die Liste der Benachrichtigungsempfänger der jeweiligen Organisation ein.

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

Beschreibung

Mit der Change-Notification-Preferences-Anfrage ändern Sie die Einstellung des authentifizierten Nutzenden für E-Mail-Benachrichtigungen zu Mitigationen und Anomalien.

Voraussetzungen

Werte der Anfrage: keine

Objekte: NotificationPreferencesVO

Anfrage

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

Für die genaue Angabe, welche Informationen zum Ändern der Benachrichtigungseinstellung erforderlich sind, definieren Sie im Body das Objekt NotificationPreferencesVO mit den folgenden Attributen:

Attribut	Beschreibung	Werte
notificationsEnabled	Zeigt an, ob der Nutzende für E-Mail-Benachrichtigungen zu Mitigationen und Anomalien angemeldet ist.	true, false

Als Antwort erhalten Sie das Objekt ApiUser mit den aktualisierten Informationen.

Das Objekt liefert die folgenden Informationen:

Attribut	Beschreibung	Werte
id	Die ID des Nutzenden.	string
name	Der vollständige Name des Nutzenden.	string
email	Die E-Mail-Adresse des Nutzenden.	string
notificationsEnabled	Zeigt an, ob der Nutzende für E-Mail-Benachrichtigungen zu Mitigationen und Anomalien angemeldet ist.	true, false
activeOrganisation	Die Organisation, in deren Kontext der Token arbeitet.	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.