Azure AD

Azure Active Directory (now Microsoft Entra ID) is Microsoft's cloud-based identity and access management service. It helps organizations manage users, groups, and access to applications and resources across cloud and on-premises environments.

With the Azure AD integration in Studio, you can:

  • Manage users: List, create, update, and delete user accounts in your directory
  • Manage groups: Create and configure security groups and Microsoft 365 groups
  • Control group membership: Add and remove members from groups programmatically
  • Query directory data: Search and filter users and groups using OData expressions
  • Automate onboarding/offboarding: Create new user accounts with initial passwords and enable/disable accounts as part of HR workflows

In Studio, the Azure AD integration enables your agents to programmatically manage your organization's identity infrastructure. This allows for automation scenarios such as provisioning new employees, updating user profiles in bulk, managing team group memberships, and auditing directory data. By connecting Studio with Azure AD, you can streamline identity lifecycle management and ensure your directory stays in sync with your organization's needs.

Usage Instructions

Integrate Azure Active Directory into your workflows. Create, update, and delete users and groups, manage group memberships, assign and remove licenses, reset passwords, revoke sign-in sessions, read sign-in and directory audit logs, grant and revoke app and directory roles, and read registered devices and conditional access policies. Device writes are not supported.

Actions

List Azure AD Users

List users in Azure AD (Microsoft Entra ID)

Input

ParameterTypeRequiredDescription
topnumberNoMaximum number of users to return (default 100, max 999)
filterstringNoOData filter expression (e.g., "department eq 'Sales'")
searchstringNoSearch string to filter users by displayName or mail
nextLinkstringNoContinuation URL from a previous response's 'nextLink' output, used to fetch the next page of results

Output

ParameterTypeDescription
usersarrayList of users
↳ 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
userCountnumberNumber of users returned
nextLinkstringContinuation URL for the next page of results, or null if there are no more

Get Azure AD User

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

Input

ParameterTypeRequiredDescription
userIdstringYesUser ID or user principal name (e.g., "user@example.com")

Output

ParameterTypeDescription
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

Create Azure AD User

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

Input

ParameterTypeRequiredDescription
displayNamestringYesDisplay name for the user
mailNicknamestringYesMail alias for the user
userPrincipalNamestringYesUser principal name (e.g., "user@example.com")
passwordstringYesInitial password for the user
accountEnabledbooleanYesWhether the account is enabled
givenNamestringNoFirst name
surnamestringNoLast name
jobTitlestringNoJob title
departmentstringNoDepartment
officeLocationstringNoOffice location
mobilePhonestringNoMobile phone number

Output

ParameterTypeDescription
userobjectCreated user details
↳ idstringUser ID
↳ displayNamestringDisplay name
↳ givenNamestringFirst name
↳ surnamestringLast name
↳ userPrincipalNamestringUser principal name (email)
↳ mailstringEmail address
↳ jobTitlestringJob title
↳ officeLocationstringOffice location
↳ mobilePhonestringMobile phone number
↳ businessPhonesarrayBusiness phone numbers
↳ preferredLanguagestringPreferred language

Update Azure AD User

Update user properties in Azure AD (Microsoft Entra ID)

Input

ParameterTypeRequiredDescription
userIdstringYesUser ID or user principal name
displayNamestringNoDisplay name
givenNamestringNoFirst name
surnamestringNoLast name
jobTitlestringNoJob title
departmentstringNoDepartment
officeLocationstringNoOffice location
mobilePhonestringNoMobile phone number
accountEnabledbooleanNoWhether the account is enabled

Output

ParameterTypeDescription
updatedbooleanWhether the update was successful
userIdstringID of the updated user

Delete Azure AD 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.

Input

ParameterTypeRequiredDescription
userIdstringYesUser ID or user principal name

Output

ParameterTypeDescription
deletedbooleanWhether the deletion was successful
userIdstringID of the deleted user

List Azure AD Groups

List groups in Azure AD (Microsoft Entra ID)

Input

