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

Tools


microsoft_active_directory_lifecycle_create_invitation

Invite an external user (B2B guest) Parameters:
ParameterTypeRequiredDefaultDescription
invitedUserDisplayNamestringNoInvited User Display Name
invitedUserEmailAddressstringYesEmail address of the user to invite
invitedUserMessageInfoobjectNoInvited User Message Info
inviteRedirectUrlstringYesURL the user is redirected to after redeeming the invitation
sendInvitationMessagebooleanNoSend Invitation Message

microsoft_active_directory_lifecycle_invite_drive_root

Grant access to the root of a drive Parameters:
ParameterTypeRequiredDefaultDescription
drive_idstringYesDrive ID (typically the user’s drive ID)
expirationDateTimestringNoExpiration Date Time
messagestringNoOptional message to include
recipientsany[]YesThe recipients value
requireSignInbooleanYesRequire Sign In
rolesany[]YesPermission roles, e.g. [‘read’] or [‘write’]
sendInvitationbooleanYesSend Invitation

microsoft_active_directory_lifecycle_list_deleted_groups

List soft-deleted Microsoft 365 groups Parameters:
ParameterTypeRequiredDefaultDescription
$topintegerNoThe $top value

microsoft_active_directory_lifecycle_list_deleted_users

List soft-deleted users Parameters:
ParameterTypeRequiredDefaultDescription
$topintegerNoThe $top value
$filterstringNoThe $filter value

microsoft_active_directory_lifecycle_permanently_delete_directory_object

Permanently delete a directory object Parameters:
ParameterTypeRequiredDefaultDescription
directory_object_idstringYesDirectory Object Id

microsoft_active_directory_lifecycle_restore_deleted_directory_object

Restore a soft-deleted directory object Parameters:
ParameterTypeRequiredDefaultDescription
directory_object_idstringYesID of the deleted directory object