OpenFn / OpenFn/adaptors

oauth and configuration schemas

Open
#606 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
24
Forks
41
Avg merge
3d 13h
Merged PRs (30d)
12

Description

I am not sure what to do in configuration schema for new adaptors which support oauth.

These new adaptors accept a user name and password, with which they'll login internally and generate an oauth token.

Or, if you get an oauth token from lightning, they should also be able to work with oauth_token on the config object.

I am not sure what the best practice is for Lightning.

  • If using oauth, user name and password are not required
  • if using a username and password, oauth is not required
  • Indeed, the oauth access token should probably not be exposed to the lightning UI at all?

Salesforce has two config schemas, a normal one and oauth-configuration-schema. Does lightning use the oauth one? I can't see any reference to it in the source

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing the Salesforce oauth-configuration-schema and normal configuration schema through the source, then identify how Lightning consumes adaptor configuration schemas. Review the username/password and oauth_token cases, including UI exposure, and document or implement an agreed schema behavior with maintainer confirmation.

Written by the indexing model from the issue text.

Assessment

Domain
authentication
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.