ParameterTypeRequiredDescription
topnumberNoMaximum number of groups to return (default 100, max 999)
filterstringNoOData filter expression (e.g., "securityEnabled eq true")
searchstringNoSearch string to filter groups by displayName or description
nextLinkstringNoContinuation URL from a previous response's 'nextLink' output, used to fetch the next page of results

Output

ParameterTypeDescription
groupsarrayList of groups
↳ idstringGroup ID
↳ displayNamestringDisplay name
↳ descriptionstringGroup description
↳ mailstringEmail address
↳ mailEnabledbooleanWhether mail is enabled
↳ mailNicknamestringMail nickname
↳ securityEnabledbooleanWhether security is enabled
↳ groupTypesarrayGroup types
↳ visibilitystringGroup visibility
↳ createdDateTimestringCreation date
groupCountnumberNumber of groups returned
nextLinkstringContinuation URL for the next page of results, or null if there are no more

Get Azure AD Group

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

Input

ParameterTypeRequiredDescription
groupIdstringYesGroup ID

Output

ParameterTypeDescription
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

Create Azure AD Group

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

Input

ParameterTypeRequiredDescription
displayNamestringYesDisplay name for the group
mailNicknamestringYesMail alias for the group (ASCII only, max 64 characters)
descriptionstringNoGroup description
mailEnabledbooleanYesWhether mail is enabled (true for Microsoft 365 groups)
securityEnabledbooleanYesWhether security is enabled (true for security groups)
groupTypesstringNoGroup type: "Unified" for Microsoft 365 group, leave empty for security group
visibilitystringNoGroup visibility: "Private" or "Public" (can be changed later), or "HiddenMembership" (Microsoft 365 groups only; can only be set at creation and never changed afterward)

Output

ParameterTypeDescription
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

Update Azure AD Group

Update group properties in Azure AD (Microsoft Entra ID)

Input

ParameterTypeRequiredDescription
groupIdstringYesGroup ID
displayNamestringNoDisplay name
descriptionstringNoGroup description
mailNicknamestringNoMail alias
visibilitystringNoGroup visibility: "Private" or "Public"

Output

ParameterTypeDescription
updatedbooleanWhether the update was successful
groupIdstringID of the updated group

Delete Azure AD Group

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

Input

ParameterTypeRequiredDescription
groupIdstringYesGroup ID

Output

ParameterTypeDescription
deletedbooleanWhether the deletion was successful
groupIdstringID of the deleted group

List Azure AD Group Members

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

Input

ParameterTypeRequiredDescription
groupIdstringNoGroup ID. Not needed when Next Page is provided to fetch a later page.
topnumberNoMaximum number of members to return (default 100, max 999)
nextLinkstringNoContinuation URL from a previous response's 'nextLink' output, used to fetch the next page of results

Output

ParameterTypeDescription
membersarrayList of group members
↳ idstringMember ID
↳ displayNamestringDisplay name
↳ mailstringEmail address
↳ odataTypestringDirectory object type
memberCountnumberNumber of members returned
nextLinkstringContinuation URL for the next page of results, or null if there are no more

Add Azure AD Group Member

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

Input

ParameterTypeRequiredDescription
groupIdstringYesGroup ID
memberIdstringYesUser ID of the member to add

Output

ParameterTypeDescription
addedbooleanWhether the member was added successfully
groupIdstringGroup ID
memberIdstringMember ID that was added

Remove Azure AD Group Member

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

Input

ParameterTypeRequiredDescription
groupIdstringYesGroup ID
memberIdstringYesUser ID of the member to remove

Output

ParameterTypeDescription
removedbooleanWhether the member was removed successfully
groupIdstringGroup ID
memberIdstringMember ID that was removed

Assign Microsoft Entra ID License

Add or remove subscription licenses (SKUs) on a user in Microsoft Entra ID. Removing a license immediately revokes the access it granted to the associated services.

Input

