Skip to content

Microsoft Entra

Node: microsoftEntra · Full type: n8n-nodes-base.microsoftEntra · Version: 1

Credentials

microsoftEntraOAuth2Api (alias: @microsoft)

CREDENTIAL @microsoft = microsoftEntraOAuth2Api "My Microsoft Entra"

Operations

Resource: group

create

Parameter Type Default Details
groupType options "" Unified, ``
displayName string "" required
mailNickname string "" required
mailEnabled boolean false required
membershipType options "" `,DynamicMembership`
securityEnabled boolean true
additionalFields collection {} keys: isAssignableToRole, description, membershipRule, membershipRuleProcessingState, preferredDataLocation, uniqueName, ...

delete

Parameter Type Default Details
group resourceLocator {...} required; modes: list, id

get

Parameter Type Default Details
group resourceLocator {...} required; modes: list, id
output options "simple" simple, raw, fields
fields multiOptions []
options collection {} keys: includeMembers

getAll

Parameter Type Default Details
returnAll boolean false
limit number 50
filter string ""
output options "simple" simple, raw, fields
fields multiOptions []

update

Parameter Type Default Details
group resourceLocator {...} required; modes: list, id
updateFields collection {} keys: allowExternalSenders, autoSubscribeNewMembers, description, displayName, mailNickname, membershipRule, ...

Resource: user

addGroup

Parameter Type Default Details
group resourceLocator {...} required; modes: list, id
user resourceLocator {...} required; modes: list, id

create

Parameter Type Default Details
accountEnabled boolean true required
displayName string "" required
userPrincipalName string "" required
mailNickname string "" required
password string "" required
additionalFields collection {} keys: aboutMe, ageGroup, birthday, businessPhones, city, companyName, ...

delete

Parameter Type Default Details
user resourceLocator {...} required; modes: list, id

get

Parameter Type Default Details
user resourceLocator {...} required; modes: list, id
output options "simple" simple, raw, fields
fields multiOptions []

getAll

Parameter Type Default Details
returnAll boolean false
limit number 50
filter string ""
output options "simple" simple, raw, fields
fields multiOptions []

removeGroup

Parameter Type Default Details
group resourceLocator {...} required; modes: list, id
user resourceLocator {...} required; modes: list, id

update

Parameter Type Default Details
user resourceLocator {...} required; modes: list, id
updateFields collection {} keys: aboutMe, accountEnabled, ageGroup, birthday, businessPhones, city, ...

Common Parameters

Parameter Type Default Details
requestOptions collection {} keys: batching, allowUnauthorizedCerts, proxy, timeout

Parameter Details

additionalFields children:

Parameter Type Default Details
isAssignableToRole boolean false
description string ""
membershipRule string ""
membershipRuleProcessingState options "On" On, Paused
preferredDataLocation string ""
uniqueName string ""
visibility options "Public" Private, Public

options children:

Parameter Type Default Details
includeMembers boolean false

updateFields children:

Parameter Type Default Details
allowExternalSenders boolean false
autoSubscribeNewMembers boolean false
description string ""
displayName string ""
mailNickname string ""
membershipRule string ""
membershipRuleProcessingState options "On" On, Paused
preferredDataLocation string ""
securityEnabled boolean true
uniqueName string ""
visibility options "Public" Private, Public

requestOptions children:

Parameter Type Default Details
batching fixedCollection {...} groups: batch
allowUnauthorizedCerts boolean false
proxy string ""
timeout number 10000

Example

NODE "microsoftEntra" @microsoft AS "Microsoft Entra" {
  resource: "group",
  operation: "get",
  displayName: {{ $json.displayName }},
  mailNickname: {{ $json.mailNickname }},
  userPrincipalName: {{ $json.userPrincipalName }}
}