IT and Development
Microsoft Entra ID

Microsoft Enta modules

8min
after connecting to the microsoft enta app, you can use the following modules to build your {{scenario plural lowercase}} users search users retrieves a list of users field connection connection microsoft entra id docid\ hahudflvtzl5wqng1sgwy expand used to include the expanded resource or collection referenced by a single relationship (navigation property) in your results only one relationship can be expanded in a single request for example memberof or transitivememberof filter used to retrieve just a subset of a collection can also be used to retrieve relationships like memberof and transitivememberof for example, find all users whose display name starts with the letter 'j' startswith(displayname,'j') supports the odata system query language order by specifies the sort order of the items returned the default order is ascending order for example displayname desc search restricts the results of a request to match a search criterion for example "description\ one" and ("displayname\ video" or "displayname\ drive") supports odata system query language and $search query parameters select returns a set of properties that are different than the default set with select , you can specify a subset or a superset of the default properties for example id,displayname limit enter the maximum number of users make returns during one make execution cycle create a user creates a new user field connection connection microsoft entra id docid\ hahudflvtzl5wqng1sgwy account enabled select whether or not the account is enabled display name enter the name to display in the address book for the user on premises immutable id only needs to be specified when creating a new user account if you are using a federated domain for the user principal name mail nickname enter the mail alias for the user user principal name it's an internet style login name for the user based on the internet standard rfc 822 by convention, this should map to the user's email name the general format is alias\@domain , where domain must be present in the tenant's collection of verified domains password profile password the password must satisfy minimum requirements as specified by the user’s password policies property by default, a strong password is required force change password select whether to force change the password force change password with mfa select whether to force change the password with multifactor authentication get a user retrieves a specific user field connection connection microsoft entra id docid\ hahudflvtzl5wqng1sgwy user id or principal name enter the id or name of the user you want to retrieve get a user's membership retrieves the list of groups memberships for a specific user field connection connection microsoft entra id docid\ hahudflvtzl5wqng1sgwy user id or principal name enter the id or name of the user you want to retrieve membership information for security enabled only yes to specify that only security groups that the entity is a member of should be returned; no to specify that all groups and directory roles that the entity is a member of should be returned update a user updates a user's information field connection connection microsoft entra id docid\ hahudflvtzl5wqng1sgwy user id or principal name enter the id or name of the user you want to update account enabled select whether or not the account is enabled given name enter the given name (first name) of the user surname enter the user's surname (family name or last name) display name enter the name to display in the address book for the user mobile phone enter the primary cellular telephone number for the user business phones enter the telephone numbers for the user mail enter the smtp address for the user, for example, jeff\@contoso onmicrosoft com mail nickname enter the mail alias for the user this property must be specified when a user is created other mails enter any additional email addresses for the user; for example \["bob\@contoso com", "robert\@fabrikam com"] company name enter the company name which the user is associated street address enter the street address of the user's place of business city enter the city in which the user is located postal code enter the postal code for the user's postal address state enter the state or province in the user's address country enter the country/region in which the user is located about me enter any text for the user to describe themselves birthday enter the birthday of the user my site enter the url for the user's personal site past projects a list for the user to enumerate their past projects interests a list for the user to describe their interests schools a list for the user to enumerate the schools they have attended skills a list for the user to enumerate their skills preferred language enter the preferred language for the user should follow iso 639 1 code; for example en us age group select the age group of the user consent provided for minor select whether consent has been obtained for minors job title enter the user’s job title employee type enter the employee type employee id enter the employee identifier assigned to the user by the organization employee hire date enter the hire date of the user department enter the name for the department in which the user works office location enter the office location in the user's place of business responsibilities a list for the user to enumerate their responsibilities on premises immutable id only needs to be specified when creating a new user account if you are using a federated domain for the user principal name password policies this value is an enumeration with one possible value being disablestrongpassword , which allows weaker passwords than the default policy to be specified disablepasswordexpiration can also be specified the two may be specified together; for example disablepasswordexpiration , disablestrongpassword password profile password the password must satisfy minimum requirements as specified by the user’s password policies property by default, a strong password is required force change password select whether to force change the password force change password with mfa select whether to force change the password with multifactor authentication usage location a two letter country code (iso standard 3166) required for users that will be assigned licenses due to legal requirement to check for availability of services in countries examples include us , jp , and gb user principal name it's an internet style login name for the user based on the internet standard rfc 822 by convention, this should map to the user's email name the general format is alias\@domain , where domain must be present in the tenant's collection of verified domains user type enter the user type delete a user deletes a specific user field connection connection microsoft entra id docid\ hahudflvtzl5wqng1sgwy user id or principal name enter the id or name of the user you want to delete groups search groups retrieves a list of groups field connection connection microsoft entra id docid\ hahudflvtzl5wqng1sgwy expand used to include the expanded resource or collection referenced by a single relationship (navigation property) in your results only one relationship can be expanded in a single request for example members expand is not currently supported with advanced queries filter used to retrieve just a subset of a collection can also be used to retrieve relationships like members and transitivemembers for example, find all groups whose display name starts with the letter 'j' startswith(displayname,'j') supports the odata system query language order by specifies the sort order of the items returned the default order is ascending order for example displayname desc search restricts the results of a request to match a search criterion for example "description\ one" and ("displayname\ video" or "displayname\ drive") supports odata system query language and $search query parameters select returns a set of properties that are different than the default set with select , you can specify a subset or a superset of the default properties for example id,displayname limit enter the maximum number of groups make returns during one make execution cycle get a group retrieves information about a specific group field connection connection microsoft entra id docid\ hahudflvtzl5wqng1sgwy group id enter the id of the group you want to retrieve add members to a group allows you to add multiple members to a group field connection connection microsoft entra id docid\ hahudflvtzl5wqng1sgwy group id enter the id of the group you want to add members to members ids add the ids or names of users you want to add to the group remove member from group removes a single member from a specific group field connection connection microsoft entra id docid\ hahudflvtzl5wqng1sgwy group id enter the id of the group you want to remove a member from members id select the id of the member you want to remove from the group other make an api call performs an arbitrary authorized api call field connection connection microsoft entra id docid\ hahudflvtzl5wqng1sgwy url enter a path relative to https //graph microsoft com for example /v1 0/users method select the http method you want to use delete to delete an entry patch to make a partial entry update put to update/replace an existing entry post to create a new entry get to retrieve information for an entry headers enter the desired request headers you don't have to add authorization headers; we already did that for you query string enter the request query string body enter the body content for your api call get current user retrieves user information for the signed in user field connection connection microsoft entra id docid\ hahudflvtzl5wqng1sgwy