ParameterTypeRequiredDescription
userIdstringYesUser ID or user principal name to change licenses for
addSkuIdsstringNoComma-separated SKU IDs (GUIDs) of the licenses to assign. Leave empty to only remove licenses.
removeSkuIdsstringNoComma-separated SKU IDs (GUIDs) of the licenses to remove. Leave empty to only add licenses.
disabledPlanIdsstringNoComma-separated service plan IDs (GUIDs) to disable on every license being assigned

Output

ParameterTypeDescription
userIdstringID of the user whose licenses changed
displayNamestringDisplay name of the user
userPrincipalNamestringUser principal name of the user
assignedLicensesarrayLicenses assigned to the user after the change
↳ skuIdstringSKU ID of the assigned license
↳ disabledPlansarrayService plan IDs disabled on this license

List Microsoft Entra ID User Licenses

List the subscription licenses assigned to a user in Microsoft Entra ID

Input

ParameterTypeRequiredDescription
userIdstringYesUser ID or user principal name

Output

ParameterTypeDescription
licensesarrayLicenses assigned to the user
↳ idstringLicense detail ID
↳ skuIdstringSKU ID of the license
↳ skuPartNumberstringSKU part number (e.g., "ENTERPRISEPACK")
↳ servicePlansarrayService plans included in the license
↳ servicePlanIdstringService plan ID
↳ servicePlanNamestringService plan name
↳ provisioningStatusstringProvisioning status of the service plan
↳ appliesTostringWhether the plan applies to "User" or "Company"
licenseCountnumberNumber of licenses returned

List Microsoft Entra ID Subscribed SKUs

List the subscription SKUs the tenant owns, including how many license units are prepaid and how many are consumed

Input

ParameterTypeRequiredDescription

Output

ParameterTypeDescription
skusarraySubscription SKUs owned by the tenant
↳ idstringSubscribed SKU object ID
↳ skuIdstringSKU ID, used when assigning or removing licenses
↳ skuPartNumberstringSKU part number (e.g., "ENTERPRISEPACK")
↳ appliesTostringWhether the SKU applies to "User" or "Company"
↳ capabilityStatusstringCapability status of the subscription
↳ consumedUnitsnumberNumber of licenses currently assigned
↳ prepaidUnitsobjectPrepaid license unit counts by status
↳ enablednumberNumber of units that are enabled
↳ suspendednumberNumber of units that are suspended
↳ warningnumberNumber of units that are in warning status
↳ lockedOutnumberNumber of units that are locked out
↳ servicePlansarrayService plans included in the SKU
↳ servicePlanIdstringService plan ID
↳ servicePlanNamestringService plan name
↳ provisioningStatusstringProvisioning status of the service plan
↳ appliesTostringWhether the plan applies to "User" or "Company"
skuCountnumberNumber of SKUs returned

Revoke Microsoft Entra ID Sign-In Sessions

Invalidate every refresh token and session cookie issued to a user, forcing them to sign in again on all applications and devices. Revocation can take a few minutes to take effect and does not apply to external users.

Input

ParameterTypeRequiredDescription
userIdstringYesUser ID or user principal name whose sessions should be revoked

Output

ParameterTypeDescription
revokedbooleanWhether Microsoft Graph confirmed the sessions were revoked
userIdstringID of the user whose sessions were revoked

Set Microsoft Entra ID User Password

Set a specific password on a user by updating their password profile. Cannot be used for federated users. Requires an administrator role in Microsoft Entra ID.

Input

ParameterTypeRequiredDescription
userIdstringYesUser ID or user principal name whose password should be set
passwordstringYesThe new password. Must satisfy the tenant password policy.
forceChangePasswordNextSignInbooleanNoWhether the user must change this password at their next sign-in. Defaults to true.
forceChangePasswordNextSignInWithMfabooleanNoWhether the user must complete multifactor authentication before being forced to change the password

Output

ParameterTypeDescription
updatedbooleanWhether the password was set successfully
userIdstringID of the user whose password was set
forceChangePasswordNextSignInbooleanWhether the user must change the password at their next sign-in

Reset Microsoft Entra ID User Password

Reset another user's password through their password authentication method. Leave the new password empty to have Microsoft generate one and return it. The user is prompted to change the password at their next sign-in. Cannot be run against your own account.

