Getting started instructions are missing auth provider setup

Open
#507 7 comments 6 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
azure, typescript
Domain
authentication, documentation

Research direction

Locate the getting-started instructions and review how authentication is currently described. Add a fully working TypeScript auth-provider setup compatible with this SDK, including the sample flow shown in the issue, and verify that the instructions let developers run the users request successfully.

Written by the indexing model from the issue text.

Description

ToTriage

Currently, getting started instructions are missing the steps to configure the auth provider. We're referencing our live documentation, which unfortunately isn't working, because it's incompatible with this SDK. To help developers try this SDK, we should include a fully working sample, for example:

import { ClientSecretCredential } from '@azure/identity';
import { AzureIdentityAuthenticationProvider } from '@microsoft/kiota-authentication-azure';
import { FetchRequestAdapter } from "@microsoft/kiota-http-fetchlibrary";
import { createGraphServiceClient } from "@microsoft/msgraph-sdk";
import "@microsoft/msgraph-sdk-users";
import 'dotenv/config';

(async () => {
  const credential = new ClientSecretCredential(
    process.env.TENANT_ID,
    process.env.CLIENT_ID,
    process.env.CLIENT_SECRET
  );
  const authProvider = new AzureIdentityAuthenticationProvider(credential, ['https://graph.microsoft.com/.default']);
  const requestAdapter = new FetchRequestAdapter(authProvider);
  const graphServiceClient = createGraphServiceClient(requestAdapter);

  try {
    const users = await graphServiceClient.users.get();
    console.log(JSON.stringify(users));
  }
  catch (error) {
    console.error(error);
  }
})();
Dominant language
TypeScript
Stars
44
Forks
7
Avg merge
12h 40m
Merged PRs (30d)
5

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from microsoftgraph/msgraph-sdk-typescript

All issues in microsoftgraph/msgraph-sdk-typescript

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.