Skip to content

SSP: React-Komponente zum Erstellen von API-Clients Part II [SSP 2.6.5]

Warum?

Die Client-Verwaltung soll auch via React umgesetzt werden. In diesem Zuge soll auch das UI neu gestaltet werden.

Als ein Verfahrensbetreiber/Entwickler:in,

möchte ich bei der Anlage von neuen Clients dabei unterstützt werden, mich zwischen Sender und Subscriber zu entscheiden und direkt die konkreten Zustellpunkte (im Falle von Subscriber-Clients) auswählen können.

Aus Sicherheitsgründen notwendig. Achtung bei OAuth-Kompente bei Secret Vergabe.

Relevante Links und Bemerkungen

Akzeptanzkriterien

  1. Subscriber-Clients können 0..n Zustellpunkte zugeordnet werden (immer mind. 1 - Hintergrund: Clients müssen mindesten einen Scope zugeordnet haben, siehe FCONSD-184 "Es ist geplant, dass das Selfservice-Portal künftig davor warnt, dass eine Warnung erfolgt, wenn ein Subscriber-Client keine Destination besitzt."). Wenn keine Zustellpunkte ausgewählt werden, wird eine entsprechende Warnung angezeigt, dass der Subscriber-Client keine Submissions empfangen können wird.
  2. Unter der Auswahl der Zustellpunkte existiert ein Hinweis mit Link auf die Zustellpunktverwaltung. Ergänzung: Wenn kein Zustellpunkt erstellt wurde wird ein Hinweis erstellt mit der Verlinkung auf "Create Zustellpunkt".
  3. Für Subscriber-Clients kann ausgewählt werden, ob subscribe:-Scopes ("API-Client für den Abruf von Submissions berechtigen") und/oder manage:-Scopes ("API-Client für die Konfiguration von Zustellpunkten berechtigen") vergeben werden sollen. Die Auswahl kann pro API-Client getroffen werden und gilt dann für alle zugewiesenen Zustellpunkte des Subscriber-Clients. Die Auswahl beeinflusst die Zuweisung von OAuth-Scopes durch den OAuth-Server.
    • -> Prüfen beim PO-Review, ob es hier Nebenwirkungen der Self-Service-API gibt. --> Wird mit SSP-API eingeführt bis dahin ist dieser Teil ausgeblendet.
    • Anmerkung Marco: Die Unterscheidung zw. Subscriber- und Mange-Scopes hat nichts mit der SSP-API zu tun. Das Feature kann bei Bedarf dennoch gerne in eigenen Issue ausgelagert werden. In diesem Fall bitte hier durchstreichen und neues Issue verlinken.
  4. Nach Abschluss des Erstellens eines API-Client werden Client-ID und Client Secret einmalig angezeigt.
    1. Es wird ein Hinweis angezeigt, dass das Client Secret nur einmalig angezeigt wird und später nicht mehr eingesehen werden kann. --> Anmerkung Marco: Das Client-Secret soll nur per "Click-to-Copy" kopiert werden können, während es einmalig angezeigt wird.
    2. Client-ID und Client-Secret können per "Click-to-Copy" einfach per Mausklick kopiert werden (vgl. #683 (closed)).
    3. Auch in der Detail-Ansicht des API-Clients (in der Übersicht) wird der Hinweis angezeigt, dass das Secret nur einmalig angezeigt wird und dass ein neuer API-Client erzeugt werden muss, wenn das Secret verloren gegangen ist.
  5. Prozess zum Abrufen des OAuth-Servers ist im Entwicklerhandbuch abgelegt

Durchführungsplan (vom Entwickler bei Storyplanung auszufüllen)

Edited by René Rösner