Pobieranie domeny niestandardowej klienta
Dotyczy: Centrum partnerskie
Pobiera zasób CustomDomain.
Po utworzeniu nowego konta klienta w Centrum partnerskim zostanie przypisana unikatowa domena. Ta domena może służyć do identyfikowania klienta i może być również używana do innych celów, takich jak konfiguracja skrzynki pocztowej.
Wymagania wstępne
Poświadczenia zgodnie z opisem w temacie Uwierzytelnianie w Centrum partnerskim. Ten scenariusz obsługuje poświadczenia aplikacji i użytkownika lub uwierzytelnianie tylko dla aplikacji.
Identyfikator klienta (
customer-tenant-id
). Jeśli nie znasz identyfikatora klienta, możesz go wyszukać w Centrum partnerskim. Wybierz obszar roboczy Klienci na stronie głównej Centrum partnerskiego. Wybierz klienta z listy Klient, a następnie wybierz pozycję Konto. Na stronie Konto klienta poszukaj identyfikatora Microsoft w sekcji Szczegóły konta klienta. Identyfikator Microsoft jest taki sam jak identyfikator klienta (customer-tenant-id
).
Ważne
Role GDAP są wymagane do wywołania tego interfejsu API. Język DAP nie jest obsługiwany. Uwierzytelnianie partnerów jest nadal wymagane (AdminAgent/HelpDeskAgent/SalesAgent)
Role GDAP
Potrzebujesz co najmniej jednej z następujących ról GDAP:
- Składnik zapisywania katalogów
- Czytelnik globalny
- Administrator domeny
Żądanie REST
Składnia żądania
Method | Identyfikator URI żądania |
---|---|
GET | {baseURL}/v1/customers/{customer-tenant-id}/customDomains HTTP/1.1 |
Parametr identyfikatora URI
Użyj następującego parametru zapytania dla określonego klienta.
Nazwisko | Type | Wymagania | opis |
---|---|---|---|
identyfikator dzierżawy klienta | guid | Y | Wartość to identyfikator GUID sformatowany jako customer-tenant-id , który umożliwia odsprzedawcy filtrowanie wyników dla danego klienta należącego do odsprzedawcy. |
Nagłówki żądań
Aby uzyskać więcej informacji, zobacz Nagłówki REST Centrum partnerskiego.
Treść żądania
Brak.
Przykład żądania
GET https://api.partnercenter.microsoft.com/v1/customers/{customer-tenant-id}/customDomains HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
MS-RequestId: 74ca1db9-df92-41c6-a362-a16433b0542b
Odpowiedź REST
Jeśli ta metoda powiedzie się, ta metoda zwraca zasób domeny niestandardowej w treści odpowiedzi.
Kody powodzenia i błędów odpowiedzi
Każda odpowiedź zawiera kod stanu HTTP, który wskazuje powodzenie lub niepowodzenie i inne informacje o debugowaniu. Użyj narzędzia do śledzenia sieci, aby odczytać ten kod, typ błędu i inne parametry. Aby uzyskać pełną listę, zobacz Kody błędów.
Przykład odpowiedzi
HTTP/1.1 200 OK
Content-Length: 1530
Content-Type: application/json; charset=utf-8
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
MS-RequestId: 74ca1db9-df92-41c6-a362-a16433b0542b
["contosco.onmicrosoft.com"]