Skip to main content
Server path: /microsoft-active-directory-users | Type: Application | PCID required: Yes

Tools

ToolDescription
microsoft_active_directory_users_assign_user_licenseAssign or remove licenses for a user
microsoft_active_directory_users_assign_user_managerAssign a manager to a user
microsoft_active_directory_users_create_userCreate a new user
microsoft_active_directory_users_delete_userDelete a user
microsoft_active_directory_users_get_userGet a user by ID
microsoft_active_directory_users_get_user_mailbox_settingsGet a user’s mailbox settings
microsoft_active_directory_users_get_user_managerGet a user’s manager
microsoft_active_directory_users_get_user_photoGet a user’s profile photo metadata
microsoft_active_directory_users_list_user_app_role_assignmentsList a user’s app role assignments
microsoft_active_directory_users_list_user_authentication_methodsList a user’s authentication methods
microsoft_active_directory_users_list_user_created_objectsList directory objects created by a user
microsoft_active_directory_users_list_user_direct_reportsList a user’s direct reports
microsoft_active_directory_users_list_user_membershipsList groups and roles a user belongs to
microsoft_active_directory_users_list_user_owned_objectsList directory objects owned by a user
microsoft_active_directory_users_list_usersList users
microsoft_active_directory_users_remove_user_managerRemove a user’s manager
microsoft_active_directory_users_reset_user_passwordReset a user’s password
microsoft_active_directory_users_revoke_user_app_role_assignmentRevoke an app role assignment from a user
microsoft_active_directory_users_revoke_user_sign_in_sessionsRevoke all sign-in sessions for a user
microsoft_active_directory_users_update_userUpdate a user
microsoft_active_directory_users_update_user_mailbox_settingsUpdate a user’s mailbox settings

microsoft_active_directory_users_assign_user_license

Assign or remove licenses for a user Parameters:
ParameterTypeRequiredDefaultDescription
user_idstringYesUser Id
addLicensesany[]YesLicenses to add
removeLicensesany[]YesArray of SKU GUIDs to remove

microsoft_active_directory_users_assign_user_manager

Assign a manager to a user Parameters:
ParameterTypeRequiredDefaultDescription
user_idstringYesUser Id
@odata.idstringYesFull URL of the manager (e.g. https://graph.microsoft.com/v1.0/users/{user-id})

microsoft_active_directory_users_create_user

Create a new user Parameters:
ParameterTypeRequiredDefaultDescription
accountEnabledbooleanYesWhether the account is enabled
departmentstringNoThe department value
displayNamestringYesDisplay name of the user
givenNamestringNoGiven Name
jobTitlestringNoJob Title
mailNicknamestringYesMail alias for the user
officeLocationstringNoOffice Location
passwordProfileobjectYesPassword Profile
surnamestringNoThe surname value
userPrincipalNamestringYesUser principal name (e.g. user@contoso.onmicrosoft.com)

microsoft_active_directory_users_delete_user

Delete a user Parameters:
ParameterTypeRequiredDefaultDescription
user_idstringYesUser ID (GUID) or userPrincipalName

microsoft_active_directory_users_get_user

Get a user by ID Parameters:
ParameterTypeRequiredDefaultDescription
user_idstringYesUser ID (GUID) or userPrincipalName
$selectstringNoComma-separated list of properties to return

microsoft_active_directory_users_get_user_mailbox_settings

Get a user’s mailbox settings Parameters:
ParameterTypeRequiredDefaultDescription
user_idstringYesUser Id

microsoft_active_directory_users_get_user_manager

Get a user’s manager Parameters:
ParameterTypeRequiredDefaultDescription
user_idstringYesUser Id
$selectstringNoThe $select value

microsoft_active_directory_users_get_user_photo

Get a user’s profile photo metadata Parameters:
ParameterTypeRequiredDefaultDescription
user_idstringYesUser Id

microsoft_active_directory_users_list_user_app_role_assignments

List a user’s app role assignments Parameters:
ParameterTypeRequiredDefaultDescription
user_idstringYesUser Id

microsoft_active_directory_users_list_user_authentication_methods

List a user’s authentication methods Parameters:
ParameterTypeRequiredDefaultDescription
user_idstringYesUser Id

microsoft_active_directory_users_list_user_created_objects

List directory objects created by a user Parameters:
ParameterTypeRequiredDefaultDescription
user_idstringYesUser Id
$topintegerNoThe $top value

microsoft_active_directory_users_list_user_direct_reports

List a user’s direct reports Parameters:
ParameterTypeRequiredDefaultDescription
user_idstringYesUser Id
$topintegerNoThe $top value

microsoft_active_directory_users_list_user_memberships

List groups and roles a user belongs to Parameters:
ParameterTypeRequiredDefaultDescription
user_idstringYesUser ID (GUID) or userPrincipalName
$selectstringNoComma-separated list of properties to return
$topintegerNoNumber of results to return

microsoft_active_directory_users_list_user_owned_objects

List directory objects owned by a user Parameters:
ParameterTypeRequiredDefaultDescription
user_idstringYesUser Id
$topintegerNoThe $top value

microsoft_active_directory_users_list_users

List users Parameters:
ParameterTypeRequiredDefaultDescription
$filterstringNoOData filter expression (e.g. “displayName eq ‘Jane Doe’”, “mail eq ‘user@contoso.com’”, “startsWith(displayName,‘Jane’)“)
$selectstringNoComma-separated list of properties to return (e.g. “id,displayName,mail,userPrincipalName”)
$topintegerNoNumber of results to return (max 999)
$orderbystringNoOrder results (e.g. “displayName asc”)

microsoft_active_directory_users_remove_user_manager

Remove a user’s manager Parameters:
ParameterTypeRequiredDefaultDescription
user_idstringYesUser Id

microsoft_active_directory_users_reset_user_password

Reset a user’s password Parameters:
ParameterTypeRequiredDefaultDescription
user_idstringYesUser Id
method_idstringYesAuthentication method ID (use 28c10230-6103-485e-b985-444c60001490 for the password method)
newPasswordstringNoNew password (omit to have one generated)

microsoft_active_directory_users_revoke_user_app_role_assignment

Revoke an app role assignment from a user Parameters:
ParameterTypeRequiredDefaultDescription
user_idstringYesUser Id
app_role_assignment_idstringYesThe ID of the appRoleAssignment to remove

microsoft_active_directory_users_revoke_user_sign_in_sessions

Revoke all sign-in sessions for a user Parameters:
ParameterTypeRequiredDefaultDescription
user_idstringYesUser ID (GUID) or userPrincipalName

microsoft_active_directory_users_update_user

Update a user Parameters:
ParameterTypeRequiredDefaultDescription
user_idstringYesUser ID (GUID) or userPrincipalName
accountEnabledbooleanNoAccount Enabled
departmentstringNoThe department value
displayNamestringNoDisplay Name
givenNamestringNoGiven Name
jobTitlestringNoJob Title
mobilePhonestringNoMobile Phone
officeLocationstringNoOffice Location
surnamestringNoThe surname value

microsoft_active_directory_users_update_user_mailbox_settings

Update a user’s mailbox settings Parameters:
ParameterTypeRequiredDefaultDescription
user_idstringYesUser Id
automaticRepliesSettingobjectNoAutomatic Replies Setting
languageobjectNoThe language value
timeZonestringNoTimezone identifier
workingHoursobjectNoWorking Hours