Input

ParameterTypeRequiredDescription
userIdstringYesUser ID or user principal name whose password should be reset
newPasswordstringNoThe new password. Required for tenants with hybrid password scenarios. Leave empty for a cloud-only password to have Microsoft generate and return one.

Output

ParameterTypeDescription
acceptedbooleanWhether Microsoft Graph accepted the password reset operation
userIdstringID of the user whose password was reset
newPasswordstringThe system-generated password, returned only when no new password was supplied in the request. Like every tool output it appears in workflow outputs and run history, and is sent to the model when an agent calls this tool, so prefer supplying your own password when the value must not leave the workflow.
operationLocationstringURL to poll for the status of the long-running password reset operation

List Microsoft Entra ID Authentication Methods

List the authentication methods a user has registered, such as passwords, phone numbers, FIDO2 keys, and authenticator apps

Input

ParameterTypeRequiredDescription
userIdstringYesUser ID or user principal name

Output

ParameterTypeDescription
methodsarrayAuthentication methods registered by the user
↳ idstringAuthentication method ID
↳ odataTypestringAuthentication method type (e.g., "#microsoft.graph.phoneAuthenticationMethod"). Method-specific details vary by type.
↳ createdDateTimestringWhen the authentication method was registered
methodCountnumberNumber of authentication methods returned

List Microsoft Entra ID Sign-Ins

List sign-in events from the Microsoft Entra ID sign-in logs, newest first. Requires a Microsoft Entra ID P1 or P2 license. Apply a date filter to keep large queries from timing out.

Input

ParameterTypeRequiredDescription
topnumberNoMaximum number of sign-ins to return (default and maximum page size is 1000)
filterstringNoOData filter expression. Filterable fields include userPrincipalName, userId, appId, appDisplayName, ipAddress, createdDateTime, conditionalAccessStatus, riskState and status/errorCode. Example: "createdDateTime ge 2024-01-01T00:00:00Z and status/errorCode ne 0".
nextLinkstringNoContinuation URL from a previous response's 'nextLink' output, used to fetch the next page of results

Output

ParameterTypeDescription
signInsarraySign-in events
↳ idstringSign-in event ID
↳ createdDateTimestringWhen the sign-in was initiated
↳ userIdstringID of the user who signed in
↳ userDisplayNamestringDisplay name of the user
↳ userPrincipalNamestringUser principal name of the user
↳ appIdstringID of the application used to sign in
↳ appDisplayNamestringDisplay name of the application
↳ resourceIdstringID of the resource that was accessed
↳ resourceDisplayNamestringDisplay name of the resource
↳ ipAddressstringIP address the sign-in came from
↳ clientAppUsedstringLegacy client app used to sign in
↳ correlationIdstringCorrelation ID for the sign-in request
↳ conditionalAccessStatusstringConditional access result: success, failure, notApplied, or unknownFutureValue
↳ isInteractivebooleanWhether the sign-in was interactive
↳ riskDetailstringReason behind a specific risk state
↳ riskLevelAggregatedstringAggregated risk level for the sign-in
↳ riskStatestringRisk state of the user or sign-in
↳ errorCodenumberSign-in status error code. 0 indicates a successful sign-in.
↳ failureReasonstringFailure reason from the sign-in status
↳ deviceDisplayNamestringDisplay name of the device used
↳ deviceIdstringID of the device used
↳ deviceOperatingSystemstringOperating system of the device used
↳ deviceBrowserstringBrowser used to sign in
↳ deviceIsCompliantbooleanWhether the device is compliant
↳ deviceIsManagedbooleanWhether the device is managed
↳ locationCitystringCity the sign-in came from
↳ locationStatestringState the sign-in came from
↳ locationCountryOrRegionstringTwo-letter country or region code the sign-in came from
signInCountnumberNumber of sign-ins returned
nextLinkstringContinuation URL for the next page of results, or null if there are no more

List Microsoft Entra ID Directory Audits

List directory audit records showing who changed what in Microsoft Entra ID, such as user creation, group membership changes, and role assignments

Input

ParameterTypeRequiredDescription
topnumberNoMaximum number of audit records to return
filterstringNoOData filter expression. Filterable fields include activityDateTime, activityDisplayName, correlationId, loggedByService, initiatedBy and targetResources. Example: "activityDateTime ge 2024-01-01T00:00:00Z".
nextLinkstringNoContinuation URL from a previous response's 'nextLink' output, used to fetch the next page of results

Output

ParameterTypeDescription
auditsarrayDirectory audit records
↳ idstringAudit record ID
↳ activityDateTimestringWhen the activity took place
↳ activityDisplayNamestringName of the activity
↳ categorystringCategory of the activity
↳ correlationIdstringCorrelation ID for the activity
↳ loggedByServicestringService that logged the activity
↳ operationTypestringOperation type (e.g., Add, Update, Delete)
↳ resultstringResult of the activity: success, failure, timeout, or unknownFutureValue
↳ resultReasonstringReason for the result
↳ initiatedByUserIdstringID of the user who initiated the activity
↳ initiatedByUserPrincipalNamestringUser principal name of the initiating user
↳ initiatedByUserDisplayNamestringDisplay name of the initiating user
↳ initiatedByAppIdstringApp ID that initiated the activity
↳ initiatedByAppDisplayNamestringDisplay name of the app that initiated the activity
↳ targetResourcesarrayResources the activity acted on
↳ idstringID of the target resource
↳ displayNamestringDisplay name of the target resource
↳ typestringType of the target resource (e.g., User, Group)
↳ userPrincipalNamestringUser principal name of the target, null for non-user resources
auditCountnumberNumber of audit records returned
nextLinkstringContinuation URL for the next page of results, or null if there are no more

List Microsoft Entra ID User App Role Assignments

List the application role assignments granted to a user, including assignments the user inherits from groups they are a direct member of

Input

ParameterTypeRequiredDescription
userIdstringNoUser ID or user principal name. Not needed when Next Page is provided to fetch a later page.
topnumberNoMaximum number of assignments to return
filterstringNoOData filter expression. Filterable fields include id, resourceId and principalDisplayName. Example: "resourceId eq 8e881353-1735-45af-af21-ee1344582a4d".
nextLinkstringNoContinuation URL from a previous response's 'nextLink' output, used to fetch the next page of results

Output

ParameterTypeDescription
assignmentsarrayApp role assignments granted to the user
↳ idstringApp role assignment ID, used when removing the assignment
↳ appRoleIdstringID of the app role. All-zero GUID means the assignment grants access without a specific role.
↳ createdDateTimestringWhen the assignment was created
↳ principalIdstringID of the assigned principal
↳ principalDisplayNamestringDisplay name of the assigned principal
↳ principalTypestringPrincipal type: User, Group, or ServicePrincipal
↳ resourceIdstringID of the resource service principal that defines the app role
↳ resourceDisplayNamestringDisplay name of the resource
assignmentCountnumberNumber of assignments returned
nextLinkstringContinuation URL for the next page of results, or null if there are no more

Grant Microsoft Entra ID App Role To User

Grant a user an application role on a service principal, giving them access to that application

Input

ParameterTypeRequiredDescription
userIdstringYesObject ID or user principal name of the user to grant the app role to. A user principal name is resolved to its object ID before the grant.
resourceIdstringYesObject ID of the resource service principal that defines the app role. Use List Service Principals to find it.
appRoleIdstringYesID of the app role to grant. Use the all-zero GUID 00000000-0000-0000-0000-000000000000 to assign access without a specific role.

Output

ParameterTypeDescription
assignmentobjectThe created app role assignment
↳ idstringApp role assignment ID, used when removing the assignment
↳ appRoleIdstringID of the app role. All-zero GUID means the assignment grants access without a specific role.
↳ createdDateTimestringWhen the assignment was created
↳ principalIdstringID of the assigned principal
↳ principalDisplayNamestringDisplay name of the assigned principal
↳ principalTypestringPrincipal type: User, Group, or ServicePrincipal
↳ resourceIdstringID of the resource service principal that defines the app role
↳ resourceDisplayNamestringDisplay name of the resource

