Update User with Microsoft Entra ID API

Pipedream makes it easy to connect APIs for Microsoft Entra ID and 2,000+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Update User with the Microsoft Entra ID API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 800,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

Create a workflow to Update User with the Microsoft Entra ID API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Update User action
1. Connect your Microsoft Entra ID account
2. Select a User
3. Optional- Configure Display Name
4. Optional- Configure Email
5. Optional- Configure Mail Nickname
6. Optional- Configure Account Enabled
7. Optional- Configure Street Address
8. Optional- Configure City
9. Optional- Configure State
10. Optional- Configure Postal Code
11. Optional- Configure Country
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Update User with Microsoft Entra ID API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Microsoft Entra ID

Try it

Update User with Microsoft Entra ID API on New Submission from Typeform API

Typeform + Microsoft Entra ID

Try it

Update User with Microsoft Entra ID API on Custom Events from Zoom API

Zoom + Microsoft Entra ID

Try it

Update User with Microsoft Entra ID API on New Submission (Instant) from Jotform API

Jotform + Microsoft Entra ID

Try it

Update User with Microsoft Entra ID API on New Scheduled Tasks from Pipedream API

Pipedream + Microsoft Entra ID

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Update User on Microsoft Entra ID

Description:Updates an existing user in Microsoft Entra ID. [See the documentation](https://learn.microsoft.com/en-us/graph/api/user-update?view=graph-rest-1.0&tabs=http)

Version:0.0.2

Key:microsoft_entra_id-update-user

View on GitHub

Code#

import microsoftEntraId from "../../microsoft_entra_id.app.mjs";
import pickBy from "lodash.pickby";

export default {
  key: "microsoft_entra_id-update-user",
  name: "Update User",
  description: "Updates an existing user in Microsoft Entra ID. [See the documentation](https://learn.microsoft.com/en-us/graph/api/user-update?view=graph-rest-1.0&tabs=http)",
  version: "0.0.2",
  type: "action",
  props: {
    microsoftEntraId,
    userId: {
      propDefinition: [
        microsoftEntraId,
        "userId",
        (c) => ({
          groupId: c.groupId,
        }),
      ],
    },
    displayName: {
      type: "string",
      label: "Display Name",
      description: "The name to display in the address book for the user.",
      optional: true,
    },
    mail: {
      type: "string",
      label: "Email",
      description: "The SMTP address for the user, for example, `jeff@contoso.onmicrosoft.com`.",
      optional: true,
    },
    mailNickname: {
      type: "string",
      label: "Mail Nickname",
      description: "The mail alias for the user.",
      optional: true,
    },
    accountEnabled: {
      type: "boolean",
      label: "Account Enabled",
      description: "`true` if the account is enabled; otherwise, `false`.",
      optional: true,
      default: true,
    },
    streetAddress: {
      type: "string",
      label: "Street Address",
      description: "The street address of the user's place of business.",
      optional: true,
    },
    city: {
      type: "string",
      label: "City",
      description: "The city in which the user is located.",
      optional: true,
    },
    state: {
      type: "string",
      label: "State",
      description: "The state or province in the user's address.",
      optional: true,
    },
    postalCode: {
      type: "string",
      label: "Postal Code",
      description: "The postal code for the user's postal address. The postal code is specific to the user's country/region. In the United States of America, this attribute contains the ZIP code.",
      optional: true,
    },
    country: {
      type: "string",
      label: "Country",
      description: "The country/region in which the user is located; for example, `US` or `UK`.",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.microsoftEntraId.updateUser({
      userId: this.userId,
      data: pickBy({
        displayName: this.displayName,
        mail: this.mail,
        mailNickname: this.mailNickname,
        accountEnabled: this.accountEnabled,
        streetAddress: this.streetAddress,
        city: this.city,
        state: this.state,
        postalCode: this.postalCode,
        country: this.country,
      }),
      $,
    });

    $.export("$summary", `Successfully updated user with ID ${this.userId}.`);

    return response;
  },
};

Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Microsoft Entra ID	`microsoftEntraId`	`app`	This component uses the Microsoft Entra ID app.
User	`userId`	`string`	Select a value from the drop down menu.
Display Name	`displayName`	`string`	The name to display in the address book for the user.
Email	`mail`	`string`	The SMTP address for the user, for example, `jeff@contoso.onmicrosoft.com`.
Mail Nickname	`mailNickname`	`string`	The mail alias for the user.
Account Enabled	`accountEnabled`	`boolean`	`true` if the account is enabled; otherwise, `false`.
Street Address	`streetAddress`	`string`	The street address of the user's place of business.
City	`city`	`string`	The city in which the user is located.
State	`state`	`string`	The state or province in the user's address.
Postal Code	`postalCode`	`string`	The postal code for the user's postal address. The postal code is specific to the user's country/region. In the United States of America, this attribute contains the ZIP code.
Country	`country`	`string`	The country/region in which the user is located; for example, `US` or `UK`.

Authentication#

Microsoft Entra ID uses OAuth authentication. When you connect your Microsoft Entra ID account, Pipedream will open a popup window where you can sign into Microsoft Entra ID and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Microsoft Entra ID API.

Pipedream requests the following authorization scopes when you connect your account:

User.Reademailoffline_accessopenidprofileDirectory.ReadWrite.AllGroup.ReadWrite.AllUser.ReadWrite