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.
Remove access to a chat for a user.
This API is available in the following national cloud deployments.
Global service |
US Government L4 |
US Government L5 (DOD) |
China operated by 21Vianet |
✅ |
✅ |
✅ |
❌ |
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) |
Chat.ReadWrite.All |
Not available. |
Delegated (personal Microsoft account) |
Not supported. |
Not supported. |
Application |
Not supported. |
Not supported. |
HTTP request
POST /chats/{chatsId}/removeAllAccessForUser
Request body
In the request body, supply a JSON object with the following parameters.
Response
If successful, this action returns a 204 No Content
response code.
Examples
Request
The following example shows a request.
POST https://graph.microsoft.com/beta/chats/{chatsId}/removeAllAccessForUser
Content-Type: application/json
{
"user": {
"@odata.type": "microsoft.graph.teamworkUserIdentity"
}
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.Chats.Item.RemoveAllAccessForUser;
using Microsoft.Graph.Beta.Models;
var requestBody = new RemoveAllAccessForUserPostRequestBody
{
User = new TeamworkUserIdentity
{
OdataType = "microsoft.graph.teamworkUserIdentity",
},
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
await graphClient.Chats["{chat-id}"].RemoveAllAccessForUser.PostAsync(requestBody);
mgc-beta chats remove-all-access-for-user post --chat-id {chat-id} --body '{\
"user": {\
"@odata.type": "microsoft.graph.teamworkUserIdentity"\
}\
}\
'
// 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"
graphchats "github.com/microsoftgraph/msgraph-beta-sdk-go/chats"
graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
//other-imports
)
requestBody := graphchats.NewRemoveAllAccessForUserPostRequestBody()
user := graphmodels.NewTeamworkUserIdentity()
requestBody.SetUser(user)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
graphClient.Chats().ByChatId("chat-id").RemoveAllAccessForUser().Post(context.Background(), requestBody, nil)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
com.microsoft.graph.beta.chats.item.removeallaccessforuser.RemoveAllAccessForUserPostRequestBody removeAllAccessForUserPostRequestBody = new com.microsoft.graph.beta.chats.item.removeallaccessforuser.RemoveAllAccessForUserPostRequestBody();
TeamworkUserIdentity user = new TeamworkUserIdentity();
user.setOdataType("microsoft.graph.teamworkUserIdentity");
removeAllAccessForUserPostRequestBody.setUser(user);
graphClient.chats().byChatId("{chat-id}").removeAllAccessForUser().post(removeAllAccessForUserPostRequestBody);
const options = {
authProvider,
};
const client = Client.init(options);
const removeAllAccessForUser = {
user: {
'@odata.type': 'microsoft.graph.teamworkUserIdentity'
}
};
await client.api('/chats/{chatsId}/removeAllAccessForUser')
.version('beta')
.post(removeAllAccessForUser);
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Chats\Item\RemoveAllAccessForUser\RemoveAllAccessForUserPostRequestBody;
use Microsoft\Graph\Beta\Generated\Models\TeamworkUserIdentity;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new RemoveAllAccessForUserPostRequestBody();
$user = new TeamworkUserIdentity();
$user->setOdataType('microsoft.graph.teamworkUserIdentity');
$requestBody->setUser($user);
$graphServiceClient->chats()->byChatId('chat-id')->removeAllAccessForUser()->post($requestBody)->wait();
Import-Module Microsoft.Graph.Beta.Teams
$params = @{
user = @{
"@odata.type" = "microsoft.graph.teamworkUserIdentity"
}
}
Remove-MgBetaChatAccessForUser -ChatId $chatId -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.chats.item.remove_all_access_for_user.remove_all_access_for_user_post_request_body import RemoveAllAccessForUserPostRequestBody
from msgraph_beta.generated.models.teamwork_user_identity import TeamworkUserIdentity
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = RemoveAllAccessForUserPostRequestBody(
user = TeamworkUserIdentity(
odata_type = "microsoft.graph.teamworkUserIdentity",
),
)
await graph_client.chats.by_chat_id('chat-id').remove_all_access_for_user.post(request_body)
Response
The following example shows the response.
HTTP/1.1 204 No Content