tenantRelationship: findTenantInformationByDomainName

[アーティクル]
11/06/2024

名前空間: microsoft.graph

ドメイン名を指定して、テナントを検索し、その tenantInformation を読み取る。この API を使用してテナント情報を検証し、 tenantId を 使用してテナント間のクロステナントアクセス設定を構成できます。

この API は、次の国内クラウド展開で使用できます。

グローバルサービス	米国政府機関 L4	米国政府機関 L5 (DOD)	21Vianet が運営する中国
✅	✅	✅	✅

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。

アクセス許可の種類	最小特権アクセス許可	より高い特権のアクセス許可
委任 (職場または学校のアカウント)	CrossTenantInformation.ReadBasic.All	注意事項なし。
委任 (個人用 Microsoft アカウント)	サポートされていません。	サポートされていません。
アプリケーション	CrossTenantInformation.ReadBasic.All	注意事項なし。

重要

この API 操作では、呼び出し元のユーザーにMicrosoft Entraロールを割り当てる必要はありません。

HTTP 要求

GET /tenantRelationships/findTenantInformationByDomainName(domainName='{id}')

関数パラメーター

要求 URL で、次のクエリパラメーターに値を指定します。次の表に、この関数で使用する必要があるパラメーターを示します。

パラメーター	型	説明
domainName	String	Microsoft Entra テナントのプライマリドメイン名。

要求ヘッダー

名前	説明
Authorization	ベアラー {token}。必須です。認証と認可についての詳細をご覧ください。

要求本文

このメソッドには、要求本文を指定しません。

応答

成功した場合、このメソッドは応答コード 200 OK と、応答本文に tenantInformation オブジェクトを返します。

例

GET https://graph.microsoft.com/v1.0/tenantRelationships/findTenantInformationByDomainName(domainName='contoso.com')


const options = {
	authProvider,
};

const client = Client.init(options);

let tenantInformation = await client.api('/tenantRelationships/findTenantInformationByDomainName(domainName='contoso.com')')
	.get();

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

応答

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

HTTP/1.1 200 OK
Content-Type: application/json

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#microsoft.graph.tenantInformation",
    "tenantId": "6babcaad-604b-40ac-a9d7-9fd97c0b779f",
    "federationBrandName": null,
    "displayName": "Contoso, Ltd",
    "defaultDomainName": "contoso.com"
}

次の方法で共有