Dodawanie zweryfikowanej domeny do listy zatwierdzonych domen dla istniejącego klienta

Artykuł
06/19/2024

Dotyczy: Centrum partnerskie | Centrum partnerskie obsługiwane przez firmę 21Vianet | Centrum partnerskie dla chmury firmy Microsoft dla instytucji rządowych USA

Jak dodać zweryfikowaną domenę do listy zatwierdzonych domen dla istniejącego klienta.

Wymagania wstępne

Musisz być partnerem, który jest rejestratorem domen.
Poświadczenia zgodnie z opisem w temacie Uwierzytelnianie w Centrum partnerskim. Ten scenariusz obsługuje uwierzytelnianie zarówno przy użyciu autonomicznych poświadczeń aplikacji, jak i aplikacji i użytkownika.
Identyfikator klienta (customer-tenant-id). Jeśli nie znasz identyfikatora klienta, możesz wyszukać go w Centrum partnerskim, wybierając obszar roboczy Klienci , a następnie klienta z listy klienta, a następnie pozycję Konto. Na stronie Konto klienta poszukaj identyfikatora Microsoft w sekcji Informacje o koncie klienta. Identyfikator Microsoft jest taki sam jak identyfikator klienta (customer-tenant-id).

Dodawanie zweryfikowanej domeny

Jeśli jesteś partnerem, który jest rejestratorem domen, możesz użyć interfejsu verifieddomain API, aby opublikować nowy zasób domeny na liście domen dla istniejącego klienta. W tym celu zidentyfikuj klienta przy użyciu identyfikatora CustomerTenantId. Określ wartość właściwości VerifiedDomainName. Przekaż zasób domeny w żądaniu z uwzględnionych właściwościami Name, Capability, AuthenticationType, Status i VerificationMethod. Aby określić, że nowa domena jest domeną federacyjną, ustaw właściwość AuthenticationType w zasobie Domeny na Federated, i uwzględnij zasób DomainFederationSettings w żądaniu. Jeśli metoda zakończy się pomyślnie, odpowiedź zawiera zasób domeny dla nowej zweryfikowanej domeny.

Domeny zweryfikowane niestandardowe

Podczas dodawania niestandardowej zweryfikowanej domeny domena, która nie jest zarejestrowana w onmicrosoft.com, należy ustawić właściwość CustomerUser.immutableId na unikatową wartość identyfikatora dla klienta, dla którego dodajesz domenę. Ten unikatowy identyfikator jest wymagany podczas procesu weryfikacji, gdy domena jest weryfikowana. Aby uzyskać więcej informacji na temat kont użytkowników klienta, zobacz Tworzenie kont użytkowników dla klienta.

Żądanie REST

Składnia żądania

Method	Identyfikator URI żądania
POST	{baseURL}/v1/customers/{CustomerTenantId}/verifieddomain HTTP/1.1

Parametr identyfikatora URI

Użyj następującego parametru zapytania, aby określić klienta, dla którego dodajesz zweryfikowaną domenę.

Nazwisko	Type	Wymagania	opis
CustomerTenantId	Identyfikator GUID	Y	Wartość jest identyfikatorem GUID sformatowanym identyfikatorem CustomerTenantId , który umożliwia określenie klienta.

Nagłówki żądań

Aby uzyskać więcej informacji, zobacz Nagłówki REST Centrum partnerskiego.

Treść żądania

W tej tabeli opisano wymagane właściwości w treści żądania.

Nazwisko	Type	Wymagania	opis
VerifiedDomainName	string	Tak	Zweryfikowana nazwa domeny.
Domena	obiekt	Tak	Zawiera informacje o domenie.
DomainFederationSettings	obiekt	Tak (Jeśli authenticationType = `Federated`)	Ustawienia federacji domeny, które mają być używane, jeśli domena jest domeną `Federated` , a nie domeną `Managed` .

Domain

W tej tabeli opisano wymagane i opcjonalne właściwości domeny w treści żądania.

Nazwisko	Type	Wymagania	opis
Typ uwierzytelniania	string	Tak	Określa, czy domena jest domeną `Managed` , czy domeną `Federated` . Obsługiwane wartości: `Managed`, `Federated`.
Możliwość	string	Tak	Określa możliwość domeny. Na przykład `Email`.
IsDefault	wartość logiczna dopuszczana do wartości null	Nie.	Wskazuje, czy domena jest domeną domyślną dzierżawy. Obsługiwane wartości: `True`, , `NullFalse`.
IsInitial	wartość logiczna dopuszczana do wartości null	Nie.	Wskazuje, czy domena jest domeną początkową. Obsługiwane wartości: `True`, , `NullFalse`.
Nazwisko	string	Tak	Nazwa domeny.
RootDomain	string	Nie	Nazwa domeny głównej.
Stan	string	Tak	Stan domeny. Na przykład `Verified`. Obsługiwane wartości: `Unverified`, , `PendingDeletionVerified`.
WeryfikacjaMethod	string	Tak	Typ metody weryfikacji domeny. Obsługiwane wartości: `None`, , `EmailDnsRecord`.

Ustawienia federacji domeny

W tej tabeli opisano wymagane i opcjonalne właściwości DomainFederationSettings w treści żądania.

