diff --git a/assets/images/oauth/01_portal.png b/assets/images/oauth/01_portal.png new file mode 100644 index 0000000000000000000000000000000000000000..7a00fdf8078ef6563f954f47c59ed6fe9cdb4354 Binary files /dev/null and b/assets/images/oauth/01_portal.png differ diff --git a/docs/4_Authentifizierung_und_Autorisierung.md b/docs/4_Authentifizierung_und_Autorisierung.md index 2aa66cb98f7d9a1a1e9961462a23f59193ea46e7..dab128ceeb9a18699d68c8f37e386db686b2d4f7 100644 --- a/docs/4_Authentifizierung_und_Autorisierung.md +++ b/docs/4_Authentifizierung_und_Autorisierung.md @@ -1,7 +1,92 @@ # Authentifizierung und Autorisierung -... +## Anwender Registrierung -**Noch in Arbeit** +Das FIT-Connect API Portal ist unter der folgenden URL erreichbar: + +https://portal.fiep-poc.de + +Eine Behörde, die ein Verfahren anbieten möchte, registriert sich zunächst am Portal mit dem Button "Registrieren". Diese Funktion steht auch rechts oben unter "Mein Konto" zur Verfügung. + + + + + + + +Im Anschluss erhalten Sie zwei verschiedene E-Mails. +Die zweite E-Mail kommt mit einer zeitlichen Verzögerung von bis zu 30 Minuten. + +In der ersten Email wird ihre Registrierungsanfrage bestätigt: + +> Hallo Werner Mustermann, +> +> ihre Anfrage zur Registrierung ist aufgenommen worden. Sie erhalten noch zwei weitere Bestätigungsmails. +> +> Mit besten Grüßen, +> Ihr FIT-Connect API Portal Team +> +> *** Diese Benachrichtigung wurde automatisch erstellt. Antworten Sie nicht auf diese Email.*** + +In der zweiten Email wird ihnen noch die Anwender-ID mitgeteilt. + +Diese Anwender-ID ist essenziell für die weitere Arbeit mit den APIs. +Sie ist Bestandteil sowohl der Aufruf URLs als auch Bestandteil der Scopes für die OAuth 2.0. Authorization / Authentication. + +**Erst nach Erhalt der Email können sie sich anmelden!** + +Hier ein Beispiel einer solchen Email: + +> Sehr geehrter Herr Mustermann, +> +> wir freuen uns über ihre Teilnahme an dem POC Fit-Connect. +> +> Ihre Anwender-ID lautet: c94ae37e-dcc5-345e-a530-8651bdfa5f2c +> +> Mit freundlichem Gruß +> Ihr FIT-Connect Team. + +## Client (Anwendung) Registrierung auf ein API + +<!-- theme: warning --> +> **Hinweis:** Im Zuge der ersten Anmeldung empfehlen wir die Umstellung der Sprache auf Deutsch. + + + + + +Im zweiten Schritt wird die von ihrer Behörde angebotene Anwendung (auch Client genannt) registriert. + +Dies erfolgt durch Aufruf der Details des für die Anwendung gewünschten API + +Dazu klicken sie in der Titelleiste auf "APIs": + + + +In der nun angezeigten Liste klicken Sie beim API "SubscriberAPI" auf den Button "Details anzeigen >>" + + + +In der Detailanzeige klicken sie rechts oben unter "Was als Nächstes?" auf "Client anmelden und Zugriffs-Token auswählen". + + + +Nun erscheint der folgende Dialog: + + + +Hier vergeben Sie einen Anwendungsnamen und eine Beschreibung. Die Angabe einer Umleitungs-URI ist optional. + +Mit dem Button "Token anfordern" lösen Sie die Erstellung der Anwendung (Client) und der für Sie gültigen Subscriber-ID (subscriber-id) und/oder Source/Sender-ID (source-id) aus. Diese Subscriber-ID wird für alle weiteren API Aufrufe benötigt. + +Im Hintergrund wird nun automatisch eine nur für ihre Behörde und diese Anwendung gültige Scope Konfiguration erstellt. Dies Konfiguration kann über den Menüpunkt "Applications" eingesehen werden. + + + + + +Aus dieser Liste heraus können sie die Details der Anwendung durch Klick auf den Namen der Anwendung ansehen. + + +... TO BE CONTINUED ... -... \ No newline at end of file