ESC
Type to search...

Channel.ReadBasic.All

Export JSON
Export CSV
Copy URL
Print
ApplicationDelegated Read All Resources

Read all channel names and channel descriptions, without a signed-in user.

Delegated Access App-Only Access

Permission Details

Application Permission

Read the names and descriptions of all channels

Read all channel names and channel descriptions, without a signed-in user.

Delegated Permission User consent allowed

Read the names and descriptions of channels

Read channel names and channel descriptions, on behalf of the signed-in user.

Properties

Property Type Description
id string The unique identifier for an entity. Read-only.
description stringNullable Optional textual description for the channel.
membershipType object The type of the channel. Can be set during creation and can't be changed. The possible values are: standard, private, unknownFutureValue, shared. The default value is standard. Use the Prefer: include-unknown-enum-members request header to get the following members in this evolvable enum: shared.
moderationSettings object Settings to configure channel moderation to control who can start new posts and reply to posts in that channel.
displayName string Channel name as it appears to the user in Microsoft Teams. The maximum length is 50 characters.
allMembers microsoft.graph.conversationMember collection A collection of membership records associated with the channel. It includes both direct and indirect members of shared channels.
createdDateTime date-timeNullable Read only. Timestamp at which the channel was created.
planner object Selective Planner services available to this channel. Currently, only shared channels are supported. Read-only. Nullable.
isFavoriteByDefault booleanNullable Indicates whether the channel should be marked as recommended for all members of the team to show in their channel list. Note: All recommended channels automatically show in the channels list for education and frontline worker users. The property can only be set programmatically via the Create team method. The default value is false.
messages microsoft.graph.chatMessage collection A collection of all the messages in the channel. Nullable.
tenantId stringNullable The ID of the Microsoft Entra tenant.
members microsoft.graph.conversationMember collection A collection of membership records associated with the channel.
layoutType object The layout type of the channel. Can be set during creation and can be updated. The possible values are: post, chat, unknownFutureValue. The default value is post. Channels with post layout use traditional post-reply conversation format, while channels with chat layout provide a chat-like threading experience similar to group chats.
summary object Contains summary information about the channel, including number of guests, members, owners, and an indicator for members from other tenants. The summary property is only returned if it appears in the $select clause of the Get channel method.
webUrl stringNullable A hyperlink to the channel in Microsoft Teams. This URL is supplied when you right-click a channel in Microsoft Teams and select Get link to channel. This URL should be treated as an opaque blob, and not parsed. Read-only.

Showing 15 of 21 properties. View all on Microsoft Learn →

JSON Representation

JSON representation
{
  "id": "String",
  "description": "String",
  "membershipType": "{...}",
  "moderationSettings": "{...}",
  "displayName": "String",
  "allMembers": "[...]",
  "createdDateTime": "String",
  "planner": "{...}",
  "isFavoriteByDefault": "Boolean",
  "messages": "[...]",
  "tenantId": "String",
  "members": "[...]",
  "layoutType": "{...}",
  "summary": "{...}",
  "webUrl": "String",
  "sharedWithTeams": "[...]",
  "filesFolder": "{...}",
  "isArchived": "Boolean",
  "email": "String",
  "tabs": "[...]"
}

Relationships

Relationship Type Description
members conversationMember collection A collection of membership records associated with the channel.
messages chatMessage collection A collection of all the messages in the channel. Nullable.
tabs teamsTab collection A collection of all the tabs in the channel. Nullable.
filesFolder driveItem Metadata for the location where the channel's files are stored.
sharedWithTeams sharedWithChannelTeamInfo collection A collection of teams with which a channel is shared.

Graph Methods

Delegated access App-only access
Methods
GET /subscriptions
GET /subscriptions/{id}
GET /teams/{id}/primaryChannel
GET /teams/{team-id}/allChannels
GET /teams/{team-id}/channels
GET /teams/{team-id}/channels/{channel-id}
GET /teams/{team-id}/incomingChannels
POST /subscriptions
POST /subscriptions/{subscriptionsId}/reauthorize
PATCH /subscriptions/{id}
DELETE /subscriptions/{subscription-id}
Methods
GET /subscriptions
GET /subscriptions/{id}
GET /subscriptions/getVapidPublicKey
GET /teams/{id}/primaryChannel
GET /teams/{team-id}/allChannels
GET /teams/{team-id}/channels
GET /teams/{team-id}/channels/{channel-id}
GET /teams/{team-id}/incomingChannels
POST /subscriptions
POST /subscriptions/{subscriptionsId}/reauthorize
PATCH /subscriptions/{id}
DELETE /subscriptions/{subscription-id}

Code Examples

C# / .NET SDK
// Install: dotnet add package Microsoft.Graph
// Install: dotnet add package Azure.Identity
using Microsoft.Graph;
using Azure.Identity;

// Delegated permissions - interactive user sign-in
var scopes = new[] { "Channel.ReadBasic.All" };
var options = new InteractiveBrowserCredentialOptions
{
    ClientId = "YOUR_CLIENT_ID",
    TenantId = "YOUR_TENANT_ID",
    RedirectUri = new Uri("http://localhost")
};
var credential = new InteractiveBrowserCredential(options);
var graphClient = new GraphServiceClient(credential, scopes);

