Uzyskiwanie zgody klienta jako dostawcy Panel sterowania
Jako dostawca Panel sterowania (CPV) możesz użyć interfejsów API REST do uzyskania i usunięcia zgody od klientów CSP, aby uzyskać uprawnienia do swoich dzierżaw.
POST https://api.partnercenter.microsoft.com/v1/customers/{<customer_id>}/applicationconsents
Uwaga
Limit szybkości to 50 żądań na sekundę (RPS) dla każdego identyfikatora aplikacji (identyfikator aplikacji partnera CPV).
Uzyskiwanie zgody
Parametry identyfikatora URI
Nazwisko | W | Wymagania | Type | Opis |
---|---|---|---|---|
customer_id | path | Prawda | string | Identyfikator klienta wygenerowanego w Centrum partnerskim |
Nagłówek żądania
Typy multimediów: application/json
Nazwisko | Wymagania | Type | Opis |
---|---|---|---|
Autoryzacja | Prawda | string | Token dostępu dla odbiorców https://api.partnercenter.microsoft.com |
Zaakceptuj | Prawda | string | Akceptowalny typ zawartości; powszechnie akceptowana aplikacja typu/json |
ms-correlationid | string | Służy do śledzenia żądań wewnętrznie. Jeśli nie podano identyfikatora ms-correlationid, serwer generuje nowy dla każdego żądania | |
ms-requestid | string | Służy do idempotentności żądań. Jeśli parametr ms-requestid nie jest podany, serwer generuje nowy dla każdego żądania |
Treść żądania
Typy multimediów: application/json
Nazwisko | Pisz | Opis |
---|---|---|
applicationId | string | Identyfikator aplikacji partnera CPV |
applicationGrants | Microsoft.Partner.Core.ApplicationConsents.ApplicationGrant[] | Lista dotacji aplikacji w celu uzyskania dostępu dla klientów w dzierżawie |
Odpowiedzi
Nazwisko | Pisz | Opis |
---|---|---|
200 OK | Żądanie zakończyło się pomyślnie. Typy multimediów: application/json , , application/xml text/xml ,text/json |
|
Utworzono 201 | Zostanie utworzona zgoda aplikacji. Typy multimediów: application/json , , application/xml text/xml ,text/json |
|
400 Nieprawidłowe żądanie | Brak danych wejściowych lub nieprawidłowych. Treść odpowiedzi zawiera szczegóły błędu. Typy multimediów: application/json , , application/xml text/xml ,text/json |
|
401 Brak autoryzacji | Żądanie nie zostało uwierzytelnione. Klient musi przekazać prawidłowy token dostępu dla prawidłowych odbiorców. Typy multimediów: application/json , , application/xml text/xml ,text/json |
|
403 Zabronione | Żądanie zostało uwierzytelnione, ale zostało odrzucone, ponieważ obiekt wywołujący nie ma uprawnień do jego wywołania. Typy multimediów: application/json , , application/xml text/xml ,text/json |
|
404 Nie znaleziono | Zasób nie został znaleziony lub niedostępny z podanymi parametrami wejściowymi. Typy multimediów: application/json , , application/xml text/xml ,text/json |
|
500 Wewnętrzny błąd serwera | Usługa interfejsu API partnera lub jedna z jego zależności nie spełniła żądania. Osoby wywołujące mogą ponowić próbę żądania. Typy multimediów: application/json , , application/xml text/xml ,text/json |
Definicje
Microsoft.Partner.Core.ApplicationConsents.ApplicationGrant
Nazwisko | Pisz | Opis |
---|---|---|
EnterpriseApplicationId | string | Reprezentacja identyfikatora GUID zasobu uzyskującego dostęp |
zakres | string | Wartości rozdzielone przecinkami zakresu na potrzeby uzyskiwania dostępu |
Usuwanie zgody
DELETE https://api.partnercenter.microsoft.com/v1/customers/{customer_id}/applicationconsents/{application_id}
Uwaga
Limit szybkości to 50 żądań na sekundę (RPS) dla każdego identyfikatora aplikacji (identyfikator aplikacji partnera CPV).
Parametry identyfikatora URI
Nazwisko | W | Wymagania | Type | Opis |
---|---|---|---|---|
customer_id | path | Prawda | string | Identyfikator klienta wygenerowanego w Centrum partnerskim |
Application_id | path | Prawda | string | Identyfikator aplikacji CPV |
Nagłówek żądania
Typy multimediów: application/json
Nazwisko | Wymagania | Type | Opis |
---|---|---|---|
Autoryzacja | Prawda | string | Token dostępu dla odbiorców https://api.partnercenter.microsoft.com |
Zaakceptuj | Prawda | string | Akceptowalny typ zawartości, zazwyczaj typ application/json |
ms-correlationid | string | Służy do śledzenia żądań wewnętrznie. Jeśli element ms-correlationid nie jest podany, serwer generuje nowy dla każdego żądania |
|
ms-requestid | string | Służy do idempotentności żądań. Jeśli parametr ms-requestid nie jest podany, serwer generuje nowy dla każdego żądania |
Odpowiedzi
Nazwisko | Pisz | Opis |
---|---|---|
200 OK | Żądanie zakończyło się pomyślnie. Typy multimediów: application/json , , application/xml text/xml ,text/json |
|
Utworzono 201 | Zgoda aplikacji zostanie usunięta. Typy multimediów: application/json , , application/xml text/xml ,text/json |
|
400 Nieprawidłowe żądanie | Brak danych wejściowych lub nieprawidłowych. Treść odpowiedzi zawiera szczegóły błędu. Typy multimediów: application/json , , application/xml text/xml ,text/json |
|
401 Brak autoryzacji | Żądanie nie zostało uwierzytelnione. Klient musi przekazać prawidłowy token dostępu dla prawidłowych odbiorców. Typy multimediów: application/json , , application/xml text/xml ,text/json |
|
403 Zabronione | Żądanie zostało uwierzytelnione, ale zostało odrzucone, ponieważ obiekt wywołujący nie ma uprawnień do jego wywołania. Typy multimediów: application/json , , application/xml text/xml ,text/json |
|
404 Nie znaleziono | Zasób nie został znaleziony lub niedostępny z podanymi parametrami wejściowymi. Typy multimediów: application/json , , application/xml text/xml ,text/json |
|
500 Wewnętrzny błąd serwera | Usługa interfejsu API partnera lub jedna z jego zależności nie spełniła żądania. Osoby wywołujące mogą ponowić próbę żądania. Typy multimediów: application/json , , application/xml text/xml ,text/json |