Nazwisko	Type	Wymagania	opis
ActiveLogOnUri	string	Nie	Identyfikator URI logowania używany przez zaawansowanych klientów. Ta właściwość jest adresem URL uwierzytelniania STS partnera.
DefaultInteractiveAuthenticationMethod	string	Nie	Wskazuje domyślną metodę uwierzytelniania, która powinna być używana, gdy aplikacja wymaga od użytkownika interaktywnego logowania.
FederationBrandName	string	Nie	Nazwa marki federacyjnej.
Identyfikator IssuerUri	string	Tak	Nazwa wystawcy certyfikatów.
Identyfikator LogOffUri	string	Tak	Identyfikator URI wylogowania. Ta właściwość opisuje identyfikator URI wylogowania domeny federacyjnej.
MetadataExchangeUri	string	Nie	Adres URL określający punkt końcowy wymiany metadanych używany do uwierzytelniania z zaawansowanych aplikacji klienckich.
NextSigningCertificate	string	Nie	Certyfikat używany w przyszłości przez usługę STS usług AD FS w wersji 2 do podpisywania oświadczeń. Ta właściwość jest zakodowaną reprezentacją certyfikatu w formacie base64.
OpenIdConnectDiscoveryEndpoint	string	Nie	Punkt końcowy odnajdywania OpenID Connect usługi STS federacyjnej dostawcy tożsamości.
PassiveLogOnUri	string	Tak	Identyfikator URI logowania używany przez starszych pasywnych klientów. Ta właściwość to adres do wysyłania federacyjnych żądań logowania.
PreferredAuthenticationProtocol	string	Tak	Format tokenu uwierzytelniania. Na przykład `WsFed`. Obsługiwane wartości: `WsFed`, `Samlp`
PromptLoginBehavior	string	Tak	Typ zachowania logowania monitu. Na przykład `TranslateToFreshPasswordAuth`. Obsługiwane wartości: `TranslateToFreshPasswordAuth`, , `NativeSupportDisabled`
SigningCertificate	string	Tak	Certyfikat używany obecnie przez usługę ADFS w wersji 2 STS do podpisywania oświadczeń. Ta właściwość jest zakodowaną reprezentacją certyfikatu w formacie base64.
SigningCertificateUpdateStatus	string	Nie	Wskazuje stan aktualizacji certyfikatu podpisywania.
SigningCertificateUpdateStatus	wartość logiczna dopuszczana do wartości null	Nie.	Wskazuje, czy usługa STS dostawcy tożsamości obsługuje uwierzytelnianie wieloskładnikowe. Obsługiwane wartości: `True`, , `NullFalse`.

Przykład żądania

POST https://api.partnercenter.microsoft.com/v1/customers/{CustomerTenantId}/verifieddomain HTTP/1.1
Authorization: Bearer <token>
Accept: application/json, text/plain, */*
MS-RequestId: 312b044d-dc41-4b37-c2d5-7d27322d9654
MS-CorrelationId: 7cb67bb7-4750-403d-cc2e-6bc44c52d52c
Content-Type: application/json;charset=utf-8
X-Locale: "en-US"

{
    "VerifiedDomainName": "Example.com",
    "Domain": {
        "AuthenticationType": "Federated",
        "Capability": "Email",
        "IsDefault": Null,
        "IsInitial": Null,
        "Name": "Example.com",
        "RootDomain": null,
        "Status": "Verified",
        "VerificationMethod": "None"
    },
    "DomainFederationSettings": {
        "ActiveLogOnUri": "https://sts.microsoftonline.com/FederationPassive/",
        "DefaultInteractiveAuthenticationMethod": "http://schemas.microsoft.com/ws/2008/06/identity/authenticationmethod/password",
        "FederationBrandName": "FederationBrandName",
        "IssuerUri": "Example.com",
        "LogOffUri": "https://sts.microsoftonline.com/FederationPassive/",
        "MetadataExchangeUri": null,
        "NextSigningCertificate": null,
        "OpenIdConnectDiscoveryEndpoint": "https://sts.contoso.com/adfs/.well-known/openid-configuration",
        "PassiveLogOnUri": "https://sts.microsoftonline.com/Trust/2005/UsernameMixed",
        "PreferredAuthenticationProtocol": "WsFed",
        "PromptLoginBehavior": "TranslateToFreshPasswordAuth",
        "SigningCertificate": <Certificate Signature goes here>,
        "SigningCertificateUpdateStatus": null,
        "SupportsMfa": true
    }
}

Odpowiedź REST

W przypadku powodzenia ten interfejs API zwraca zasób domeny dla nowej zweryfikowanej domeny.

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 REST Centrum partnerskiego.

Przykład odpowiedzi

HTTP/1.1 201 Created
Content-Length: 206
Content-Type: application/json; charset=utf-8
MS-CorrelationId: 7cb67bb7-4750-403d-cc2e-6bc44c52d52c
MS-RequestId: 312b044d-dc41-4b37-c2d5-7d27322d9654
Date: Tue, 14 Feb 2017 20:06:02 GMT

{
    "authenticationType": "federated",
    "capability": "email",
    "isDefault": false,
    "isInitial": false,
    "name": "Example.com",
    "status": "verified",
    "verificationMethod": "dns_record"
}

Udostępnij za pośrednictwem