Skip to main content
Microsoft Entra ID logo

Overview

Add Microsoft Entra ID to any ModuleX agent or workflow. Identity and access management via the Microsoft Graph API (graph.microsoft.com/v1.0) for managing users, groups, and directory objects in Microsoft Entra ID (formerly Azure Active Directory).
Categories: Developer Tools & Infrastructure · Identity & Access Management · Enterprise · Security · Auth: OAuth2 · Actions: 12

Authentication

OAuth2 Authentication

Connect using Microsoft Entra ID OAuth (recommended)

Required Credentials

FieldDescriptionRequiredFormat
Client IDMicrosoft Entra ID OAuth App Client IDYesxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Client SecretMicrosoft Entra ID OAuth App Client SecretYesxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

OAuth Configuration

  • Authorization URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
  • Token URL: https://login.microsoftonline.com/common/oauth2/v2.0/token
  • Scopes: User.Read, User.ReadWrite.All, Group.ReadWrite.All, GroupMember.ReadWrite.All, Directory.ReadWrite.All

Available Actions

Parameters

group_id
string
required
Identifier of the group
user_id
string
required
Identifier of the user to add

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    }
  },
  "required": [
    "success"
  ],
  "title": "AddMemberToGroupOutput",
  "type": "object"
}

Parameters

display_name
string
required
The name to display in the address book for the group
mail_enabled
boolean
required
Set to true for mail-enabled groups
mail_nickname
string
required
The mail alias for the group, unique for groups in the organization. Maximum length is 64 characters.
security_enabled
boolean
required
Set to true for security-enabled groups

Response

{
  "$defs": {
    "GroupSummary": {
      "additionalProperties": false,
      "properties": {
        "id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Id"
        },
        "display_name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Display Name"
        },
        "description": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Description"
        },
        "mail_enabled": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Mail Enabled"
        },
        "mail_nickname": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Mail Nickname"
        },
        "security_enabled": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Security Enabled"
        },
        "group_types": {
          "items": {
            "type": "string"
          },
          "title": "Group Types",
          "type": "array"
        },
        "deleted_date_time": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Deleted Date Time"
        }
      },
      "title": "GroupSummary",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "group": {
      "anyOf": [
        {
          "$ref": "#/$defs/GroupSummary"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    }
  },
  "required": [
    "success"
  ],
  "title": "CreateGroupOutput",
  "type": "object"
}

Parameters

group_id
string
required
Identifier of the group to delete

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    }
  },
  "required": [
    "success"
  ],
  "title": "DeleteGroupOutput",
  "type": "object"
}

Parameters

user_id
string
Identifier of the user. Leave empty to use the signed-in user.

Response

{
  "$defs": {
    "ManagerInfo": {
      "additionalProperties": false,
      "properties": {
        "id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Id"
        },
        "display_name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Display Name"
        },
        "email": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Email"
        },
        "job_title": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Job Title"
        },
        "mobile_phone": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Mobile Phone"
        }
      },
      "title": "ManagerInfo",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "manager": {
      "anyOf": [
        {
          "$ref": "#/$defs/ManagerInfo"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    },
    "message": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Message"
    }
  },
  "required": [
    "success"
  ],
  "title": "GetManagerOutput",
  "type": "object"
}

Parameters

user_id
string
Identifier of the user. Leave empty to use the signed-in user.

Response

{
  "$defs": {
    "GroupSummary": {
      "additionalProperties": false,
      "properties": {
        "id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Id"
        },
        "display_name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Display Name"
        },
        "description": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Description"
        },
        "mail_enabled": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Mail Enabled"
        },
        "mail_nickname": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Mail Nickname"
        },
        "security_enabled": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Security Enabled"
        },
        "group_types": {
          "items": {
            "type": "string"
          },
          "title": "Group Types",
          "type": "array"
        },
        "deleted_date_time": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Deleted Date Time"
        }
      },
      "title": "GroupSummary",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "groups": {
      "items": {
        "$ref": "#/$defs/GroupSummary"
      },
      "title": "Groups",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "GetMs365GroupsOutput",
  "type": "object"
}

Response