// Example: GET /me
var result = await graphClient.Me.GetAsync();
Console.WriteLine($"User: {result?.DisplayName}");

// Application permissions - daemon/service app
var tenantId = "YOUR_TENANT_ID";
var clientId = "YOUR_CLIENT_ID";
var clientSecret = "YOUR_CLIENT_SECRET";

var credential = new ClientSecretCredential(tenantId, clientId, clientSecret);
var graphClient = new GraphServiceClient(credential);

// Example: GET /users/{user-id}
var users = await graphClient.Users.GetAsync();
foreach (var user in users?.Value ?? [])
{
    Console.WriteLine($"User: {user.DisplayName}");
}
JavaScript / TypeScript
// npm install @azure/msal-browser @microsoft/microsoft-graph-client
import { PublicClientApplication } from "@azure/msal-browser";
import { Client } from "@microsoft/microsoft-graph-client";
import { AuthCodeMSALBrowserAuthenticationProvider } from 
    "@microsoft/microsoft-graph-client/authProviders/authCodeMsalBrowser";

const msalConfig = {
    auth: {
        clientId: "YOUR_CLIENT_ID",
        authority: "https://login.microsoftonline.com/YOUR_TENANT_ID"
    }
};

const pca = new PublicClientApplication(msalConfig);
await pca.initialize();

// Delegated: Login with required scope
const loginResponse = await pca.loginPopup({
    scopes: ["Channel.ReadBasic.All"]
});

const authProvider = new AuthCodeMSALBrowserAuthenticationProvider(pca, {
    account: loginResponse.account,
    scopes: ["Channel.ReadBasic.All"],
    interactionType: "popup"
});

const graphClient = Client.initWithMiddleware({ authProvider });

// Example: GET /me
const result = await graphClient.api("/me").get();
console.log(result);

// Application: Use client credentials (Node.js backend only)
// npm install @azure/identity @microsoft/microsoft-graph-client
import { ClientSecretCredential } from "@azure/identity";
import { TokenCredentialAuthenticationProvider } from 
    "@microsoft/microsoft-graph-client/authProviders/azureTokenCredentials";

const credential = new ClientSecretCredential(
    "YOUR_TENANT_ID",
    "YOUR_CLIENT_ID", 
    "YOUR_CLIENT_SECRET"
);

const authProvider = new TokenCredentialAuthenticationProvider(credential, {
    scopes: ["https://graph.microsoft.com/.default"]
});

const graphClient = Client.initWithMiddleware({ authProvider });
const result = await graphClient.api("/users").get();
console.log(result);
PowerShell
# Install Microsoft Graph PowerShell module
Install-Module Microsoft.Graph -Scope CurrentUser

# Delegated access - interactive sign-in
Connect-MgGraph -Scopes "Channel.ReadBasic.All"

# Verify connection
Get-MgContext | Select-Object Account, TenantId, Scopes

# Example: GET /me
$result = Invoke-MgGraphRequest -Method GET -Uri "https://graph.microsoft.com/v1.0/me"
$result | ConvertTo-Json -Depth 5

# Application access with certificate
$params = @{
    ClientId = "YOUR_CLIENT_ID"
    TenantId = "YOUR_TENANT_ID"
    CertificateThumbprint = "YOUR_CERT_THUMBPRINT"
}
Connect-MgGraph @params

# Or with client secret (not recommended for production)
# Connect-MgGraph -ClientSecretCredential $credential

# Example: GET /users
$result = Invoke-MgGraphRequest -Method GET -Uri "https://graph.microsoft.com/v1.0/users"
$result | ConvertTo-Json -Depth 5

# Always disconnect when done
Disconnect-MgGraph
Python
# pip install msgraph-sdk azure-identity
from azure.identity import InteractiveBrowserCredential, ClientSecretCredential
from msgraph import GraphServiceClient
import asyncio

# Delegated permissions - interactive browser sign-in
credential = InteractiveBrowserCredential(
    client_id="YOUR_CLIENT_ID",
    tenant_id="YOUR_TENANT_ID"
)
scopes = ["Channel.ReadBasic.All"]
client = GraphServiceClient(credential, scopes)

async def get_data():
    # Example: GET /me
    result = await client.me.get()
    print(f"User: {result.display_name}")
    return result

asyncio.run(get_data())

# Application permissions - client credentials
credential = ClientSecretCredential(
    tenant_id="YOUR_TENANT_ID",
    client_id="YOUR_CLIENT_ID",
    client_secret="YOUR_CLIENT_SECRET"
)
scopes = ["https://graph.microsoft.com/.default"]
client = GraphServiceClient(credential, scopes)

async def get_users():
    # Example: GET /users
    result = await client.users.get()
    for user in result.value:
        print(f"User: {user.display_name}")
    return result

asyncio.run(get_users())

App Registration

1

Navigate to Azure Portal

Go to App registrations in Microsoft Entra admin center

2

Add API Permission

Select your app → API permissions → Add a permission → Microsoft Graph

3

Select Permission Type

Choose Application permissions or Delegated permissions and search for Channel.ReadBasic.All

4

Grant Admin Consent

Application permissions always require admin consent. Click "Grant admin consent" in the Azure portal.