Skip to content
Snippets Groups Projects
Verified Commit 77e5480a authored by Jonas Gröger's avatar Jonas Gröger :palm_tree:
Browse files

Linebreaks after sentences

parent bdfc8bbd
No related branches found
No related tags found
1 merge request!1Dokumentation der OAuth Changes
Hide whitespace changes
Inline Side-by-side
docs/details/authentication/scopes-sender.md
+ 23
− 32
View file @ 77e5480a
# OAuth Berechtigungen für sendende Systeme # OAuth Berechtigungen für sendende Systeme
Für den Zugriff auf die API des Zustelldienstes werden vom Autorisierungsserver Berechtigungen in Form von OAuth-Scopes Für den Zugriff auf die API des Zustelldienstes werden vom Autorisierungsserver Berechtigungen in Form von OAuth-Scopes
vergeben. Sendende Systeme werden damit berechtigt Einreichungen vorzunehmen. Empfangende Systeme werden damit vergeben.
berechtigt Einreichungen abzuholen. Sendende Systeme werden damit berechtigt Einreichungen vorzunehmen.
Empfangende Systeme werden damit berechtigt Einreichungen abzuholen.
## Zustellberechtigungs-Scopes ## Zustellberechtigungs-Scopes
Die Zustellberechtigungs-Scopes erlauben dem Zustelldienst festzustellen, ob ein sendendes System eine Einreichung an Die Zustellberechtigungs-Scopes erlauben dem Zustelldienst festzustellen, ob ein sendendes System eine Einreichung an
einen bestimmten Zustellpunkt übermitteln darf. Zustellberechtigungs-Scopes werden im Self-Service-Portal bei der einen bestimmten Zustellpunkt übermitteln darf.
Registrierung von API-Clients festgelegt und sind Zustellberechtigungs-Scopes werden im Self-Service-Portal bei der Registrierung von API-Clients festgelegt und sind
im [`scope`-Claim des Access Tokens](/details/infrastructure-docs/sender.md) hinterlegt. im [`scope`-Claim des Access Tokens](/details/infrastructure-docs/sender.md) hinterlegt.
### Zusammensetzung der Zustellberechtigungs-Scopes ### Zusammensetzung der Zustellberechtigungs-Scopes
...@@ -42,11 +43,8 @@ enthalten: ...@@ -42,11 +43,8 @@ enthalten:
### Einschränkung: Region ### Einschränkung: Region
Eine Einschränkung der Berechtigung für bestimmte Regionen erfolgt auf Basis des Eine Einschränkung der Berechtigung für bestimmte Regionen erfolgt auf Basis des zwölfstelligen [Amtlichen Regionalschlüssels (ARS)](https://de.wikipedia.org/wiki/Amtlicher_Gemeindeschl%C3%BCssel#Regionalschl%C3%BCssel), vorangestellt mit `DE`.
zwölfstelligen [Amtlichen Regionalschlüssels (ARS)](https://de.wikipedia.org/wiki/Amtlicher_Gemeindeschl%C3%BCssel#Regionalschl%C3%BCssel), Eine Liste der amtlichen Regionalschlüssel findet sich im [Gemeindeverzeichnis des Statistischen Bundesamtes](https://www.destatis.de/DE/Themen/Laender-Regionen/Regionales/Gemeindeverzeichnis/_inhalt.html) sowie im [XRepository](https://www.xrepository.de/details/urn:de:bund:destatis:bevoelkerungsstatistik:schluessel:rs).
vorangestellt mit `DE`. Eine Liste der amtlichen Regionalschlüssel findet sich
im [Gemeindeverzeichnis des Statistischen Bundesamtes](https://www.destatis.de/DE/Themen/Laender-Regionen/Regionales/Gemeindeverzeichnis/_inhalt.html)
sowie im [XRepository](https://www.xrepository.de/details/urn:de:bund:destatis:bevoelkerungsstatistik:schluessel:rs).
**Hinweis**: Ohne zusätzliche Einschränkung auf einen Leistungstyp ist ein Zustellberechtigungs-Scope für alle **Hinweis**: Ohne zusätzliche Einschränkung auf einen Leistungstyp ist ein Zustellberechtigungs-Scope für alle
Leistungstypen in der angegebenen Region gültig. Leistungstypen in der angegebenen Region gültig.
...@@ -58,8 +56,8 @@ send:region:DE081150045045 ...@@ -58,8 +56,8 @@ send:region:DE081150045045
``` ```
Werden nicht alle zwölf Stellen des ARS angegeben, sondern nur ein Prefix des ARS, so können statt einer spezifischen Werden nicht alle zwölf Stellen des ARS angegeben, sondern nur ein Prefix des ARS, so können statt einer spezifischen
Gemeinde auch darüberliegende Kreise, Regierungsbezirke oder Bundesländer abgebildet werden. Wird ein solcher Prefix Gemeinde auch darüberliegende Kreise, Regierungsbezirke oder Bundesländer abgebildet werden.
eines ARS angegeben, schließt dieser alle sich darin befindlichen Gliederungen mit ein. Wird ein solcher Prefix eines ARS angegeben, schließt dieser alle sich darin befindlichen Gliederungen mit ein.
**Beispiel**: Dieser Schlüssel steht für alle Leistungen in der Region Stuttgart und schließt alle darunterliegenden **Beispiel**: Dieser Schlüssel steht für alle Leistungen in der Region Stuttgart und schließt alle darunterliegenden
Landkreise, Städte und Gemeinden mit ein: Landkreise, Städte und Gemeinden mit ein:
...@@ -84,9 +82,8 @@ send:region:DE ...@@ -84,9 +82,8 @@ send:region:DE
Eine Einschränkung auf konkrete Verwaltungsebenen ist durch das Auffüllen des ARS auf zwölf Stellen mit Nullen möglich. Eine Einschränkung auf konkrete Verwaltungsebenen ist durch das Auffüllen des ARS auf zwölf Stellen mit Nullen möglich.
**Beispiel**: Der folgende Schlüssel referenziert explizit nur den Kreis Böblingen, nicht jedoch beispielsweise die **Beispiel**: Der folgende Schlüssel referenziert explizit nur den Kreis Böblingen, nicht jedoch beispielsweise die Stadt Leonberg, die im Kreis Böblingen liegt.
Stadt Leonberg, die im Kreis Böblingen liegt. Hierdurch ist eine Einschränkung auf Zustellpunkte möglich, die von der Hierdurch ist eine Einschränkung auf Zustellpunkte möglich, die von der Kreisverwaltung Böblingen betrieben werden, ohne eine Berechtigung für Zustellpunkte der Stadt Leonberg zu gewähren.
Kreisverwaltung Böblingen betrieben werden, ohne eine Berechtigung für Zustellpunkte der Stadt Leonberg zu gewähren.
``` ```
send:region:DE081150000000 send:region:DE081150000000
...@@ -95,8 +92,8 @@ send:region:DE081150000000 ...@@ -95,8 +92,8 @@ send:region:DE081150000000
### Einschränkung: Leistungstypen ### Einschränkung: Leistungstypen
Um sendende Systeme zur Einreichung bei allen Zustellpunkten eines bestimmten Leistungstyps zu berechtigen, ist eine Um sendende Systeme zur Einreichung bei allen Zustellpunkten eines bestimmten Leistungstyps zu berechtigen, ist eine
Vergabe von Berechtigungen auf Basis von Leistungs-IDs möglich. Ein Download des Leistungskatalogs mit allen Vergabe von Berechtigungen auf Basis von Leistungs-IDs möglich.
LeiKa-Schlüsseln ist [über das FIM-Portal](https://fimportal.de/kataloge#download-leistungen) möglich. Ein Download des Leistungskatalogs mit allen LeiKa-Schlüsseln ist [über das FIM-Portal](https://fimportal.de/kataloge#download-leistungen) möglich.
**Beispiel**: Berechtigung für die LeiKa-Leistung **Beispiel**: Berechtigung für die LeiKa-Leistung
"[Begutachung von abgeschleppten Fahrzeugen](https://fimportal.de/detail/L/99108008252000)": "[Begutachung von abgeschleppten Fahrzeugen](https://fimportal.de/detail/L/99108008252000)":
...@@ -105,9 +102,9 @@ LeiKa-Schlüsseln ist [über das FIM-Portal](https://fimportal.de/kataloge#downl ...@@ -105,9 +102,9 @@ LeiKa-Schlüsseln ist [über das FIM-Portal](https://fimportal.de/kataloge#downl
send:service:urn:de:fim:leika:leistung:99108008252000 send:service:urn:de:fim:leika:leistung:99108008252000
``` ```
**Hinweis**: Eine Einschränkung auf bestimmte Leistungstypen erfolgt im Autorisierungsserver **immer** kombiniert mit **Hinweis**: Eine Einschränkung auf bestimmte Leistungstypen erfolgt im Autorisierungsserver **immer** kombiniert mit einer geographische Zuordnung.
einer geographische Zuordnung. Um ein sendendes System zur Einreichung bei allen existierenden Zustellpunkten eines Um ein sendendes System zur Einreichung bei allen existierenden Zustellpunkten eines Leistungstyps zu berechtigen wird der Schlüssel `send:region:DE` genutzt (siehe nächster Abschnitt).
Leistungstyps zu berechtigen wird der Schlüssel `send:region:DE` genutzt (siehe nächster Abschnitt). Hier wäre das: Hier wäre das:
``` ```
send:region:DE+send:service:urn:de:fim:leika:leistung:99108008252000 send:region:DE+send:service:urn:de:fim:leika:leistung:99108008252000
...@@ -115,12 +112,10 @@ send:region:DE+send:service:urn:de:fim:leika:leistung:99108008252000 ...@@ -115,12 +112,10 @@ send:region:DE+send:service:urn:de:fim:leika:leistung:99108008252000
### Einschrankung: Region+Leistungstyp ### Einschrankung: Region+Leistungstyp
Über die Kombination einer geographischen Zuordnung mit einem Leistungstyp über das Plus-Symbol (`+`) ist eine Über die Kombination einer geographischen Zuordnung mit einem Leistungstyp über das Plus-Symbol (`+`) ist eine Einschränkung auf Verwaltungsleistungen in einer bestimmten Region möglich.
Einschränkung auf Verwaltungsleistungen in einer bestimmten Region möglich. Hierbei wird immer zuerst ("vor dem `+`") Hierbei wird immer zuerst ("vor dem `+`") eine Einschränkung nach der Region und dann ("nach dem `+`") eine Einschränkung nach dem Leistungstyp vorgenommen.
eine Einschränkung nach der Region und dann ("nach dem `+`") eine Einschränkung nach dem Leistungstyp vorgenommen.
**Beispiel**: Der folgende Zustellberechtigungs-Scope berechtigt zur Einreichung für die LeiKa-Leistung **Beispiel**: Der folgende Zustellberechtigungs-Scope berechtigt zur Einreichung für die LeiKa-Leistung "[Begutachung von abgeschleppten Fahrzeugen](https://fimportal.de/detail/L/99108008252000)" im Landkreis Böblingen:
"[Begutachung von abgeschleppten Fahrzeugen](https://fimportal.de/detail/L/99108008252000)" im Landkreis Böblingen:
``` ```
send:region:DE08115+send:service:urn:de:fim:leika:leistung:99108008252000 send:region:DE08115+send:service:urn:de:fim:leika:leistung:99108008252000
...@@ -128,15 +123,11 @@ send:region:DE08115+send:service:urn:de:fim:leika:leistung:99108008252000 ...@@ -128,15 +123,11 @@ send:region:DE08115+send:service:urn:de:fim:leika:leistung:99108008252000
### Erteilung mehrerer Zustellberechtigungen ### Erteilung mehrerer Zustellberechtigungen
Der `scope` Claim des Access Tokens kann mehrere Zustellberechtigungs-Scopes – separiert mit Leerzeichen Der `scope` Claim des Access Tokens kann mehrere Zustellberechtigungs-Scopes – separiert mit Leerzeichen gemäß [RFC 6749, Abschnitt 3.3](https://datatracker.ietf.org/doc/html/rfc6749#section-3.3) – enthalten.
gemäß [RFC 6749, Abschnitt 3.3](https://datatracker.ietf.org/doc/html/rfc6749#section-3.3) – enthalten. Diese sind Diese sind unabhängig voneinander zu betrachten.
unabhängig voneinander zu betrachten. Ein sendendes System ist zur Einreichung bei allen Zustellpunkten berechtigt, auf Ein sendendes System ist zur Einreichung bei allen Zustellpunkten berechtigt, auf die mindestens einer der Zustellberechtigungs-Scopes zutrifft.
die mindestens einer der Zustellberechtigungs-Scopes zutrifft.
**Beispiel**: Mit diesem Zustellberechtigungs-Scope kann ein sendendes System Einreichungen für alle Leistungen im **Beispiel**: Mit diesem Zustellberechtigungs-Scope kann ein sendendes System Einreichungen für alle Leistungen im Landkreis Böblingen, als auch die Leistung "[Begutachung von abgeschleppten Fahrzeugen](https://fimportal.de/detail/L/99108008252000)" im Bundesland Brandenburg vornehmen:
Landkreis Böblingen, als auch die
Leistung "[Begutachung von abgeschleppten Fahrzeugen](https://fimportal.de/detail/L/99108008252000)"
im Bundesland Brandenburg vornehmen:
``` ```
send:region:DE08115 send:region:DE12+send:service:urn:de:fim:leika:leistung::99108008252000 send:region:DE08115 send:region:DE12+send:service:urn:de:fim:leika:leistung::99108008252000
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment