Class MicrosoftGraphClient

A HTTP Client that communicates with Microsoft Graph API. Simplify Authentication and API calls to get User and Group from Microsoft Graph

Uses msal-node for authentication

Index

Constructors

constructor

Methods

getGroupMembers getGroupPhoto getGroupPhotoWithSizeLimit getGroups getGroupUserMembers getOrganization getUserPhoto getUserPhotoWithSizeLimit getUsers requestApi requestCollection requestRaw create

Constructors

constructor

new MicrosoftGraphClient(
baseUrl: string,
tokenCredential: TokenCredential,
): MicrosoftGraphClient
Parameters
- baseUrl: string
- tokenCredential: TokenCredential
Returns MicrosoftGraphClient
- Defined in plugins/catalog-backend-module-msgraph/src/microsoftGraph/client.ts:113

Methods

getGroupMembers

getGroupMembers(
    groupId: string,
    query?: ODataQuery,
    queryMode?: "basic" | "advanced",
    signal?: AbortSignal,
): AsyncIterable<GroupMember>
Get a collection of User belonging to a Group from Graph API and return as AsyncIterable
Parameters
- groupId: string
  The unique identifier for the Group resource
- Optionalquery: ODataQuery
- OptionalqueryMode: "basic" | "advanced"
- Optionalsignal: AbortSignal
Returns AsyncIterable<GroupMember>
- Defined in plugins/catalog-backend-module-msgraph/src/microsoftGraph/client.ts:358

getGroupPhoto

getGroupPhoto(groupId: string, sizeId?: string): Promise<string | undefined>
Parameters
- groupId: string
- OptionalsizeId: string
Returns Promise<string | undefined>
- Defined in plugins/catalog-backend-module-msgraph/src/microsoftGraph/client.ts:319

getGroupPhotoWithSizeLimit

getGroupPhotoWithSizeLimit(
groupId: string,
maxSize: number,
): Promise<string | undefined>
Get profilePhoto of Group from Graph API with size limit
Parameters
- groupId: string
  The unique identifier for the Group resource
- maxSize: number
  Maximum pixel height of the photo
Returns Promise<string | undefined>
- Defined in plugins/catalog-backend-module-msgraph/src/microsoftGraph/client.ts:312

getGroups

getGroups(
    query?: ODataQuery,
    queryMode?: "basic" | "advanced",
    path?: string,
    signal?: AbortSignal,
): AsyncIterable<Group>
Get a collection of Group from Graph API and return as AsyncIterable
Parameters
- Optionalquery: ODataQuery
  OData Query ODataQuery
- OptionalqueryMode: "basic" | "advanced"
  Mode to use while querying. Some features are only available at "advanced".
- path: string = 'groups'
  Resource endpoint in Microsoft Graph
- Optionalsignal: AbortSignal
Returns AsyncIterable<Group>
- Defined in plugins/catalog-backend-module-msgraph/src/microsoftGraph/client.ts:336

getGroupUserMembers

getGroupUserMembers(
    groupId: string,
    query?: ODataQuery,
    queryMode?: "basic" | "advanced",
    signal?: AbortSignal,
): AsyncIterable<User>
Get a collection of User belonging to a Group from Graph API and return as AsyncIterable
Parameters
- groupId: string
  The unique identifier for the Group resource
- Optionalquery: ODataQuery
  OData Query ODataQuery
- OptionalqueryMode: "basic" | "advanced"
  Mode to use while querying. Some features are only available at "advanced".
- Optionalsignal: AbortSignal
Returns AsyncIterable<User>
- Defined in plugins/catalog-backend-module-msgraph/src/microsoftGraph/client.ts:381

getOrganization

getOrganization(tenantId: string, signal?: AbortSignal): Promise<Organization>
Get Organization from Graph API
Parameters
- tenantId: string
  The unique identifier for the Organization resource
- Optionalsignal: AbortSignal
Returns Promise<Organization>
- Defined in plugins/catalog-backend-module-msgraph/src/microsoftGraph/client.ts:402

getUserPhoto

getUserPhoto(userId: string, sizeId?: string): Promise<string | undefined>
Parameters
- userId: string
- OptionalsizeId: string
Returns Promise<string | undefined>
- Defined in plugins/catalog-backend-module-msgraph/src/microsoftGraph/client.ts:273

getUserPhotoWithSizeLimit

