Update User with OneLogin API on New Scheduled Tasks from Pipedream API

Pipedream makes it easy to connect APIs for OneLogin, Pipedream and 2,700+ other apps remarkably fast.

Trigger workflow on

New Scheduled Tasks from the Pipedream API

Next, do this

Update User with the OneLogin API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Pipedream trigger and OneLogin action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Scheduled Tasks trigger
1. Connect your Pipedream account
2. Optional- Configure Secret
Configure the Update User action
1. Connect your OneLogin account
2. Select a User ID
3. Optional- Configure Username
4. Optional- Configure Email
5. Optional- Configure First Name
6. Optional- Configure Last Name
7. Optional- Configure Password
8. Optional- Configure Password Confirmation
9. Optional- Select a Password Algorithm
10. Optional- Configure Salt
11. Optional- Configure Title
12. Optional- Configure Department
13. Optional- Configure Company
14. Optional- Configure Comment
15. Optional- Select a Group ID
16. Optional- Select one or more Role IDs
17. Optional- Configure Phone
18. Optional- Select a State
19. Optional- Select a Status
20. Optional- Configure Directory ID
21. Optional- Configure Trusted IDP ID
22. Optional- Select a Manager User ID
23. Optional- Configure SAM Account Name
24. Optional- Configure Member Of
25. Optional- Configure User Principal Name
26. Optional- Configure Distinguished Name
27. Optional- Configure External ID
28. Optional- Configure OpenID Name
29. Optional- Configure Invalid Login Attempts
30. Optional- Configure Preferred Locale Code
31. Optional- Configure Custom Attributes
32. Optional- Select a Mappings
33. Optional- Configure Validate Policy
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are 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.

Trigger#

New Scheduled Tasks on Pipedream

Description:Exposes an HTTP API for scheduling messages to be emitted at a future time

Version:0.3.1

Key:pipedream-new-scheduled-tasks

View on GitHub

Pipedream Overview#

Pipedream is an API that allows you to build applications that can connect to
various data sources and processes them in real-time. You can use Pipedream to
create applications that can perform ETL (Extract, Transform, and Load) tasks,
as well as to create data-driven workflows.

Some examples of applications you can build using the Pipedream API include:

An application that can extract data from a database, transform it, and then
load it into another database.
An application that can monitor a data source for changes, and then trigger a
workflow in response to those changes.
An application that can poll an API for new data, and then process that data
in real-time.

Trigger Code#

import pipedream from "../../pipedream.app.mjs";
import sampleEmit from "./test-event.mjs";
import { uuid } from "uuidv4";

