AptlyStar

Azure AD

Manage users and groups in Azure AD (Microsoft Entra ID)

使用说明

Integrate Azure Active Directory into your workflows. List, create, update, and delete users and groups. Manage group memberships programmatically.

工具

microsoft_ad_list_users

List users in Azure AD (Microsoft Entra ID)

输入

参数类型必填描述
topnumber否Maximum number of users to return (default 100, max 999)
filterstring否OData filter expression (e.g., "department eq 'Sales'")
searchstring否Search string to filter users by displayName or mail

输出

参数类型描述
usersarrayList of users
userCountnumberNumber of users returned

microsoft_ad_get_user

Get a user by ID or user principal name from Azure AD

输入

参数类型必填描述
userIdstring是User ID or user principal name (e.g., "user@example.com")

输出

参数类型描述
userobjectUser details
↳ idstringUser ID
↳ displayNamestringDisplay name
↳ givenNamestringFirst name
↳ surnamestringLast name
↳ userPrincipalNamestringUser principal name (email)
↳ mailstringEmail address
↳ jobTitlestringJob title
↳ departmentstringDepartment
↳ officeLocationstringOffice location
↳ mobilePhonestringMobile phone number
↳ accountEnabledbooleanWhether the account is enabled

microsoft_ad_create_user

Create a new user in Azure AD (Microsoft Entra ID)

输入

参数类型必填描述
displayNamestring是Display name for the user
mailNicknamestring是Mail alias for the user
userPrincipalNamestring是User principal name (e.g., "user@example.com")
passwordstring是Initial password for the user
accountEnabledboolean是Whether the account is enabled
givenNamestring否First name
surnamestring否Last name
jobTitlestring否Job title
departmentstring否Department
officeLocationstring否Office location
mobilePhonestring否Mobile phone number

输出

参数类型描述
userobjectCreated user details
↳ idstringUser ID
↳ displayNamestringDisplay name
↳ givenNamestringFirst name
↳ surnamestringLast name
↳ userPrincipalNamestringUser principal name (email)
↳ mailstringEmail address
↳ jobTitlestringJob title
↳ departmentstringDepartment
↳ officeLocationstringOffice location
↳ mobilePhonestringMobile phone number
↳ accountEnabledbooleanWhether the account is enabled

microsoft_ad_update_user

Update user properties in Azure AD (Microsoft Entra ID)

输入

参数类型必填描述
userIdstring是User ID or user principal name
displayNamestring否Display name
givenNamestring否First name
surnamestring否Last name
jobTitlestring否Job title
departmentstring否Department
officeLocationstring否Office location
mobilePhonestring否Mobile phone number
accountEnabledboolean否Whether the account is enabled

输出

参数类型描述
updatedbooleanWhether the update was successful
userIdstringID of the updated user

microsoft_ad_delete_user

Delete a user from Azure AD (Microsoft Entra ID). The user is moved to a temporary container and can be restored within 30 days.

输入

参数类型必填描述
userIdstring是User ID or user principal name

输出

参数类型描述
deletedbooleanWhether the deletion was successful
userIdstringID of the deleted user

microsoft_ad_list_groups

List groups in Azure AD (Microsoft Entra ID)

输入

参数类型必填描述
topnumber否Maximum number of groups to return (default 100, max 999)
filterstring否OData filter expression (e.g., "securityEnabled eq true")
searchstring否Search string to filter groups by displayName or description

输出

参数类型描述
groupsarrayList of groups
groupCountnumberNumber of groups returned

microsoft_ad_get_group

Get a group by ID from Azure AD (Microsoft Entra ID)

输入

参数类型必填描述
groupIdstring是Group ID

输出

参数类型描述
groupobjectGroup details
↳ idstringGroup ID
↳ displayNamestringDisplay name
↳ descriptionstringGroup description
↳ mailstringEmail address
↳ mailEnabledbooleanWhether mail is enabled
↳ mailNicknamestringMail nickname
↳ securityEnabledbooleanWhether security is enabled
↳ groupTypesarrayGroup types
↳ visibilitystringGroup visibility
↳ createdDateTimestringCreation date

microsoft_ad_create_group

Create a new group in Azure AD (Microsoft Entra ID)

输入

参数类型必填描述
displayNamestring是Display name for the group
mailNicknamestring是Mail alias for the group (ASCII only, max 64 characters)
descriptionstring否Group description
mailEnabledboolean是Whether mail is enabled (true for Microsoft 365 groups)
securityEnabledboolean是Whether security is enabled (true for security groups)
groupTypesstring否Group type: "Unified" for Microsoft 365 group, leave empty for security group
visibilitystring否Group visibility: "Private" or "Public"

输出

参数类型描述
groupobjectCreated group details
↳ idstringGroup ID
↳ displayNamestringDisplay name
↳ descriptionstringGroup description
↳ mailstringEmail address
↳ mailEnabledbooleanWhether mail is enabled
↳ mailNicknamestringMail nickname
↳ securityEnabledbooleanWhether security is enabled
↳ groupTypesarrayGroup types
↳ visibilitystringGroup visibility
↳ createdDateTimestringCreation date

microsoft_ad_update_group

Update group properties in Azure AD (Microsoft Entra ID)

输入

参数类型必填描述
groupIdstring是Group ID
displayNamestring否Display name
descriptionstring否Group description
mailNicknamestring否Mail alias
visibilitystring否Group visibility: "Private" or "Public"

输出

参数类型描述
updatedbooleanWhether the update was successful
groupIdstringID of the updated group

microsoft_ad_delete_group

Delete a group from Azure AD (Microsoft Entra ID). Microsoft 365 and security groups can be restored within 30 days.

输入

参数类型必填描述
groupIdstring是Group ID

输出

参数类型描述
deletedbooleanWhether the deletion was successful
groupIdstringID of the deleted group

microsoft_ad_list_group_members

List members of a group in Azure AD (Microsoft Entra ID)

输入

参数类型必填描述
groupIdstring是Group ID
topnumber否Maximum number of members to return (default 100, max 999)

输出

参数类型描述
membersarrayList of group members
memberCountnumberNumber of members returned

microsoft_ad_add_group_member

Add a member to a group in Azure AD (Microsoft Entra ID)

输入

参数类型必填描述
groupIdstring是Group ID
memberIdstring是User ID of the member to add

输出

参数类型描述
addedbooleanWhether the member was added successfully
groupIdstringGroup ID
memberIdstringMember ID that was added

microsoft_ad_remove_group_member

Remove a member from a group in Azure AD (Microsoft Entra ID)

输入

参数类型必填描述
groupIdstring是Group ID
memberIdstring是User ID of the member to remove

输出

参数类型描述
removedbooleanWhether the member was removed successfully
groupIdstringGroup ID
memberIdstringMember ID that was removed

On this page