getUserPhotoWithSizeLimit(
userId: string,
maxSize: number,
): Promise<string | undefined>
Get profilePhoto of User from Graph API with size limit
Parameters
- userId: string
  The unique identifier for the User resource
- maxSize: number
  Maximum pixel height of the photo
Returns Promise<string | undefined>
- Defined in plugins/catalog-backend-module-msgraph/src/microsoftGraph/client.ts:266

getUsers

getUsers(
    query?: ODataQuery,
    queryMode?: "basic" | "advanced",
    path?: string,
    signal?: AbortSignal,
): AsyncIterable<User>
Get a collection of User from Graph API and return as AsyncIterable
Parameters
- Optionalquery: ODataQuery
  OData Query ODataQuery
- OptionalqueryMode: "basic" | "advanced"
  Mode to use while querying. Some features are only available at "advanced".
- path: string = 'users'
  Resource endpoint in Microsoft Graph
- Optionalsignal: AbortSignal
Returns AsyncIterable<User>
- Defined in plugins/catalog-backend-module-msgraph/src/microsoftGraph/client.ts:290

requestApi

requestApi(
    path: string,
    query?: ODataQuery,
    headers?: Record<string, string>,
    signal?: AbortSignal,
): Promise<Response>
Abstract on top of MicrosoftGraphClient.requestRaw
Parameters
- path: string
  Resource in Microsoft Graph
- Optionalquery: ODataQuery
  OData Query ODataQuery
- Optionalheaders: Record<string, string>
  optional HTTP headers
- Optionalsignal: AbortSignal
Returns Promise<Response>
- Defined in plugins/catalog-backend-module-msgraph/src/microsoftGraph/client.ts:191

requestCollection

requestCollection<T>(
    path: string,
    query?: ODataQuery,
    queryMode?: "basic" | "advanced",
    signal?: AbortSignal,
): AsyncIterable<T>
Get a collection of resource from Graph API and return an AsyncIterable of that resource
Type Parameters
- T
Parameters
- path: string
  Resource in Microsoft Graph
- Optionalquery: ODataQuery
  OData Query ODataQuery
- OptionalqueryMode: "basic" | "advanced"
  Mode to use while querying. Some features are only available at "advanced".
- Optionalsignal: AbortSignal
Returns AsyncIterable<T>
- Defined in plugins/catalog-backend-module-msgraph/src/microsoftGraph/client.ts:127

requestRaw

requestRaw(
    url: string,
    headers?: Record<string, string>,
    retryCount?: number,
    signal?: AbortSignal,
): Promise<Response>
Makes a HTTP call to Graph API with token
Parameters
- url: string
  HTTP Endpoint of Graph API
- Optionalheaders: Record<string, string>
  optional HTTP headers
- retryCount: number = 2
- Optionalsignal: AbortSignal
Returns Promise<Response>
- Defined in plugins/catalog-backend-module-msgraph/src/microsoftGraph/client.ts:226

`Static`create

create(config: MicrosoftGraphProviderConfig): MicrosoftGraphClient
Factory method that instantiate msal client and return an instance of MicrosoftGraphClient
Parameters
- config: MicrosoftGraphProviderConfig
  Configuration for Interacting with Graph API
Returns MicrosoftGraphClient
- Defined in plugins/catalog-backend-module-msgraph/src/microsoftGraph/client.ts:86

Class MicrosoftGraphClient

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns MicrosoftGraphClient

Methods

getGroupMembers

Parameters

Returns AsyncIterable<GroupMember>

getGroupPhoto

Parameters

Returns Promise<string | undefined>

getGroupPhotoWithSizeLimit

Parameters

Returns Promise<string | undefined>

getGroups

Parameters

Returns AsyncIterable<Group>

getGroupUserMembers

Parameters

Returns AsyncIterable<User>

getOrganization

Parameters

Returns Promise<Organization>

getUserPhoto

Parameters

Returns Promise<string | undefined>

getUserPhotoWithSizeLimit

Parameters

Returns Promise<string | undefined>

getUsers

Parameters

Returns AsyncIterable<User>

requestApi

Parameters

Returns Promise<Response>

requestCollection

Type Parameters

Parameters

Returns AsyncIterable<T>

requestRaw

Parameters

Returns Promise<Response>

Staticcreate

Parameters

Returns MicrosoftGraphClient

Settings

On This Page

`Static`create