Entwicklerwerkzeuge

Der Entwicklerbereich der Auris-Konsole bietet eine Suite von Werkzeugen zum Erstellen, Testen und Debuggen von Integrationen mit Auris. Diese Werkzeuge sind darauf ausgelegt, die Zeit zwischen „Ich möchte Auris integrieren” und „Authentifizierung funktioniert in meiner Anwendung” zu reduzieren.

Zugriff auf den Developer Hub unter Konsole → Entwickler → Hub.

Developer-Hub-Übersicht

Der Developer Hub ist eine Landing Page mit sechs Karten, die zu jedem Entwicklerwerkzeug verlinken:

Zusätzlich bietet die Seite Entwicklerdokumentation interne Referenzanleitungen mit Code-Blöcken für häufige Integrationsaufgaben.

API Explorer

Der API Explorer bietet eine durchsuchbare Referenz aller Auris-API-Endpunkte, organisiert in 9 Abschnitte. Zugriff unter Konsole → Entwickler → API Explorer.

API-Abschnitte

Den API Explorer verwenden

Jeder Abschnitt expandiert zu einzelnen Endpunkten mit:

• HTTP-Methode und Pfad (z. B. POST /api/auth/token)
• Anfrageparameter: Abfrageparameter, Pfadparameter und Anfrage-Body-Schema
• Antwortformat: Beispiel-Erfolgs- und Fehlerantwort-Bodies
• Authentifizierungsanforderung: Welche Endpunkte ein Bearer-Token erfordern und welche öffentlich sind

Der API Explorer ist ein Referenzwerkzeug — er zeigt das Anfrage- und Antwortformat, führt aber keine API-Aufrufe aus. Verwende die Sandbox für Live-Tests.

Token-Decoder

Der Token-Decoder ermöglicht es dir, ein beliebiges JWT einzufügen und seinen dekodierten Inhalt zu sehen. Zugriff unter Konsole → Entwickler → Token-Decoder.

Verwendung

{
  "alg": "RS256",
  "kid": "key-id-1",
  "typ": "JWT"
}

{
  "sub": "usr_abc123",
  "iss": "https://auth.ihrfirmenname.de",
  "aud": "ihre-client-id",
  "iat": 1739880000,
  "exp": 1739880900,
  "email": "[email protected]",
  "roles": ["editor"],
  "acr": "urn:auris:acr:mfa",
  "amr": ["pwd", "otp"]
}

Häufige Anwendungsfälle

• Ansprüche debuggen: Verifizieren, dass benutzerdefinierte Ansprüche, Rollen und Scopes im Token vorhanden sind
• Ablauf prüfen: Feststellen, ob ein 401-Fehler durch ein abgelaufenes Token verursacht wird
• ACR/AMR verifizieren: Bestätigen, dass Step-up-Authentifizierungsansprüche nach MFA enthalten sind
• M2M-Token untersuchen: type: "m2m" und Scope-Ansprüche für Client-Credentials-Token prüfen
• DPoP validieren: Auf cnf.jkt-Anspruch in DPoP-gebundenen Token prüfen

Sandbox

Die Sandbox bietet eine Live-API-Testumgebung, die mit deinem Tenant verbunden ist. Zugriff unter Konsole → Entwickler → Sandbox.

Funktionsweise

Die Sandbox füllt Authentifizierungs-Header vorab mit deinem aktuellen Admin-Session-Token und dem x-tenant-Header mit deiner Tenant-ID. Du kannst:

1. Einen API-Endpunkt aus dem Dropdown auswählen (in denselben 9 Abschnitten wie der API Explorer organisiert)
2. Anfrageparameter ausfüllen (Pfadparameter, Abfrageparameter, Body)
3. Auf Senden klicken, um die Anfrage gegen die Live Auris-API auszuführen
4. Den Antwort-Statuscode, -Header und -Body anzeigen

Vorab ausgefüllter Kontext

Das bedeutet, du kannst sofort Endpunkte testen, ohne manuell Header zu konstruieren.

Beispiel: Eine Berechtigungsprüfung testen

1. Wähle POST /api/roles/check aus dem Endpunkt-Dropdown
2. Gib den Anfrage-Body ein:

{
  "userId": "usr_abc123",
  "permission": "view:invoices",
  "applicationId": "app_xyz789"
}

3. Klicke auf Senden
4. Sieh die Antwort:

{
  "ok": true,
  "data": {
    "allowed": true,
    "source": "role_permission",
    "role": "editor"
  }
}

Quickstarts

Der Quickstarts-Assistent bietet schrittweise Anleitungen zur Integration von Auris in deine Anwendung. Zugriff unter Konsole → Entwickler → Quickstarts.

Interaktiver Einrichtungsassistent

Der Assistent führt durch drei Schritte:

npm install @auris/react

import { AurisProvider } from '@auris/react'
 
function App({ children }) {
  return (
    <AurisProvider
      domain="auth.ihrfirmenname.de"
      clientId="ihre-tatsächliche-client-id"
    >
      {children}
    </AurisProvider>
  )
}

import { useAuris } from '@auris/react'
 
function LoginButton() {
  const { loginWithRedirect, isAuthenticated, user } = useAuris()
 
  if (isAuthenticated) {
    return <p>Willkommen, {user.name}</p>
  }
 
  return <button onClick={() => loginWithRedirect()}>Anmelden</button>
}

Erweiterte Themen

Unterhalb des Haupt-3-Schritt-Assistenten enthält die Quickstarts-Seite einen Abschnitt Erweiterte Themen mit Code-Snippets für:

Jedes Thema enthält ein funktionierendes Code-Beispiel mit vorab ausgefüllten Anmeldedaten deiner Anwendung.

CLI-Werkzeug

Die CLI-Werkzeug-Referenzseite dokumentiert die auris-Befehlszeilenschnittstelle zur Verwaltung deines Tenants von einem Terminal aus. Zugriff auf die Referenz unter Konsole → Entwickler → CLI.

Verfügbare Befehle

Installation

npm install -g @auris/cli

Authentifizierung

Die CLI verwendet denselben OAuth2-Ablauf wie die Konsole. Das Ausführen von auris login öffnet ein Browserfenster zur Authentifizierung und speichert das Token lokal.

SDK-Übersicht

Die SDK-Übersichtsseite vergleicht Funktionen über die drei SDK-Pakete hinweg. Zugriff unter Konsole → Entwickler → SDKs.

Funktionsvergleich

Paketdetails

Entwicklerdokumentation

Die Entwicklerdokumentationsseite bietet interne Referenzanleitungen, die in einklappbaren Abschnitten organisiert sind. Zugriff unter Konsole → Entwickler → Docs.

Anleitungsabschnitte

Jeder Abschnitt enthält:

• Prägnanten erklärenden Text
• Code-Blöcke mit Syntaxhervorhebung
• Kopieren-Schaltflächen auf allen Code-Blöcken
• Schnelllinks zur vollständigen Dokumentation für tieferes Lesen

Die Entwicklerdokumentationsseite ist als Kurzreferenz konzipiert, die innerhalb der Konsole bleibt, und vermeidet Kontextwechsel zur externen Dokumentation für häufige Aufgaben.

Zugehörige Anleitungen

• SDKs — Vollständige SDK-Dokumentation
• API-Referenz — Vollständige API-Endpunkt-Dokumentation
• Anwendungen — In Quickstarts verwendete Anwendungen konfigurieren
• Quickstarts-Tutorial — Vollständige Einstiegsanleitung