REST-API-Referenz für autorisierte Ressourcen

Die Microsoft Web IQ Customer Management API gibt die vorhandenen Kunden, Web IQ Abrechnungskonten und Web IQ AppIDs zurück, die für den authentifizierten Aufrufer verfügbar sind. Discovery erstellt kein Konto oder gewährt keinen Zugriff.

Endpunkt:GET https://api.microsoft.ai/v1/customer/authorized-resources

Informationen zu den Schritten zur Zugriffserteilung des Administrators und einer end-to-end-exemplarischen Vorgehensweise finden Sie unter "Filterergebnisse mit Bereichen".

Authentifizierung und Anforderung

Workloads verwenden ein Nur-App-Microsoft Entra Bearertoken, das mit https://api.microsoft.ai/.default. Die Workloadidentität muss aktiv sein und CustomerApiAccess auf jedem vorgesehenen Abrechnungskonto verfügen. Ein Laufzeitsuch-API-Schlüssel oder eine AppID-Suchbindung gewährt keinen Verwaltungszugriff.

GET /v1/customer/authorized-resources HTTP/1.1
Host: api.microsoft.ai
Authorization: Bearer <access-token>
Accept: application/json

Es ist keine Kunden-ID, Abrechnungskonto-ID oder Web IQ AppID erforderlich, um die Ermittlung aufzurufen.

Antwort

HTTP 200 OK gibt ein Array von Kundenobjekten zurück. Jeder Kunde enthält ein billingAccounts Array:

[
  {
    "customerId": "11111111-1111-4111-8111-111111111111",
    "displayName": "Example customer",
    "permissions": { "canWrite": false },
    "billingAccounts": [
      {
        "billingAccountId": "22222222-2222-4222-8222-222222222222",
        "displayName": "Example billing account",
        "isTrial": false,
        "permissions": { "canWrite": false },
        "appProfiles": []
      }
    ]
  }
]
Feld Typ Description
customerId string (UUID) Identifiziert den Kunden, der die Abrechnungskonten enthält. Nicht die ID, die in Bereichsrouten verwendet wird.
displayName string Anzeigename des Kunden- oder Abrechnungskontos.
billingAccounts array Abrechnungskonten, die dem Anrufer innerhalb dieses Kunden zur Verfügung stehen.
billingAccounts[].billingAccountId string (UUID) Verwenden Sie diese ID in Bereichsverwaltungsrouten. Wählen Sie das beabsichtigte Konto explizit aus, anstatt das erste Ergebnis automatisch zu übernehmen.
billingAccounts[].isTrial boolean Gibt an, ob das Abrechnungskonto eine Testversion ist. Kunden und Konten müssen aktiv sein; abgelaufene Testversionen sind ausgeschlossen.
billingAccounts[].appProfiles array Web IQ AppIDs und deren Konfigurationsmetadaten. Ein Konto kann mit einem leeren Array angezeigt werden.
billingAccounts[].appProfiles[].appId string Web IQ AppID gehört zum Abrechnungskonto. Keine Entra-Anwendungs-ID (Client-ID).
permissions.canWrite boolean Schreibzugriff auf ältere Abrechnungskonfigurationen entweder auf das Kunden- oder Abrechnungskonto. Kein Flag für die Bereichsschreibfunktion: CustomerApiAccess Kann Bereichsschreibvorgänge zulassen, wenn dies der Fall ist false.

Eine gültige, aber unbekannte oder nicht zugewiesene Workload kann empfangen 200 OK mit []. Dies ist kein Dienstfehler und kann auch dann auftreten, wenn dieselbe Identität die Suche aufrufen kann. Überprüfen Sie ihre Verwaltungserteilung und Kontoberechtigung, anstatt die Ermittlung wiederholt aufzurufen, um Zugriff bereitzustellen.

Statuscodes

Status Meaning Action
200 Vorhandene autorisierte Hierarchie, möglicherweise leer. Wählen Sie billingAccounts[].billingAccountId aus. Wenn das beabsichtigte Konto nicht vorhanden ist, überprüfen Sie das Mandanten-/Clientpaar, die aktive Identität, die Kontoerteilung und die Kontoberechtigung.
400 Ungültige Anforderung. Korrigieren Sie die Eingabe. Die Ermittlung ist schreibgeschützt und akzeptiert keine Bereitstellungsanforderungen.
401 Fehlende, abgelaufene oder ungültige Authentifizierung. Erwerben Sie ein gültiges Nur-App-Token mit https://api.microsoft.ai/.default.
403 Der aufgelöste Prinzipal ist inaktiv oder inkonsistent. Lassen Sie den Administrator die Workloadidentität und den Kontozugriff überprüfen.
500 oder 503 Dienst- oder Abhängigkeitsfehler. Wiederholen Sie die Lesevorgänge mit gebundenen Backoffs. Behandeln Sie dies nicht als leeres erfolgreiches Ergebnis.

Um Hilfe bei dauerhaften Fehlern zu erhalten, wenden Sie sich an den Web IQ-Support mit sanitierten Anforderungsdetails, niemals token oder Anwendungsanmeldeinformationen.