Dokumentacja interfejsu API REST autoryzowanych zasobów

Interfejs API zarządzania klientami internetowego IQ Microsoft zwraca istniejących klientów, konta rozliczeniowe web IQ i identyfikatory APPID web IQ dostępne dla uwierzytelnioowanego obiektu wywołującego. Odnajdywanie nie tworzy konta ani nie udziela dostępu.

Punkt końcowy:GET https://api.microsoft.ai/v1/customer/authorized-resources

Aby zapoznać się z krokami udzielania dostępu przez administratora i szczegółowym przewodnikiem, zobacz Filtrowanie wyników za pomocą zakresów.

Uwierzytelnianie i żądanie

Obciążenia używają tokenu elementu nośnego Microsoft Entra tylko dla aplikacji żądanego za pomocą polecenia https://api.microsoft.ai/.default. Tożsamość obciążenia musi być aktywna i mieć CustomerApiAccess na każdym zamierzonym koncie rozliczeniowym. Klucz interfejsu API wyszukiwania środowiska uruchomieniowego lub powiązanie identyfikatora appID wyszukiwania nie udziela dostępu do zarządzania.

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

Do wywołania odnajdywania nie trzeba wywoływać identyfikatora klienta, identyfikatora konta rozliczeniowego ani identyfikatora aplikacji internetowego IQ.

Response

Protokół HTTP 200 OK zwraca tablicę obiektów klienta. Każdy klient zawiera tablicę billingAccounts :

[
  {
    "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": []
      }
    ]
  }
]

Pole	Typ	Description
customerId	string (UUID)	Identyfikuje klienta zawierającego konta rozliczeniowe. Nie identyfikator używany w trasach zakresu.
displayName	ciąg	Nazwa wyświetlana klienta lub konta rozliczeniowego.
billingAccounts	macierz	Konta rozliczeniowe dostępne dla obiektu wywołującego w ramach tego klienta.
billingAccounts[].billingAccountId	string (UUID)	Użyj tego identyfikatora w trasach zarządzania zakresem. Wybierz zamierzone konto jawnie, a nie automatycznie biorąc pierwsze wyniki.
billingAccounts[].isTrial	boolean	Czy konto rozliczeniowe jest wersją próbną. Klienci i konta muszą być aktywni; Wygasłe próby są wykluczone.
billingAccounts[].appProfiles	macierz	Identyfikatory APPID sieci Web i ich metadane konfiguracji. Konto może pojawić się z pustą tablicą.
billingAccounts[].appProfiles[].appId	ciąg	Internetowy identyfikator appID IQ należący do konta rozliczeniowego. Nie jest to identyfikator aplikacji Entra (klienta).
permissions.canWrite	boolean	Starszy dostęp do zapisu konfiguracji rozliczeń na koncie rozliczeniowym lub kliencie. Nie flaga możliwości zapisu zakresu: CustomerApiAccess może zezwalać na zapisy zakresu, gdy jest falseto .

Prawidłowe, ale nieznane lub nieprzypisane obciążenie może odbierać 200 OK za pomocą polecenia []. Nie jest to błąd usługi i może wystąpić nawet wtedy, gdy ta sama tożsamość może wywołać wyszukiwanie. Sprawdź jego uprawnienia do zarządzania i uprawnienia do konta, a nie wielokrotnie wywoływanie odnajdywania w celu aprowizacji dostępu.

Kody stanu

Status	Meaning	Action
200	Istniejąca autoryzowana hierarchia, prawdopodobnie pusta.	Wybierz billingAccounts[].billingAccountId. Jeśli zamierzone konto jest nieobecne, upewnij się, że administrator sprawdza parę dzierżawców/klientów, aktywną tożsamość, udzielanie konta i uprawnienia do konta.
400	Nieprawidłowa prośba.	Popraw dane wejściowe. Odnajdywanie jest tylko do odczytu i nie akceptuje żądań aprowizacji.
401	Brak, wygaśnięcie lub nieprawidłowe uwierzytelnianie.	Uzyskaj prawidłowy token tylko dla aplikacji za pomocą polecenia https://api.microsoft.ai/.default.
403	Rozpoznany podmiot zabezpieczeń jest nieaktywny lub niespójny.	Upewnij się, że administrator zweryfikuje tożsamość obciążenia i dostęp do konta.
500 lub 503	Awaria usługi lub zależności.	Ponów próbę odczytu z ograniczonym wycofywaniem. Nie traktuj tego jako pustego pomyślnego wyniku.

Aby uzyskać pomoc dotyczącą trwałych niepowodzeń, skontaktuj się z pomocą techniczną internetowego uwierzytelniania IQ ze szczegółami żądania oczyszczonego, nigdy nie tokenów ani poświadczeń aplikacji.