https://github.com/microsoftgraph/msgraph-sdk-typescript-core
Core functionalities for the Microsoft Graph JavaScript SDKs fluent APIs
https://github.com/microsoftgraph/msgraph-sdk-typescript-core
Last synced: 13 days ago
JSON representation
Core functionalities for the Microsoft Graph JavaScript SDKs fluent APIs
- Host: GitHub
- URL: https://github.com/microsoftgraph/msgraph-sdk-typescript-core
- Owner: microsoftgraph
- License: mit
- Created: 2024-01-24T19:34:17.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-11-04T09:11:48.000Z (3 months ago)
- Last Synced: 2025-11-11T03:45:37.832Z (3 months ago)
- Language: TypeScript
- Size: 2.1 MB
- Stars: 3
- Watchers: 6
- Forks: 4
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
- Support: SUPPORT.md
Awesome Lists containing this project
README
# Microsoft Graph Core SDK for Typescript
Get started with the Microsoft Graph SDK for Typescript by integrating the [Microsoft Graph API](https://docs.microsoft.com/graph/overview) into your Typescript application!
> **Note:** this package contains the core feature of the TypeScript SDK. To get the full experience checkout [the v1 SDK](https://github.com/microsoftgraph/msgraph-sdk-typescript) and [the beta SDK](https://github.com/microsoftgraph/msgraph-beta-sdk-typescript).
>
> **Note:** the Microsoft Graph Typescript SDK is currently in Pre-Release.
## 1. Installation
```shell
# this will install the core package
npm install @microsoft/msgraph-sdk-core
```
## 2. Getting started
> Note: we are working to add the getting started information for Typescript to our public documentation, in the meantime the following sample should help you getting started.
### 2.1 Register your application
Register your application by following the steps at [Register your app with the Microsoft Identity Platform](https://docs.microsoft.com/graph/auth-register-app-v2).
### 2.2 Create an AuthenticationProvider object
An instance of the **FetchClient** class handles making requests to the service. To create a new instance of this class, you need to provide an instance of **AuthenticationProvider**, which can authenticate requests to Microsoft Graph.
#### 2.2.1 Authorization Code Provider
```TypeScript
// @azure/identity
const credential = new AuthorizationCodeCredential(
'YOUR_TENANT_ID',
'YOUR_CLIENT_ID',
'YOUR_CLIENT_SECRET',
'AUTHORIZATION_CODE',
'REDIRECT_URL',
);
// @microsoft/kiota-authentication-azure
const authProvider = new AzureIdentityAuthenticationProvider(credential, ["User.Read"]);
```
#### 2.2.2 Client Credentials Provider
##### With a certificate
```TypeScript
// @azure/identity
const credential = new ClientCertificateCredential(
'YOUR_TENANT_ID',
'YOUR_CLIENT_ID',
'YOUR_CERTIFICATE_PATH',
);
// @microsoft/kiota-authentication-azure
const authProvider = new AzureIdentityAuthenticationProvider(credential, ["https://graph.microsoft.com/.default"]);
```
##### With a secret
```TypeScript
// @azure/identity
const credential = new ClientSecretCredential(
'YOUR_TENANT_ID',
'YOUR_CLIENT_ID',
'YOUR_CLIENT_SECRET',
);
// @microsoft/kiota-authentication-azure
const authProvider = new AzureIdentityAuthenticationProvider(credential, ["https://graph.microsoft.com/.default"]);
```
#### 2.2.3 On-behalf-of provider
```TypeScript
// @azure/identity
const credential = new OnBehalfOfCredential({
tenantId: 'YOUR_TENANT_ID',
clientId: 'YOUR_CLIENT_ID',
clientSecret: 'YOUR_CLIENT_SECRET',
userAssertionToken: 'JWT_TOKEN_TO_EXCHANGE',
});
// @microsoft/kiota-authentication-azure
const authProvider = new AzureIdentityAuthenticationProvider(credential, ["https://graph.microsoft.com/.default"]);
```
#### 2.2.4 Device code provider
```TypeScript
// @azure/identity
const credential = new DeviceCodeCredential({
tenantId: 'YOUR_TENANT_ID',
clientId: 'YOUR_CLIENT_ID',
userPromptCallback: (info) => {
console.log(info.message);
},
});
// @microsoft/kiota-authentication-azure
const authProvider = new AzureIdentityAuthenticationProvider(credential, ["User.Read"]);
```
#### 2.2.5 Interactive provider
```TypeScript
// @azure/identity
const credential = new InteractiveBrowserCredential({
tenantId: 'YOUR_TENANT_ID',
clientId: 'YOUR_CLIENT_ID',
redirectUri: 'http://localhost',
});
// @microsoft/kiota-authentication-azure
const authProvider = new AzureIdentityAuthenticationProvider(credential, ["User.Read"]);
```
#### 2.2.6 Username/password provider
```TypeScript
// @azure/identity
const credential = new UsernamePasswordCredential(
'YOUR_TENANT_ID',
'YOUR_CLIENT_ID',
'YOUR_USER_NAME',
'YOUR_PASSWORD',
);
// @microsoft/kiota-authentication-azure
const authProvider = new AzureIdentityAuthenticationProvider(credential, ["User.Read"]);
```
## 3. Make requests against the service
TODO: document how the fetch client augmented with middleware handlers can be used to make arbitrary requests.
## 4. Documentation
For more detailed documentation, see:
* [Overview](https://docs.microsoft.com/graph/overview)
* [Collections](https://docs.microsoft.com/graph/sdks/paging)
* [Making requests](https://docs.microsoft.com/graph/sdks/create-requests)
* [Known issues](https://github.com/MicrosoftGraph/msgraph-sdk-typescript/issues)
* [Contributions](https://github.com/microsoftgraph/msgraph-sdk-typescript/blob/main/CONTRIBUTING.md)
## 5. Issues
For known issues, see [issues](https://github.com/MicrosoftGraph/msgraph-sdk-typescript/issues).
## 6. Contributions
The Microsoft Graph SDK is open for contribution. To contribute to this project, see [Contributing](https://github.com/microsoftgraph/msgraph-sdk-typescript/blob/main/CONTRIBUTING.md).
## 7. License
Copyright (c) Microsoft Corporation. All Rights Reserved. Licensed under the [MIT license](LICENSE).
## 8. Third-party notices
[Third-party notices](THIRD%20PARTY%20NOTICES)