Revoke Microsoft Entra ID App Role From User

Revoke an application role assignment from a user, removing their access to that application. Takes the assignment's own ID, not the app role ID.

Input

ParameterTypeRequiredDescription
userIdstringYesUser ID or user principal name the assignment belongs to
appRoleAssignmentIdstringYesID of the app role assignment to remove, taken from the "id" field of List User App Role Assignments

Output

ParameterTypeDescription
removedbooleanWhether the assignment was removed successfully
userIdstringID of the user the assignment belonged to
appRoleAssignmentIdstringID of the removed app role assignment

List Microsoft Entra ID Service Principals

List the enterprise applications and service principals in the tenant, including the app roles each one exposes

Input

ParameterTypeRequiredDescription
topnumberNoMaximum number of service principals to return (default and maximum page size is 100)
filterstringNoOData filter expression. Example: "servicePrincipalType eq 'Application'" or "startsWith(displayName, 'Salesforce')".
searchstringNoSearch string matched against the service principal display name
nextLinkstringNoContinuation URL from a previous response's 'nextLink' output, used to fetch the next page of results

Output

ParameterTypeDescription
servicePrincipalsarrayService principals in the tenant
↳ idstringService principal object ID, used as the resource ID of an app role assignment
↳ appIdstringApplication ID associated with the service principal
↳ displayNamestringDisplay name of the service principal
↳ servicePrincipalTypestringType of service principal (e.g., Application, ManagedIdentity, Legacy)
↳ accountEnabledbooleanWhether users can sign in to the associated application
↳ appOwnerOrganizationIdstringTenant ID where the application is registered
↳ signInAudiencestringWhich Microsoft accounts are supported by the associated application
↳ tagsarrayCustom strings used to categorize the service principal
↳ appRolesarrayApp roles exposed by the associated application
↳ idstringApp role ID, used when granting an app role assignment
↳ displayNamestringDisplay name of the app role
↳ descriptionstringDescription of the app role
↳ valuestringValue included in the roles claim for this app role
↳ isEnabledbooleanWhether the app role can be assigned
↳ allowedMemberTypesarrayPrincipal types the app role can be assigned to (User and/or Application)
servicePrincipalCountnumberNumber of service principals returned
nextLinkstringContinuation URL for the next page of results, or null if there are no more

List Microsoft Entra ID Application Assignments

List every user, group, and service principal assigned to an application, by reading the app role assignments on its service principal. Recently granted or removed assignments can take time to appear.

Input

ParameterTypeRequiredDescription
servicePrincipalIdstringNoObject ID of the service principal. Use List Service Principals to find it. Not needed when Next Page is provided to fetch a later page.
filterstringNoOData filter expression supporting eq and startswith. Example: "principalType eq 'User'".
nextLinkstringNoContinuation URL from a previous response's 'nextLink' output, used to fetch the next page of results

Output

ParameterTypeDescription
assignmentsarrayPrincipals assigned to the application
↳ idstringApp role assignment ID, used when removing the assignment
↳ appRoleIdstringID of the app role. All-zero GUID means the assignment grants access without a specific role.
↳ createdDateTimestringWhen the assignment was created
↳ principalIdstringID of the assigned principal
↳ principalDisplayNamestringDisplay name of the assigned principal
↳ principalTypestringPrincipal type: User, Group, or ServicePrincipal
↳ resourceIdstringID of the resource service principal that defines the app role
↳ resourceDisplayNamestringDisplay name of the resource
assignmentCountnumberNumber of assignments returned
nextLinkstringContinuation URL for the next page of results, or null if there are no more

List Microsoft Entra ID Directory Roles

List the administrator roles that are activated in the tenant, such as Global Administrator and User Administrator. Roles that have never been activated are not returned.

Input

ParameterTypeRequiredDescription

Output

