channel: doesUserHaveAccess

Namespace: microsoft.graph

Determine whether a user has access to a shared channel.

This API is supported in the following national cloud deployments.

Global service	US Government L4	US Government L5 (DOD)	China operated by 21Vianet
✅	✅	✅	✅

Permissions

One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Permission type	Permissions (from least to most privileged)
Delegated (work or school account)	ChannelMember.Read.All, ChannelMember.ReadWrite.All
Delegated (personal Microsoft account)	Not supported.
Application	ChannelMember.Read.All, ChannelMember.ReadWrite.All

HTTP request

GET /teams/{team-id}/channels/{channel-id}/doesUserHaveAccess(userId='@userId',tenantId='@tenantId',userPrincipalName='@userPrincipalName')

Function parameters

In the request URL, provide the following query parameters with values. The following table shows the parameters that can be used with this function.

Parameter	Type	Description
tenantId	String	The ID of the Azure Active Directory tenant that the user belongs to. The default value for this property is the current tenantId of the signed-in user or app.
userId	String	Unique identifier for the user. Either specify the userId or the userPrincipalName property in the request.
userPrincipalName	String	The user principal name (UPN) of the user. Either specify the userId or the userPrincipalName property in the request.

Request headers

Name	Description
Authorization	Bearer {token}. Required.

Request body

Don't supply a request body for this function.

Response

If successful, this function returns a 200 OK response code and a Boolean in the response body.

Examples

Example 1: Check access for an internal user

Here's an example of a request that checks whether an internal user has access to a shared channel.

Request

Here's an example of a request.

HTTP

GET https://graph.microsoft.com/v1.0/teams/0fddfdc5-f319-491f-a514-be1bc1bf9ddc/channels/19:33b76eea88574bd1969dca37e2b7a819@thread.skype/doesUserHaveAccess(userId='6285581f-484b-4845-9e01-60667f8b12ae')

CLI

// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc teams channels does-user-have-access(user-id='@user-id',tenant-id='@tenant-id',user-principal-name='@user-principal-name') get --team-id {team-id} --channel-id {channel-id}

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Go

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

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)



doesUserHaveAccess, err := graphClient.Teams().ByTeamId("team-id").Channels().ByChannelId("channel-id").DoesUserHaveAccessWithUserIdWithTenantIdWithUserPrincipalName(&userId, &tenantId, &userPrincipalName).Get(context.Background(), nil)

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Java

GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

Boolean _boolean = graphClient.teams("0fddfdc5-f319-491f-a514-be1bc1bf9ddc").channels("19:33b76eea88574bd1969dca37e2b7a819@thread.skype")
	.doesUserHaveAccess(ChannelDoesUserHaveAccessParameterSet
		.newBuilder()
		.withUserId("6285581f-484b-4845-9e01-60667f8b12ae")
		.build())
	.buildRequest()
	.get();

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

let _boolean = await client.api('/teams/0fddfdc5-f319-491f-a514-be1bc1bf9ddc/channels/19:33b76eea88574bd1969dca37e2b7a819@thread.skype/doesUserHaveAccess(userId='6285581f-484b-4845-9e01-60667f8b12ae')')
	.get();

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

PowerShell

Import-Module Microsoft.Graph.Teams

Invoke-MgHaveTeamChannel -TeamId $teamId -ChannelId $channelId

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Python

# THE PYTHON SDK IS IN PREVIEW. FOR NON-PRODUCTION USE ONLY

graph_client = GraphServiceClient(request_adapter)


result = await graph_client.teams.by_team_id('team-id').channels.by_channel_id('channel-id').doe_user_have_access(user_id='@user_id',tenant_id='@tenant_id',user_principal_name='@user_principal_name'.get()

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Response

Here's an example of the response.

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

{
  "value": true
}

Example 2: Check access for an external user

Here's an example of a request that uses the tenantId property to check whether an external user has access to a shared channel.

Request

Here's an example of a request.

HTTP

GET https://graph.microsoft.com/v1.0/teams/0fddfdc5-f319-491f-a514-be1bc1bf9ddc/channels/19:33b76eea88574bd1969dca37e2b7a819@thread.skype/doesUserHaveAccess(userId='62855810-484b-4823-9e01-60667f8b12ae', tenantId='57fb72d0-d811-46f4-8947-305e6072eaa5')

CLI

Snippet not available

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Go

Snippet not available

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Java

GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

Boolean _boolean = graphClient.teams("0fddfdc5-f319-491f-a514-be1bc1bf9ddc").channels("19:33b76eea88574bd1969dca37e2b7a819@thread.skype")
	.doesUserHaveAccess(ChannelDoesUserHaveAccessParameterSet
		.newBuilder()
		.withUserId("62855810-484b-4823-9e01-60667f8b12ae")
		.withTenantId("57fb72d0-d811-46f4-8947-305e6072eaa5")
		.build())
	.buildRequest()
	.get();

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

let _boolean = await client.api('/teams/0fddfdc5-f319-491f-a514-be1bc1bf9ddc/channels/19:33b76eea88574bd1969dca37e2b7a819@thread.skype/doesUserHaveAccess(userId='62855810-484b-4823-9e01-60667f8b12ae', tenantId='57fb72d0-d811-46f4-8947-305e6072eaa5')')
	.get();

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

PowerShell

Snippet not available

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Python

Snippet not available

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Response

Here's an example of the response.

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

{
  "value": true
}

Example 3: Check user access for a user using the user principal name

Here's an example of a request that uses the userPrincipalName property to check whether an internal user has access to a shared channel.

Request

Here's an example of a request.

HTTP

GET https://graph.microsoft.com/v1.0/teams/0fddfdc5-f319-491f-a514-be1bc1bf9ddc/channels/19:33b76eea88574bd1969dca37e2b7a819@thread.skype/doesUserHaveAccess(userPrincipalName='john.doe@contoso.com')

CLI

Snippet not available

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Go

Snippet not available

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Java

GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

Boolean _boolean = graphClient.teams("0fddfdc5-f319-491f-a514-be1bc1bf9ddc").channels("19:33b76eea88574bd1969dca37e2b7a819@thread.skype")
	.doesUserHaveAccess(ChannelDoesUserHaveAccessParameterSet
		.newBuilder()
		.withUserPrincipalName("john.doe@contoso.com")
		.build())
	.buildRequest()
	.get();

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

let _boolean = await client.api('/teams/0fddfdc5-f319-491f-a514-be1bc1bf9ddc/channels/19:33b76eea88574bd1969dca37e2b7a819@thread.skype/doesUserHaveAccess(userPrincipalName='john.doe@contoso.com')')
	.get();

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

PowerShell

Snippet not available

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Python

Snippet not available

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Response

Here's an example of the response.

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

{
  "value": false
}