Skip to content
Snippets Groups Projects

Rephrase OAuth token handling description

Merged Marco Holz requested to merge mr-authentication-improvements into main
1 file
+ 7
3
Compare changes
  • Side-by-side
  • Inline
@@ -18,10 +18,11 @@ Die URL der Submission API und die OAuth-Token-URL finden sich im Artikel [Erste
Fast alle Anfragen an die FIT-Connect Submission API müssen authentifiziert werden.
Hierfür ist ein Access Token notwendig, das beim OAuth-Dienst über die hierfür vorgesehene OAuth-Token-URL abgerufen werden kann.
Für den Abruf von Access Tokens ist die [Konfiguration eines API-Client im Self-Service-Portal](./account.mdx) nötig.
Bei der Konfiguration eines API-Client werden `client_id` und `client_secret` erzeugt.
Das Token kann anschließend bei Anfragen über den `Authorization` Header mitgeschickt werden.
Da ein Token **max. 30 Minuten** gültig ist, muss dieses rechtzeitig erneuert werden.
Wenn keine spezifischer Scope angefragt wird (siehe nächster Abschnitt), enthält der Access Token alle Scopes, die zu diesem Zeitpunkt beim Client im Self-Service-Portal hinterlegt wurden.
Da ein Token **max. 30 Minuten** gültig ist, muss dieses regelmäßig erneuert werden.
### Abfrage von Access Tokens mit allen zugewiesenen Scopes
<Tabs
defaultValue="curl"
@@ -77,6 +78,8 @@ $ curl \
</TabItem>
</Tabs>
Wenn keine spezifischer Scope angefragt wird (siehe nächster Abschnitt), enthält der Access Token alle Scopes, die zu diesem Zeitpunkt beim Client im Self-Service-Portal hinterlegt wurden.
### Abfrage von Access Tokens mit spezifischen Scopes
Es ist möglich den Scope des Access Tokens zu beschränken.
@@ -110,6 +113,7 @@ Weiterführende Details zu den Scopes finden sich hier:
## Zugriff auf die API mittels Access Token
Access Tokens werden vom OAuth-Dienst erzeugt und DÜRFEN NIEMALS an dritte Systeme (mit Ausnahme des Zustelldienstes zum Zwecke der Authentifizierung) weitergegeben werden.
Beim Zugriff auf die Submission API wird muss ein Access Token im `Authorization`-Header mit `Bearer`-Authentifizierungsschema gemäß [RFC 6750](https://datatracker.ietf.org/doc/html/rfc6750) an den Zustelldienst übermittelt werden:
**Beispiel**
Loading