ParameterTypeDescription
rolesarrayActivated directory roles
↳ idstringDirectory role object ID
↳ displayNamestringDisplay name of the directory role
↳ descriptionstringDescription of the directory role
↳ roleTemplateIdstringID of the directory role template
roleCountnumberNumber of directory roles returned

List Microsoft Entra ID Directory Role Members

List the principals holding an administrator role. Returns up to 1000 members; this endpoint does not support paging.

Input

ParameterTypeRequiredDescription
directoryRoleIdstringYesObject ID of the directory role. Use List Directory Roles to find it.

Output

ParameterTypeDescription
membersarrayPrincipals holding the directory role
↳ idstringMember ID
↳ displayNamestringDisplay name
↳ mailstringEmail address
↳ odataTypestringDirectory object type
memberCountnumberNumber of members returned

Add Microsoft Entra ID Directory Role Member

Grant a user an administrator role in Microsoft Entra ID. This is a privileged change that expands what the user can do across the tenant.

Input

ParameterTypeRequiredDescription
directoryRoleIdstringYesObject ID of the directory role. Use List Directory Roles to find it.
memberIdstringYesObject ID of the user to grant the role to

Output

ParameterTypeDescription
addedbooleanWhether the member was added successfully
directoryRoleIdstringID of the directory role
memberIdstringID of the member that was added

Remove Microsoft Entra ID Directory Role Member

Revoke an administrator role from a user in Microsoft Entra ID. Removes only the role membership; the user account itself is not deleted.

Input

ParameterTypeRequiredDescription
directoryRoleIdstringYesObject ID of the directory role. Use List Directory Roles to find it.
memberIdstringYesObject ID of the user to remove the role from

Output

ParameterTypeDescription
removedbooleanWhether the member was removed successfully
directoryRoleIdstringID of the directory role
memberIdstringID of the member that was removed

List Microsoft Entra ID Devices

List the devices registered in Microsoft Entra ID

Input

ParameterTypeRequiredDescription
topnumberNoMaximum number of devices to return
filterstringNoOData filter expression. Example: "accountEnabled eq false" or "operatingSystem eq 'Windows'".
searchstringNoSearch string matched against the device display name
nextLinkstringNoContinuation URL from a previous response's 'nextLink' output, used to fetch the next page of results

Output

ParameterTypeDescription
devicesarrayRegistered devices
↳ idstringDevice object ID, used to get, update, or delete the device
↳ deviceIdstringUnique device identifier set during registration
↳ displayNamestringDisplay name of the device
↳ operatingSystemstringOperating system of the device
↳ operatingSystemVersionstringOperating system version of the device
↳ accountEnabledbooleanWhether the device is enabled
↳ isCompliantbooleanWhether the device complies with MDM policies
↳ isManagedbooleanWhether the device is managed by an MDM app
↳ trustTypestringDevice registration type: Workplace, AzureAd, or ServerAd
↳ profileTypestringDevice profile type: RegisteredDevice, SecureVM, Printer, Shared, or IoT
↳ manufacturerstringManufacturer of the device
↳ modelstringModel of the device
↳ approximateLastSignInDateTimestringApproximate time the device last signed in
↳ registrationDateTimestringWhen the device was registered
deviceCountnumberNumber of devices returned
nextLinkstringContinuation URL for the next page of results, or null if there are no more

Get Microsoft Entra ID Device

Get a registered device by its object ID from Microsoft Entra ID

Input

ParameterTypeRequiredDescription
deviceObjectIdstringYesDevice object ID (the "id" field), not the "deviceId" registration identifier

Output

ParameterTypeDescription
deviceobjectDevice details
↳ idstringDevice object ID, used to get, update, or delete the device
↳ deviceIdstringUnique device identifier set during registration
↳ displayNamestringDisplay name of the device
↳ operatingSystemstringOperating system of the device
↳ operatingSystemVersionstringOperating system version of the device
↳ accountEnabledbooleanWhether the device is enabled
↳ isCompliantbooleanWhether the device complies with MDM policies
↳ isManagedbooleanWhether the device is managed by an MDM app
↳ trustTypestringDevice registration type: Workplace, AzureAd, or ServerAd
↳ profileTypestringDevice profile type: RegisteredDevice, SecureVM, Printer, Shared, or IoT
↳ manufacturerstringManufacturer of the device
↳ modelstringModel of the device
↳ approximateLastSignInDateTimestringApproximate time the device last signed in
↳ registrationDateTimestringWhen the device was registered