export default {
  key: "pipedream-new-scheduled-tasks",
  name: "New Scheduled Tasks",
  type: "source",
  description:
    "Exposes an HTTP API for scheduling messages to be emitted at a future time",
  version: "0.3.1",
  dedupe: "unique", // Dedupe on a UUID generated for every scheduled task
  props: {
    pipedream,
    secret: {
      type: "string",
      secret: true,
      label: "Secret",
      optional: true,
      description:
        "**Optional but recommended**: if you enter a secret here, you must pass this value in the `x-pd-secret` HTTP header when making requests",
    },
    http: {
      label: "Endpoint",
      description: "The endpoint where you'll send task scheduler requests",
      type: "$.interface.http",
      customResponse: true,
    },
    db: "$.service.db",
  },
  methods: {
    // To schedule future emits, we emit to the selfChannel of the component
    selfChannel() {
      return "self";
    },
    // Queue for future emits that haven't yet been delivered
    queuedEventsChannel() {
      return "$in";
    },
    httpRespond({
      status, body,
    }) {
      this.http.respond({
        headers: {
          "content-type": "application/json",
        },
        status,
        body,
      });
    },
    async selfSubscribe() {
      // Subscribe the component to itself. We do this here because even in
      // the activate hook, the component isn't available to take subscriptions.
      // Scheduled tasks are sent to the self channel, which emits the message at
      // the specified delivery_ts to this component.
      const isSubscribedToSelf = this.db.get("isSubscribedToSelf");
      if (!isSubscribedToSelf) {
        const componentId = process.env.PD_COMPONENT;
        const selfChannel = this.selfChannel();
        console.log(`Subscribing to ${selfChannel} channel for event source`);
        console.log(
          await this.pipedream.subscribe(componentId, componentId, selfChannel),
        );
        this.db.set("isSubscribedToSelf", true);
      }
    },
    validateEventBody(event, operation) {
      const errors = [];

      // Secrets are optional, so we first check if the user configured
      // a secret, then check its value against the prop (validation below)
      if (this.secret && event.headers["x-pd-secret"] !== this.secret) {
        errors.push(
          "Secret on incoming request doesn't match the configured secret",
        );
      }

      if (operation === "schedule") {
        const {
          timestamp,
          message,
        } = event.body;
        // timestamp should be an ISO 8601 string. Parse and check for validity below.
        const epoch = Date.parse(timestamp);

        if (!timestamp) {
          errors.push(
            "No timestamp included in payload. Please provide an ISO8601 timestamp in the 'timestamp' field",
          );
        }
        if (timestamp && !epoch) {
          errors.push("Timestamp isn't a valid ISO 8601 string");
        }
        if (!message) {
          errors.push("No message passed in payload");
        }
      }

      return errors;
    },
    scheduleTask(event) {
      const errors = this.validateEventBody(event, "schedule");
      let status, body;

      if (errors.length) {
        console.log(errors);
        status = 400;
        body = {
          errors,
        };
      } else {
        const id = this.emitScheduleEvent(event.body, event.body.timestamp);
        status = 200;
        body = {
          msg: "Successfully scheduled task",
          id,
        };
      }

      this.httpRespond({
        status,
        body,
      });
    },
    emitScheduleEvent(event, timestamp) {
      const selfChannel = this.selfChannel();
      const epoch = Date.parse(timestamp);
      const $id = uuid();

      console.log(`Scheduled event to emit on: ${new Date(epoch)}`);

      this.$emit(
        {
          ...event,
          $channel: selfChannel,
          $id,
        },
        {
          name: selfChannel,
          id: $id,
          delivery_ts: epoch,
        },
      );

      return $id;
    },
    async cancelTask(event) {
      const errors = this.validateEventBody(event, "cancel");
      let status, msg;

      if (errors.length) {
        console.log(errors);
        status = 400;
        msg = "Secret on incoming request doesn't match the configured secret";
      } else {
        try {
          const id = event.body.id;
          const isCanceled = await this.deleteEvent(event);
          if (isCanceled) {
            status = 200;
            msg = `Cancelled scheduled task for event ${id}`;
          } else {
            status = 404;
            msg = `No event with ${id} found`;
          }
        } catch (error) {
          console.log(error);
          status = 500;
          msg = "Failed to schedule task. Please see the logs";
        }
      }

      this.httpRespond({
        status,
        body: {
          msg,
        },
      });
    },
    async deleteEvent(event) {
      const componentId = process.env.PD_COMPONENT;
      const inChannel = this.queuedEventsChannel();

      // The user must pass a scheduled event UUID they'd like to cancel
      // We lookup the event by ID and delete it
      const { id } = event.body;

      // List events in the $in channel - the queue of scheduled events, to be emitted in the future
      const events = await this.pipedream.listEvents(
        componentId,
        inChannel,
      );
      console.log("Events: ", events);

      // Find the event in the list by id
      const eventToCancel = events.data.find((e) => {
        const { metadata } = e;
        return metadata.id === id;
      });

      console.log("Event to cancel: ", eventToCancel);

      if (!eventToCancel) {
        console.log(`No event with ${id} found`);
        return false;
      }

      // Delete the event
      await this.pipedream.deleteEvent(
        componentId,
        eventToCancel.id,
        inChannel,
      );
      return true;
    },
    emitEvent(event, summary) {
      // Delete the channel name and id from the incoming event, which were used only as metadata
      const id = event.$id;
      delete event.$channel;
      delete event.$id;

      this.$emit(event, {
        summary: summary ?? JSON.stringify(event),
        id,
        ts: +new Date(),
      });
    },
  },
  async run(event) {
    await this.selfSubscribe();

    const { path } = event;
    if (path === "/schedule") {
      this.scheduleTask(event);
    } else if (path === "/cancel") {
      await this.cancelTask(event);
    } else if (event.$channel === this.selfChannel()) {
      this.emitEvent(event);
    }
  },
  sampleEmit,
};

Trigger 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
Pipedream	`pipedream`	`app`	This component uses the Pipedream app.
Secret	`secret`	`string`	Optional but recommended: if you enter a secret here, you must pass this value in the `x-pd-secret` HTTP header when making requests
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.

Trigger Authentication#

Pipedream uses API keys for authentication. When you connect your Pipedream account, Pipedream securely stores the keys so you can easily authenticate to Pipedream APIs in both code and no-code steps.

About Pipedream#

Integration platform for developers

Action#

Update User on OneLogin

Description:Update an existing user's details in OneLogin. [See the documentation](https://developers.onelogin.com/api-docs/2/users/update-user)

Version:0.0.1

Key:onelogin-update-user

View on GitHub

Action Code#

