Hämta en kunds anpassade domän
Gäller för: Partnercenter
Hämtar en CustomDomain-resurs .
När ett nytt kundkonto skapas i Partnercenter tilldelas det en unik domän. Den här domänen kan användas för att identifiera en kund, och den kan också användas för andra syften, till exempel postlådeuppsättning.
Förutsättningar
Autentiseringsuppgifter enligt beskrivningen i Partnercenter-autentisering. Det här scenariot stöder autentiseringsuppgifter för app+användare eller endast appautentisering.
Ett kund-ID (
customer-tenant-id
). Om du inte känner till kundens ID kan du leta upp det i Partnercenter. Välj arbetsytan Kunder på startsidan för Partnercenter. Välj kunden i kundlistan och välj sedan Konto. På kundens kontosida letar du efter Microsoft-ID:t i avsnittet Kundkontoinformation. Microsoft-ID:t är samma som kund-ID :t (customer-tenant-id
).
Viktigt!
GDAP-roller krävs för att anropa det här API:et. DAP stöds inte. Partnerautentisering krävs fortfarande (AdminAgent/HelpDeskAgent/SalesAgent)
GDAP-roller
Du behöver minst en av följande GDAP-roller:
- Katalogskrivare
- Global läsare
- Domänadministratör
REST-begäran
Syntax för begäran
Metod | URI för förfrågan |
---|---|
GET | {baseURL}/v1/customers/{customer-tenant-id}/customDomains HTTP/1.1 |
URI-parameter
Använd följande frågeparameter för en specifik kund.
Namn | Typ | Obligatoriskt | Beskrivning |
---|---|---|---|
customer-tenant-id | GUID | Y | Värdet är ett GUID-formaterat kund-klient-ID som gör att återförsäljaren kan filtrera resultatet för en viss kund som tillhör återförsäljaren. |
Begärandehuvuden
Mer information finns i REST-huvuden för Partnercenter.
Begärandetext
Inga.
Exempel på begäran
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
REST-svar
Om det lyckas returnerar den här metoden en anpassad domänresurs i svarstexten.
Svarsframgång och felkoder
Varje svar levereras med en HTTP-statuskod som anger lyckad eller misslyckad och annan felsökningsinformation. Använd ett verktyg för nätverksspårning för att läsa den här koden, feltypen och andra parametrar. Den fullständiga listan finns i Felkoder.
Svarsexempel
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"]