Anbieter Authentifizierungsmethoden

Authentifizierungsmethoden

Zur Nutzung einer API ist es erforderlich, die benötigte Authentifizierungsinformationen zwischen Anbieter und Kunde auszutauschen. Hierzu werden Authentifizierungsmethoden vom Developer Portal unterstützt, die bei der Anlage einer API hinterlegt werden können. Wird eine API zu einer App hinzugefügt, so werden entsprechend der hinterlegten Authentifizierungsmethode Informationen vom Kunden während der Aktivierungsanfrage abgefragt bzw. zur Verfügung gestellt.

Verfügbare Authentifizierungsmethoden im Developer Portal:

Authentifizierungsmethoden	Beschreibung
Access-Token	Das Developer Portal erzeugt Access-Token und generiert entsprechende Access-Token-Hashes, die dem Kunden (Access-Token) und dem Anbieter (Access-Token-Hash) zur Verfügung gestellt werden. Der Kunde verwendet den Access-Token um sich an der vom Anbieter zur Verfügung gestellten API zu authentifizieren. Der Anbieter prüft anhand des vom Kunden übergebenen Access-Token, der hinterlegten Hash-Methode und dem Access-Token-Hash die Authentizität des Zugriffs.
Manuelle-Übergabe	Bei der Auswahl der Authentifizierungsmethode "Manuelle Übergabe" wird an der API keine Übergabemethode des Authenticators hinterlegt. Das bedeutet, dass der Austausch der Authentifizierungsinformationen individuell zwischen Anbieter und Kunde geregelt wird.

info

Manuelle-Übergabe ist als Default für jede API festgelegt.

Authentifizierungsmethode an der Organisation festlegen

Um eine Authentifizierungsmethode einer API zuordnen zu können, ist es notwendig, ein Authentifizierungsmethode für die Organisation festzulegen.

1. Menü: Meine Organisation
2. Reiter: Authentifizierungsmethoden
3. Methode hinzufügen

Mögliche Konfigurationen der Authentifizierungsmethode "Access-Token":

Verfahren	Länge des Strings	Laufzeit
SHA256	32 / 64 / 128	1 Jahr / 2 Jahre / unbegrenzt

danger

Für eine Organisation kann pro Authentifizierungsmethode immer nur ein Access-Token festgelegt werden!

Authentifizierungsmethode einer API zuordnen

Sobald die Authentifizierungsmethode für die Organisation hinterlegt wurde, kann diese 1 - n API-Produkten zugeordnet werden.

1. Neue API anlegen oder vorhandene API aktualisieren
2. Authentifizierungsmethode der API zuordnen

Sobald ein Admin eines Kunden die API zu einer App hinzugefügt hat und eine Aktivierungsanfrage stellt, wird die hinterlegte Authentifizierungsmethode verwendet und ein entsprechender Prozess, abhängig von der Methode, durchlaufen.

App-Access-Status

Der App-Access-Status zeigt deiner Organisation an, ob über eine App generell (alle Produkte der App) zugegriffen werden kann. Wird der generelle Zugriff der App vom Anbieter auf "rot" gesetzt, bekommt der Verantwortliche des Kunden eine Benachrichtigung inkl. einer Beschreibung, warum der Zugriff gesperrt ist.

info

Anbieter-Aktion: Ein Admin eines Anbieters kann den App-Access-Status via GUI oder API auf "rot" setzen. D.h., der Anbieter hat den Zugriff auf alle Services in der App gesperrt.

note

Der App-Access-Status beeinflusst nicht die an der App hinterlegten Authentifizierungsmittel. Die Authentifizierungsmittel sind somit unabhängig von der generellen Zugriffssperre (App-Access-Status) der App. Der Zugriffsstatus der einzelnen Authentifizierungsmittel bleibt davon unberührt.

Access für Apps

Begriff	Definition
Access	Benötigtes Authentifizierungsmittel (Authenticator), um auf eine API zugreifen zu können.
Access-Status	Der Access-Status zeigt den jeweiligen Status des Zugriffs eines Authentifizierungsmittels an.
Authenticator	Der Authenticator enthält die konkrete Authentifizierungsinformation, um auf eine API zugreifen zu können.