Abrufen der benutzerdefinierten Domäne eines Kunden
Gilt für: Partner Center
Ruft eine CustomDomain-Ressource ab.
Wenn ein neues Kundenkonto im Partner Center erstellt wird, wird ihm eine eindeutige Domäne zugewiesen. Diese Domäne kann verwendet werden, um einen Kunden zu identifizieren, und er kann auch für andere Zwecke verwendet werden, z. B. die Postfacheinrichtung.
Voraussetzungen
Anmeldeinformationen, wie unter Partner Center-Authentifizierung beschrieben. Dieses Szenario unterstützt app+Benutzeranmeldeinformationen oder nur die Nur-App-Authentifizierung.
Eine Kunden-ID (
customer-tenant-id
). Wenn Sie die ID des Kunden nicht kennen, können Sie sie im Partner Center nachschlagen. Wählen Sie auf der Partner Center-Startseite den Arbeitsbereich "Kunden " aus. Wählen Sie den Kunden aus der Kundenliste aus, und wählen Sie dann "Konto" aus. Suchen Sie auf der Kontoseite des Kunden im Abschnitt "Kundenkontodetails" nach der Microsoft-ID. Die Microsoft-ID entspricht der Kunden-ID (customer-tenant-id
).
Wichtig
GDAP-Rollen sind erforderlich, um diese API aufzurufen. DAP wird nicht unterstützt. Die Partnerauthentifizierung ist weiterhin erforderlich (AdminAgent/HelpDeskAgent/SalesAgent)
GDAP-Rollen
Sie benötigen mindestens eine der folgenden GDAP-Rollen:
- Verzeichnis schreiben
- Globaler Leser
- Domänenadministrator
REST-Anforderung
Anforderungssyntax
Methode | Anforderungs-URI |
---|---|
GET | {baseURL}/v1/customers/{customer-tenant-id}/customDomains HTTP/1.1 |
URI-Parameter
Verwenden Sie den folgenden Abfrageparameter für einen bestimmten Kunden.
Name | Type | Erforderlich | Beschreibung |
---|---|---|---|
customer-tenant-id | guid | Y | Der Wert ist eine GUID-formatierte Kundenmandanten-ID , die es dem Händler ermöglicht, die Ergebnisse für einen bestimmten Kunden zu filtern, der zum Händler gehört. |
Anforderungsheader
Weitere Informationen finden Sie unter Partner Center-REST-Header.
Anforderungstext
Keine.
Anforderungsbeispiel
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-Antwort
Bei erfolgreicher Ausführung gibt die Methode eine benutzerdefinierte Domänenressource im Antworttext zurück.
Erfolgs- und Fehlercodes der Antwort
Jede Antwort enthält einen HTTP-Statuscode, der Erfolg oder Fehler und andere Debuginformationen angibt. Verwenden Sie ein Netzwerkablaufverfolgungstool, um diesen Code, fehlertyp und andere Parameter zu lesen. Die vollständige Liste findest du unter Partner-API: REST-Fehlercodes.
Beispielantwort
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"]