Backstage
Docs
Github
Preparing search index...
@backstage/plugin-catalog-backend-module-msgraph
index
readMicrosoftGraphOrg
Function readMicrosoftGraphOrg
readMicrosoftGraphOrg
(
client
:
MicrosoftGraphClient
,
tenantId
:
string
,
options
:
{
groupExpand
?:
string
;
groupFilter
?:
string
;
groupIncludeSubGroups
?:
boolean
;
groupPath
?:
string
;
groupSearch
?:
string
;
groupSelect
?:
string
[]
;
groupTransformer
?:
GroupTransformer
;
loadUserPhotos
?:
boolean
;
logger
:
LoggerService
;
organizationTransformer
?:
OrganizationTransformer
;
queryMode
?:
"basic"
|
"advanced"
;
userExpand
?:
string
;
userFilter
?:
string
;
userGroupMemberFilter
?:
string
;
userGroupMemberPath
?:
string
;
userGroupMemberSearch
?:
string
;
userPath
?:
string
;
userSelect
?:
string
[]
;
userTransformer
?:
UserTransformer
;
}
,
)
:
Promise
<
{
groups
:
GroupEntity
[]
;
users
:
UserEntity
[]
}
>
Reads an entire org as Group and User entities.
Parameters
client
:
MicrosoftGraphClient
tenantId
:
string
options
:
{
groupExpand
?:
string
;
groupFilter
?:
string
;
groupIncludeSubGroups
?:
boolean
;
groupPath
?:
string
;
groupSearch
?:
string
;
groupSelect
?:
string
[]
;
groupTransformer
?:
GroupTransformer
;
loadUserPhotos
?:
boolean
;
logger
:
LoggerService
;
organizationTransformer
?:
OrganizationTransformer
;
queryMode
?:
"basic"
|
"advanced"
;
userExpand
?:
string
;
userFilter
?:
string
;
userGroupMemberFilter
?:
string
;
userGroupMemberPath
?:
string
;
userGroupMemberSearch
?:
string
;
userPath
?:
string
;
userSelect
?:
string
[]
;
userTransformer
?:
UserTransformer
;
}
Returns
Promise
<
{
groups
:
GroupEntity
[]
;
users
:
UserEntity
[]
}
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
Docs
Github
Backstage
Loading...
Reads an entire org as Group and User entities.