{
  "$defs": {
    "GroupSummary": {
      "additionalProperties": false,
      "properties": {
        "id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Id"
        },
        "display_name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Display Name"
        },
        "description": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Description"
        },
        "mail_enabled": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Mail Enabled"
        },
        "mail_nickname": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Mail Nickname"
        },
        "security_enabled": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Security Enabled"
        },
        "group_types": {
          "items": {
            "type": "string"
          },
          "title": "Group Types",
          "type": "array"
        },
        "deleted_date_time": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Deleted Date Time"
        }
      },
      "title": "GroupSummary",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "groups": {
      "items": {
        "$ref": "#/$defs/GroupSummary"
      },
      "title": "Groups",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "GetOrganizationGroupsOutput",
  "type": "object"
}

Parameters

max_users
integer
Maximum number of users to return. Omit for no limit.
filter
string
OData filter expression, e.g. ‘accountEnabled eq true’ (Default: accountEnabled eq true)
OData search expression, e.g. ‘“displayName:John“‘

Response

{
  "$defs": {
    "UserSummary": {
      "additionalProperties": false,
      "properties": {
        "id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Id"
        },
        "full_name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Full Name"
        },
        "description": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Description"
        },
        "email": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Email"
        },
        "user_principal_name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "User Principal Name"
        },
        "surname": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Surname"
        },
        "given_name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Given Name"
        },
        "job_title": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Job Title"
        },
        "mobile_phone": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Mobile Phone"
        }
      },
      "title": "UserSummary",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "users": {
      "items": {
        "$ref": "#/$defs/UserSummary"
      },
      "title": "Users",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "GetOrganizationUsersOutput",
  "type": "object"
}

Parameters

user_id
string
Identifier of the user. Leave empty to use the signed-in user.

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "data": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Data"
    }
  },
  "required": [
    "success"
  ],
  "title": "GetProfileOutput",
  "type": "object"
}

Parameters

group_id
string
required
Identifier of the group
user_id
string
required
Identifier of the user to remove

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    }
  },
  "required": [
    "success"
  ],
  "title": "RemoveMemberFromGroupOutput",
  "type": "object"
}

Parameters

query
string
required
Keywords to search by
max_results
integer
The maximum number of groups to return (Default: 100)

Response

{
  "$defs": {
    "GroupSummary": {
      "additionalProperties": false,
      "properties": {
        "id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Id"
        },
        "display_name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Display Name"
        },
        "description": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Description"
        },
        "mail_enabled": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Mail Enabled"
        },
        "mail_nickname": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Mail Nickname"
        },
        "security_enabled": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Security Enabled"
        },
        "group_types": {
          "items": {
            "type": "string"
          },
          "title": "Group Types",
          "type": "array"
        },
        "deleted_date_time": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Deleted Date Time"
        }
      },
      "title": "GroupSummary",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "groups": {
      "items": {
        "$ref": "#/$defs/GroupSummary"
      },
      "title": "Groups",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "SearchGroupsOutput",
  "type": "object"
}

Parameters

group_id
string
required
Identifier of the group to update
allow_external_senders
boolean
Whether people external to the organization can send messages to the group
auto_subscribe_new_members
boolean
Whether new members added to the group will be auto-subscribed to receive email notifications
description
string
An optional description for the group
display_name
string
The name to display in the address book for the group
mail_nickname
string
The mail alias for the group. Maximum length is 64 characters.
security_enabled
boolean
Set to true for security-enabled groups
visibility
string
Specifies the visibility of the group. Allowed values: Public, Private.

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    }
  },
  "required": [
    "success"
  ],
  "title": "UpdateGroupOutput",
  "type": "object"
}

Parameters

user_id
string
required
Identifier of the user to update
display_name
string
The name to display in the address book for the user
mail
string
The SMTP address for the user
mail_nickname
string
The mail alias for the user
account_enabled
boolean
Whether the account is enabled (Default: true)
street_address
string
The street address of the user’s place of business
city
string
The city in which the user is located
state
string
The state or province in the user’s address
postal_code
string
The postal code for the user’s postal address
country
string
The country/region in which the user is located

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    }
  },
  "required": [
    "success"
  ],
  "title": "UpdateUserOutput",
  "type": "object"
}

Limits & Quotas

  • Microsoft Graph throttling: Varies by resource and tenant; typically 10,000 requests per 10 minutes per app per tenant for most directory endpoints.
  • Pagination: List endpoints may return paginated results; the integration follows @odata.nextLink automatically.
  • Error model: Non-2xx responses and timeouts are caught and returned as success=False + error rather than raising.

Okta

Algolia

Amazon Web Services