readMicrosoftGraphOrg()

Home > @backstage/plugin-catalog-backend-module-msgraph > readMicrosoftGraphOrg

Reads an entire org as Group and User entities.

Signature:

function readMicrosoftGraphOrg(client: MicrosoftGraphClient, tenantId: string, options: {
    userExpand?: string;
    userFilter?: string;
    userSelect?: string[];
    loadUserPhotos?: boolean;
    userGroupMemberSearch?: string;
    userGroupMemberFilter?: string;
    groupExpand?: string;
    groupSearch?: string;
    groupFilter?: string;
    groupSelect?: string[];
    queryMode?: 'basic' | 'advanced';
    userTransformer?: UserTransformer;
    groupTransformer?: GroupTransformer;
    organizationTransformer?: OrganizationTransformer;
    logger: LoggerService;
}): Promise<{
    users: UserEntity[];
    groups: GroupEntity[];
}>;

Parameters

Parameter	Type	Description
client	MicrosoftGraphClient
tenantId	string
options	{ userExpand?: string; userFilter?: string; userSelect?: string[]; loadUserPhotos?: boolean; userGroupMemberSearch?: string; userGroupMemberFilter?: string; groupExpand?: string; groupSearch?: string; groupFilter?: string; groupSelect?: string[]; queryMode?: 'basic' \| 'advanced'; userTransformer?: UserTransformer; groupTransformer?: GroupTransformer; organizationTransformer?: OrganizationTransformer; logger: LoggerService; }

Returns:

Promise<{ users: UserEntity[]; groups: GroupEntity[]; }>

Parameters​

Parameters