Namespace: microsoft.graph
Important
APIs under the /beta
version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.
Update the properties of a multi-tenant organization.
Permissions
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.
Permission type |
Least privileged permissions |
Higher privileged permissions |
Delegated (work or school account) |
MultiTenantOrganization.ReadWrite.All |
Not available. |
Delegated (personal Microsoft account) |
Not supported. |
Not supported. |
Application |
MultiTenantOrganization.ReadWrite.All |
Not available. |
Important
In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported Microsoft Entra role or a custom role with a supported role permission. Security Administrator is the least privileged role supported for this operation.
HTTP request
PATCH /tenantRelationships/multiTenantOrganization
Request body
In the request body, supply only the values for properties to update. Existing properties that aren't included in the request body maintain their previous values or are recalculated based on changes to other property values.
The following table specifies the properties that can be updated.
Property |
Type |
Description |
displayName |
String |
Display name of the multi-tenant organization. Optional. |
description |
String |
Description of the multi-tenant organization. Optional. |
Response
If successful, this method returns a 204 No Content
response code.
Examples
The following example updates the description and display name for a multi-tenant organization.
Request
PATCH https://graph.microsoft.com/beta/tenantRelationships/multiTenantOrganization
Content-Type: application/json
{
"displayName": "Contoso organization",
"description": "Multi-tenant organization between Contoso, Fabrikam, and Woodgrove Bank"
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.Models;
var requestBody = new MultiTenantOrganization
{
DisplayName = "Contoso organization",
Description = "Multi-tenant organization between Contoso, Fabrikam, and Woodgrove Bank",
};
// 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.PatchAsync(requestBody);
// Code snippets are only available for the latest major version. Current major version is $v0.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
//other-imports
)
requestBody := graphmodels.NewMultiTenantOrganization()
displayName := "Contoso organization"
requestBody.SetDisplayName(&displayName)
description := "Multi-tenant organization between Contoso, Fabrikam, and Woodgrove Bank"
requestBody.SetDescription(&description)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
multiTenantOrganization, err := graphClient.TenantRelationships().MultiTenantOrganization().Patch(context.Background(), requestBody, nil)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
MultiTenantOrganization multiTenantOrganization = new MultiTenantOrganization();
multiTenantOrganization.setDisplayName("Contoso organization");
multiTenantOrganization.setDescription("Multi-tenant organization between Contoso, Fabrikam, and Woodgrove Bank");
MultiTenantOrganization result = graphClient.tenantRelationships().multiTenantOrganization().patch(multiTenantOrganization);
const options = {
authProvider,
};
const client = Client.init(options);
const multiTenantOrganization = {
displayName: 'Contoso organization',
description: 'Multi-tenant organization between Contoso, Fabrikam, and Woodgrove Bank'
};
await client.api('/tenantRelationships/multiTenantOrganization')
.version('beta')
.update(multiTenantOrganization);
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Models\MultiTenantOrganization;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new MultiTenantOrganization();
$requestBody->setDisplayName('Contoso organization');
$requestBody->setDescription('Multi-tenant organization between Contoso, Fabrikam, and Woodgrove Bank');
$result = $graphServiceClient->tenantRelationships()->multiTenantOrganization()->patch($requestBody)->wait();
Import-Module Microsoft.Graph.Beta.Identity.SignIns
$params = @{
displayName = "Contoso organization"
description = "Multi-tenant organization between Contoso, Fabrikam, and Woodgrove Bank"
}
Update-MgBetaTenantRelationshipMultiTenantOrganization -BodyParameter $params
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.models.multi_tenant_organization import MultiTenantOrganization
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = MultiTenantOrganization(
display_name = "Contoso organization",
description = "Multi-tenant organization between Contoso, Fabrikam, and Woodgrove Bank",
)
result = await graph_client.tenant_relationships.multi_tenant_organization.patch(request_body)
Response
HTTP/1.1 204 No Content