multiTenantOrganizationMember を追加する

名前空間: microsoft.graph

テナントをマルチテナント組織に追加します。 所有者テナントの管理者は、マルチテナント組織にテナントを追加するアクセス許可を持っています。 追加されたテナントの管理者が参加要求を送信してマルチテナント組織に参加するまで、追加されたテナントは保留中の状態になります。 テナントは、1 つのマルチテナント組織にのみ含めることができます。

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

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

アクセス許可

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

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

職場または学校アカウントを使用した委任されたシナリオでは、サインインしているユーザーに、サポートされている Microsoft Entra ロール またはサポートされているロールのアクセス許可を持つカスタム ロールを割り当てる必要があります。 セキュリティ管理者 は、この操作でサポートされる最小限の特権ロールです。

HTTP 要求

POST /tenantRelationships/multiTenantOrganization/tenants

要求ヘッダー

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

要求本文

要求本文で、 multiTenantOrganizationMember オブジェクトの JSON 表現を指定します。

multiTenantOrganizationMember を作成するときに、次のプロパティを指定できます。

プロパティ 説明
tenantId String マルチテナント組織に追加する Microsoft Entra テナントのテナント ID。 必須です。
displayName String マルチテナント組織に追加されたテナントの表示名。 現時点では、一度設定すると変更できません。 必須です。
role multiTenantOrganizationMemberRole マルチテナント組織におけるテナントの役割。 使用可能な値は、 ownermember (既定値)、 unknownFutureValueです。 省略可能。

応答

成功した場合、このメソッドは応答コード 201 Created と、応答本文に multiTenantOrganizationMember オブジェクトを返します。 テナントがこのマルチテナント組織で既に保留中またはアクティブになっている場合は、"Request_BadRequest" エラーが発生します。

次の例では、Fabrikam テナントをマルチテナント組織に追加します。

要求

POST https://graph.microsoft.com/v1.0/tenantRelationships/multiTenantOrganization/tenants
Content-Type: application/json

{
  "tenantId": "4a12efe6-aa14-4d03-8dff-88fc89e2e2ad",
  "displayName": "Fabrikam"
}

応答

HTTP/1.1 201 Created
Content-Type: application/json

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#tenantRelationships/multiTenantOrganization/tenants/$entity",
    "tenantId": "4a12efe6-aa14-4d03-8dff-88fc89e2e2ad",
    "displayName": "Fabrikam",
    "addedDateTime": "2023-05-27T19:24:29Z",
    "joinedDateTime": null,
    "addedByTenantId": "1fd6544e-e994-4de2-9f1b-787b51c7d325",
    "role": "member",
    "state": "pending",
    "transitionDetails": null
}

テナントがこのマルチテナント組織で既に保留中またはアクティブになっている場合は、"Request_BadRequest" エラーが発生します。

HTTP/1.1 400 Bad Request
Content-Type: application/json

{
    "error": {
        "code": "Request_BadRequest",
        "message": "Tenant is already being added in Multi-Tenant Organization.",
        "innerError": {
            "date": "2023-05-27T20:56:14",
            "request-id": "a1e5973c-66f1-4853-9e3d-39e6b4f606d1",
            "client-request-id": "651548c3-e864-4509-837b-4f5d4cf546a5"
        }
    }
}