Adicionar multiTenantOrganizationMember

Namespace: microsoft.graph

Adicionar um inquilino a uma organização multi-inquilino. O administrador de um inquilino proprietário tem as permissões para adicionar inquilinos à organização multi-inquilino. O inquilino adicionado está no estado pendente até que o administrador do inquilino adicionado se junte à organização multi-inquilino ao submeter um pedido de associação. Um inquilino só pode fazer parte de uma organização multi-inquilino.

Esta API está disponível nas seguintes implementações de cloud nacionais.

Serviço global	US Government L4	US Government L5 (DOD)	China operada pela 21Vianet
✅	❌	❌	❌

Permissões

Escolha a permissão ou permissões marcadas como menos privilegiadas para esta API. Utilize uma permissão ou permissões com privilégios mais elevados apenas se a sua aplicação o exigir. Para obter detalhes sobre as permissões delegadas e de aplicação, veja Tipos de permissão. Para saber mais sobre estas permissões, veja a referência de permissões.

Tipo de permissão	Permissões com menos privilégios	Permissões com privilégios superiores
Delegado (conta corporativa ou de estudante)	MultiTenantOrganization.ReadWrite.All	Indisponível.
Delegado (conta pessoal da Microsoft)	Sem suporte.	Sem suporte.
Application	MultiTenantOrganization.ReadWrite.All	Indisponível.

O utilizador com sessão iniciada também tem de ter, pelo menos, a função de diretórioAdministrador de Segurança atribuída.

Solicitação HTTP

POST /tenantRelationships/multiTenantOrganization/tenants

Cabeçalhos de solicitação

Nome	Descrição
Autorização	{token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.
Content-Type	application/json. Obrigatório.

Corpo da solicitação

No corpo do pedido, forneça uma representação JSON do objeto multiTenantOrganizationMember .

Pode especificar as seguintes propriedades ao criar um multiTenantOrganizationMember.

Propriedade	Tipo	Descrição
tenantId	String	ID do inquilino do Microsoft Entra para adicionar à organização multi-inquilino. Obrigatório.
displayName	Cadeia de caracteres	Nome a apresentar do inquilino adicionado à organização multi-inquilino. Atualmente, não pode ser alterado uma vez definido. Obrigatório.
role	multiTenantOrganizationMemberRole	Função do inquilino na organização multi-inquilino. Os valores possíveis são: owner, member (predefinição), unknownFutureValue. Opcional.

Resposta

Se for bem-sucedido, este método devolve um 201 Created código de resposta e um objeto multiTenantOrganizationMember no corpo da resposta. Se o inquilino já estiver pendente ou ativo nesta organização multi-inquilino, obterá um erro "Request_BadRequest".

Exemplos

O exemplo seguinte adiciona o inquilino da Fabrikam à organização multi-inquilino.

Solicitação

HTTP

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

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

C#

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

// Dependencies
using Microsoft.Graph.Models;

var requestBody = new MultiTenantOrganizationMember
{
	TenantId = "4a12efe6-aa14-4d03-8dff-88fc89e2e2ad",
	DisplayName = "Fabrikam",
};

// 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.Tenants.PostAsync(requestBody);

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

CLI

mgc tenant-relationships multi-tenant-organization tenants create --body '{\
  "tenantId": "4a12efe6-aa14-4d03-8dff-88fc89e2e2ad",\
  "displayName": "Fabrikam"\
}\
'

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

Ir

// 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"
	  graphmodels "github.com/microsoftgraph/msgraph-sdk-go/models"
	  //other-imports
)

requestBody := graphmodels.NewMultiTenantOrganizationMember()
tenantId := "4a12efe6-aa14-4d03-8dff-88fc89e2e2ad"
requestBody.SetTenantId(&tenantId) 
displayName := "Fabrikam"
requestBody.SetDisplayName(&displayName) 

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

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

Java

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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

MultiTenantOrganizationMember multiTenantOrganizationMember = new MultiTenantOrganizationMember();
multiTenantOrganizationMember.setTenantId("4a12efe6-aa14-4d03-8dff-88fc89e2e2ad");
multiTenantOrganizationMember.setDisplayName("Fabrikam");
MultiTenantOrganizationMember result = graphClient.tenantRelationships().multiTenantOrganization().tenants().post(multiTenantOrganizationMember);

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const multiTenantOrganizationMember = {
  tenantId: '4a12efe6-aa14-4d03-8dff-88fc89e2e2ad',
  displayName: 'Fabrikam'
};

await client.api('/tenantRelationships/multiTenantOrganization/tenants')
	.post(multiTenantOrganizationMember);

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

PHP

<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\MultiTenantOrganizationMember;


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

$requestBody = new MultiTenantOrganizationMember();
$requestBody->setTenantId('4a12efe6-aa14-4d03-8dff-88fc89e2e2ad');
$requestBody->setDisplayName('Fabrikam');

$result = $graphServiceClient->tenantRelationships()->multiTenantOrganization()->tenants()->post($requestBody)->wait();

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

PowerShell

Import-Module Microsoft.Graph.Identity.SignIns

$params = @{
	tenantId = "4a12efe6-aa14-4d03-8dff-88fc89e2e2ad"
	displayName = "Fabrikam"
}

New-MgTenantRelationshipMultiTenantOrganizationTenant -BodyParameter $params

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

Python

from msgraph import GraphServiceClient
from msgraph.generated.models.multi_tenant_organization_member import MultiTenantOrganizationMember

graph_client = GraphServiceClient(credentials, scopes)

request_body = MultiTenantOrganizationMember(
	tenant_id = "4a12efe6-aa14-4d03-8dff-88fc89e2e2ad",
	display_name = "Fabrikam",
)

result = await graph_client.tenant_relationships.multi_tenant_organization.tenants.post(request_body)

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

Resposta

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
}

Se o inquilino já estiver pendente ou ativo nesta organização multi-inquilino, obterá um erro "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"
        }
    }
}