Получение multiTenantOrganizationJoinRequestRecord

Пространство имен: microsoft.graph

Получение состояния клиента, присоединяющегося к мультитенантной организации.

Этот API доступен в следующих национальных облачных развертываниях.

Глобальная служба	Правительство США L4	Правительство США L5 (DOD)	Китай управляется 21Vianet
✅	❌	❌	❌

Разрешения

Выберите разрешение или разрешения, помеченные как наименее привилегированные для этого API. Используйте более привилегированное разрешение или разрешения только в том случае, если это требуется приложению. Дополнительные сведения о делегированных разрешениях и разрешениях приложений см. в разделе Типы разрешений. Дополнительные сведения об этих разрешениях см. в справочнике по разрешениям.

Тип разрешения	Разрешения с наименьшими привилегиями	Более высокие привилегированные разрешения
Делегированные (рабочая или учебная учетная запись)	MultiTenantOrganization.Read.All	MultiTenantOrganization.ReadWrite.All
Делегированные (личная учетная запись Майкрософт)	Не поддерживается.	Не поддерживается.
Приложение	MultiTenantOrganization.Read.All	MultiTenantOrganization.ReadWrite.All

Важно!

В делегированных сценариях с рабочими или учебными учетными записями вошедшему пользователю должна быть назначена поддерживаемая роль Microsoft Entra или настраиваемая роль с разрешением поддерживаемой роли. Для этой операции поддерживаются следующие роли с наименьшими привилегиями.

• Читатель сведений о безопасности
• Глобальный читатель

Пользователи, выполнив вход в систему, могут считывать основные атрибуты мультитенантной организации и клиентов-членов организации, не назначая им роли читателя безопасности или глобального читателя.

HTTP-запрос

GET /tenantRelationships/multiTenantOrganization/joinRequest

Необязательные параметры запросов

Этот метод поддерживает $select параметр запроса OData для настройки ответа. Общие сведения см. в статье Параметры запроса OData.

Заголовки запросов

Имя	Описание
Авторизация	Bearer {token}. Обязательно. Дополнительные сведения о проверке подлинности и авторизации.

Текст запроса

Не указывайте текст запроса для этого метода.

Отклик

В случае успешного 200 OK выполнения этот метод возвращает код отклика и объект multiTenantOrganizationJoinRequestRecord в теле отклика .

Примеры

В следующем примере показано, как клиент присоединяется к мультитенантной организации.

Запрос

HTTP

GET https://graph.microsoft.com/v1.0/tenantRelationships/multiTenantOrganization/joinRequest

C#

// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.TenantRelationships.MultiTenantOrganization.JoinRequest.GetAsync();

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

CLI

mgc tenant-relationships multi-tenant-organization join-request get

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

Go

// Code snippets are only available for the latest major version. Current major version is $v1.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  //other-imports
)


// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
joinRequest, err := graphClient.TenantRelationships().MultiTenantOrganization().JoinRequest().Get(context.Background(), nil)

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

Java

// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

MultiTenantOrganizationJoinRequestRecord result = graphClient.tenantRelationships().multiTenantOrganization().joinRequest().get();

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

let multiTenantOrganizationJoinRequestRecord = await client.api('/tenantRelationships/multiTenantOrganization/joinRequest')
	.get();

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

PHP

<?php
use Microsoft\Graph\GraphServiceClient;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$result = $graphServiceClient->tenantRelationships()->multiTenantOrganization()->joinRequest()->get()->wait();

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

PowerShell

Import-Module Microsoft.Graph.Identity.SignIns

Get-MgTenantRelationshipMultiTenantOrganizationJoinRequest

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

Python

# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python

result = await graph_client.tenant_relationships.multi_tenant_organization.join_request.get()

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

Отклик

В следующем примере показан ответ перед присоединением добавленного клиента к мультитенантной организации.

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

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#tenantRelationships/multiTenantOrganization/joinRequest/$entity",
    "id": "7149c406-fac5-4be9-ad4b-f46fac7fe60c",
    "addedByTenantId": "00000000-0000-0000-0000-000000000000",
    "memberState": null,
    "role": null,
    "transitionDetails": null
}

В следующем примере показан ответ после того, как добавленный клиент запросит присоединиться к мультитенантной организации и состояние по-прежнему pendingравно .

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

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#tenantRelationships/multiTenantOrganization/joinRequest/$entity",
    "id": "3e536776-7489-43e9-9637-742d62ec3fc5",
    "addedByTenantId": "1fd6544e-e994-4de2-9f1b-787b51c7d325",
    "memberState": "pending",
    "role": null,
    "transitionDetails": {
        "desiredMemberState": "active",
        "status": "notStarted",
        "details": ""
    }
}

В следующем примере показан ответ после того, как добавленный клиент успешно присоединяется к мультитенантной организации и состояние изменяется на active.

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

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#tenantRelationships/multiTenantOrganization/joinRequest/$entity",
    "id": "3e536776-7489-43e9-9637-742d62ec3fc5",
    "addedByTenantId": "1fd6544e-e994-4de2-9f1b-787b51c7d325",
    "memberState": "active",
    "role": member,
    "transitionDetails": null
}

В следующем примере показан ответ, когда добавленный клиент не может присоединиться к мультитенантной организации. Сведения о сбросе неудачного запроса на присоединение см. в разделе Обновление multiTenantOrganizationJoinRequestRecord.

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

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#tenantRelationships/multiTenantOrganization/joinRequest/$entity",
    "id": "3e536776-7489-43e9-9637-742d62ec3fc5",
    "addedByTenantId": "1fd6544e-e994-4de2-9f1b-787b51c7d325",
    "memberState": "pending",
    "role": null,
    "transitionDetails": {
        "desiredMemberState": "active",
        "status": "failed",
        "details": "DirectoryService Exception"
    }
}