import { parseObject } from "../../common/utils.mjs";
import onelogin from "../../onelogin.app.mjs";

export default {
  key: "onelogin-update-user",
  name: "Update User",
  description: "Update an existing user's details in OneLogin. [See the documentation](https://developers.onelogin.com/api-docs/2/users/update-user)",
  version: "0.0.1",
  type: "action",
  props: {
    onelogin,
    userId: {
      propDefinition: [
        onelogin,
        "userId",
      ],
    },
    username: {
      propDefinition: [
        onelogin,
        "username",
      ],
      description: "The user's username",
      optional: true,
    },
    email: {
      propDefinition: [
        onelogin,
        "email",
      ],
      description: "The user's email address",
      optional: true,
    },
    firstname: {
      propDefinition: [
        onelogin,
        "firstname",
      ],
      optional: true,
    },
    lastname: {
      propDefinition: [
        onelogin,
        "lastname",
      ],
      optional: true,
    },
    password: {
      propDefinition: [
        onelogin,
        "password",
      ],
      optional: true,
    },
    passwordConfirmation: {
      propDefinition: [
        onelogin,
        "passwordConfirmation",
      ],
      optional: true,
    },
    passwordAlgorithm: {
      propDefinition: [
        onelogin,
        "passwordAlgorithm",
      ],
      optional: true,
    },
    salt: {
      propDefinition: [
        onelogin,
        "salt",
      ],
      optional: true,
    },
    title: {
      propDefinition: [
        onelogin,
        "title",
      ],
      optional: true,
    },
    department: {
      propDefinition: [
        onelogin,
        "department",
      ],
      optional: true,
    },
    company: {
      propDefinition: [
        onelogin,
        "company",
      ],
      optional: true,
    },
    comment: {
      propDefinition: [
        onelogin,
        "comment",
      ],
      optional: true,
    },
    groupId: {
      propDefinition: [
        onelogin,
        "groupId",
      ],
      optional: true,
    },
    roleIds: {
      propDefinition: [
        onelogin,
        "roleIds",
      ],
      optional: true,
    },
    phone: {
      propDefinition: [
        onelogin,
        "phone",
      ],
      optional: true,
    },
    state: {
      propDefinition: [
        onelogin,
        "state",
      ],
      optional: true,
    },
    status: {
      propDefinition: [
        onelogin,
        "status",
      ],
      optional: true,
    },
    directoryId: {
      propDefinition: [
        onelogin,
        "directoryId",
      ],
      optional: true,
    },
    trustedIdpId: {
      propDefinition: [
        onelogin,
        "trustedIdpId",
      ],
      optional: true,
    },
    managerUserId: {
      propDefinition: [
        onelogin,
        "userId",
      ],
      label: "Manager User ID",
      description: "The OneLogin User ID for the user's manager",
      optional: true,
    },
    samaccountname: {
      propDefinition: [
        onelogin,
        "samaccountname",
      ],
      optional: true,
    },
    memberOf: {
      propDefinition: [
        onelogin,
        "memberOf",
      ],
      optional: true,
    },
    userPrincipalName: {
      propDefinition: [
        onelogin,
        "userPrincipalName",
      ],
      optional: true,
    },
    distinguishedName: {
      propDefinition: [
        onelogin,
        "distinguishedName",
      ],
      optional: true,
    },
    externalId: {
      propDefinition: [
        onelogin,
        "externalId",
      ],
      optional: true,
    },
    openidName: {
      propDefinition: [
        onelogin,
        "openidName",
      ],
      optional: true,
    },
    invalidLoginAttempts: {
      propDefinition: [
        onelogin,
        "invalidLoginAttempts",
      ],
      optional: true,
    },
    preferredLocaleCode: {
      propDefinition: [
        onelogin,
        "preferredLocaleCode",
      ],
      optional: true,
    },
    customAttributes: {
      propDefinition: [
        onelogin,
        "customAttributes",
      ],
      optional: true,
    },
    mappings: {
      propDefinition: [
        onelogin,
        "mappings",
      ],
      optional: true,
    },
    validatePolicy: {
      propDefinition: [
        onelogin,
        "validatePolicy",
      ],
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.onelogin.updateUser({
      $,
      userId: this.userId,
      data: {
        email: this.email,
        username: this.username,
        firstname: this.firstname,
        lastname: this.lastname,
        password: this.password,
        password_confirmation: this.passwordConfirmation,
        password_algorithm: this.passwordAlgorithm,
        salt: this.salt,
        title: this.title,
        department: this.department,
        company: this.company,
        comment: this.comment,
        group_id: this.groupId,
        role_ids: parseObject(this.roleIds),
        phone: this.phone,
        state: this.state && parseInt(this.state),
        status: this.status && parseInt(this.status),
        directory_id: this.directoryId,
        trusted_idp_id: this.trustedIdpId,
        manager_user_id: this.managerUserId,
        samaccountname: this.samaccountname,
        member_of: this.memberOf,
        userprincipalname: this.userPrincipalName,
        distinguished_name: this.distinguishedName,
        external_id: this.externalId,
        openid_name: this.openidName,
        invalid_login_attempts: this.invalidLoginAttempts,
        preferred_locale_code: this.preferredLocaleCode,
        custom_attributes: this.customAttributes,
      },
      params: {
        mappings: this.mappings,
        validate_policy: this.validatePolicy,
      },
    });

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

Action Configuration#

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

Label	Prop	Type	Description
OneLogin	`onelogin`	`app`	This component uses the OneLogin app.
User ID	`userId`	`string`	Select a value from the drop down menu.
Username	`username`	`string`	The user's username
Email	`email`	`string`	The user's email address
First Name	`firstname`	`string`	The user's first name
Last Name	`lastname`	`string`	The user's last name
Password	`password`	`string`	The password to set for the user
Password Confirmation	`passwordConfirmation`	`string`	Required if the password is being set
Password Algorithm	`passwordAlgorithm`	`string`	Select a value from the drop down menu:`salt+sha256sha256+saltbcrypt`
Salt	`salt`	`string`	The salt value used with the `Password Algorithm`
Title	`title`	`string`	The user's job title
Department	`department`	`string`	The user's department
Company	`company`	`string`	The user's company
Comment	`comment`	`string`	Free text related to the user
Group ID	`groupId`	`integer`	Select a value from the drop down menu.
Role IDs	`roleIds`	`integer[]`	Select a value from the drop down menu.
Phone	`phone`	`string`	The E.164 format phone number for a user
State	`state`	`string`	Select a value from the drop down menu:`{ "label": "Unapproved", "value": "0" }{ "label": "Approved", "value": "1" }{ "label": "Rejected", "value": "2" }{ "label": "Unlicensed", "value": "3" }`
Status	`status`	`string`	Select a value from the drop down menu:`{ "label": "Unactivated", "value": "0" }{ "label": "Active", "value": "1" }{ "label": "Suspended", "value": "2" }{ "label": "Locked", "value": "3" }{ "label": "Password Expired", "value": "4" }{ "label": "Awaiting Password Reset", "value": "5" }{ "label": "Password Pending", "value": "7" }{ "label": "Security Questions Required", "value": "8" }`
Directory ID	`directoryId`	`integer`	The ID of the OneLogin Directory the user will be assigned to
Trusted IDP ID	`trustedIdpId`	`integer`	The ID of the OneLogin Trusted IDP the user will be assigned to
Manager User ID	`managerUserId`	`string`	Select a value from the drop down menu.
SAM Account Name	`samaccountname`	`string`	The user's Active Directory username
Member Of	`memberOf`	`string`	The user's directory membership
User Principal Name	`userPrincipalName`	`string`	The principle name of the user
Distinguished Name	`distinguishedName`	`string`	The distinguished name of the user
External ID	`externalId`	`string`	The ID of the user in an external directory
OpenID Name	`openidName`	`string`	The name configured for use in other applications that accept OpenID for sign-in
Invalid Login Attempts	`invalidLoginAttempts`	`integer`	The number of sequential invalid login attempts the user has made
Preferred Locale Code	`preferredLocaleCode`	`string`	The 2-character language locale for the user, such as `en` for English or `es` for Spanish.
Custom Attributes	`customAttributes`	`object`	An object to contain any other custom attributes you have configured
Mappings	`mappings`	`string`	Select a value from the drop down menu:`{ "label": "Async - Mappings run after the API returns a response", "value": "async" }{ "label": "Sync - Mappings run before the API returns a response", "value": "sync" }{ "label": "Disabled - Mappings don't run for this user", "value": "disabled" }`
Validate Policy	`validatePolicy`	`boolean`	Will passwords validate against the User Policy?

Action Authentication#

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

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

About OneLogin#

Market-Leading Identity and Access Management Solutions

More Ways to Connect OneLogin + Pipedream#

Other Popular Integrations#

Create User with OneLogin API on New Scheduled Tasks from Pipedream API

Pipedream + OneLogin

Update User with OneLogin API on New Scheduled Tasks from Pipedream API

Pipedream makes it easy to connect APIs for OneLogin, Pipedream and 2,700+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,700+apps by most popular

1
-
24
of
2,700+
apps by most popular