Skip to content

Latest commit

 

History

History
69 lines (53 loc) · 3.02 KB

README.md

File metadata and controls

69 lines (53 loc) · 3.02 KB
Raw

Budibase - OneLogin User Datasource Plugin

A Budibase plugin to interface with the OneLogin User API

Reference

Find out more about Budibase.
OneLogin User API docs: OneLogin.

Quick Start

  1. Import the plugin into your budibase instance (see Budibase documentation for more info)
  2. Generate an API key from your OneLogin Administration Dashboard: API Credentials.

Notes

  • The API key must have Manage Users permissions to operate correctly
  • If you only want the plugin to read user data, set your API key for Read Users

    API Key Setup
  1. Add the plugin as a datasource to your application
  2. When prompted to configure the plug, supply your OneLogin subdomain, and your API client ID and secret generated above.
    API Key Setup

Query: Read

All users, all data

To retrieve all users from your OneLogin directory, create a READ query, leaving all fields blank

Specific User

To retrieve a specific user, specify the OneLogin directory ID Specific Fields

Search for User

Specify the parameters and value to search in the Scope field.
You can use wildcards to search for user(s) that match conditions; eg: *@mydomain.com Specific Fields

  • This will cause any value in the User ID field to be ignored.

Specific Fields

You can specify which fields you want returned into your schema by specifying them in the Fields field, using CSV Specific Fields

  • Fields must be comma separated
  • Do not include a space between fields/attributes

Query: Create a user

You must specify a username and email as minimum attributes.
Additional attributes can be populated at creation time by specifying them in the payload field. Specific Fields

Note: a user is created as a deactivated account by default.
To make the account active at creation, specify "status": 1 in the payload.

Query: Update a User

You must specify the OneLogin Directory ID of the user you want to update.
This can be obtained using the READ query, scoped to the users email address or other identifying attribute.

The fields to be updated for the user are specified as key value pairs in the payload.
Fields not specified will not be updated or changed. Specific Fields

Query: Delete a User

You must specify the OneLogin Directory ID of the user you want to delete.

NOTE: THIS CANNOT BE UNDONE. Please validate the User before executing the query.
 It is HIGHLY recommended you show your end user a confirmation as part of your UI design when using this query.

Specific Fields

Local build instructions

To build your new plugin run the following in your Budibase CLI:

budi plugins --build