List Microsoft Entra ID User Devices

List the devices a user has registered or owns. Devices the caller cannot read are returned with only their ID and the remaining fields null.

Input

ParameterTypeRequiredDescription
userIdstringNoUser ID or user principal name. Not needed when Next Page is provided to fetch a later page.
deviceRelationshipstringNoWhich devices to list: "registered" for devices the user registered, or "owned" for devices the user owns. Defaults to "registered".
topnumberNoMaximum number of devices to return
nextLinkstringNoContinuation URL from a previous response's 'nextLink' output, used to fetch the next page of results

Output

ParameterTypeDescription
devicesarrayDevices linked to the user
↳ idstringDevice object ID, used to get, update, or delete the device
↳ deviceIdstringUnique device identifier set during registration
↳ displayNamestringDisplay name of the device
↳ operatingSystemstringOperating system of the device
↳ operatingSystemVersionstringOperating system version of the device
↳ accountEnabledbooleanWhether the device is enabled
↳ isCompliantbooleanWhether the device complies with MDM policies
↳ isManagedbooleanWhether the device is managed by an MDM app
↳ trustTypestringDevice registration type: Workplace, AzureAd, or ServerAd
↳ profileTypestringDevice profile type: RegisteredDevice, SecureVM, Printer, Shared, or IoT
↳ manufacturerstringManufacturer of the device
↳ modelstringModel of the device
↳ approximateLastSignInDateTimestringApproximate time the device last signed in
↳ registrationDateTimestringWhen the device was registered
deviceCountnumberNumber of devices returned
nextLinkstringContinuation URL for the next page of results, or null if there are no more

List Microsoft Entra ID Conditional Access Policies

List the conditional access policies configured in the tenant, including their state and the conditions and controls they enforce. Read-only.

Input

ParameterTypeRequiredDescription
topnumberNoMaximum number of policies to return
filterstringNoOData filter expression. Example: "state eq 'enabled'".
nextLinkstringNoContinuation URL from a previous response's 'nextLink' output, used to fetch the next page of results

Output

ParameterTypeDescription
policiesarrayConditional access policies
↳ idstringConditional access policy ID
↳ displayNamestringDisplay name of the policy
↳ statestringPolicy state: enabled, disabled, or enabledForReportingButNotEnforced
↳ templateIdstringID of the template the policy was created from
↳ createdDateTimestringWhen the policy was created
↳ modifiedDateTimestringWhen the policy was last modified
↳ conditionsjsonConditions that trigger the policy (users, applications, platforms, locations, risk levels)
↳ grantControlsjsonControls enforced when the policy applies, or null when none are configured
↳ sessionControlsjsonSession controls enforced when the policy applies, or null when none are set
policyCountnumberNumber of policies returned
nextLinkstringContinuation URL for the next page of results, or null if there are no more

Get Microsoft Entra ID Conditional Access Policy

Get a single conditional access policy by ID, including the conditions it matches and the controls it enforces. Read-only.

Input

ParameterTypeRequiredDescription
policyIdstringYesConditional access policy ID

Output

ParameterTypeDescription
policyobjectConditional access policy details
↳ idstringConditional access policy ID
↳ displayNamestringDisplay name of the policy
↳ statestringPolicy state: enabled, disabled, or enabledForReportingButNotEnforced
↳ templateIdstringID of the template the policy was created from
↳ createdDateTimestringWhen the policy was created
↳ modifiedDateTimestringWhen the policy was last modified
↳ conditionsjsonConditions that trigger the policy (users, applications, platforms, locations, risk levels)
↳ grantControlsjsonControls enforced when the policy applies, or null when none are configured
↳ sessionControlsjsonSession controls enforced when the policy applies, or null when none are set