🌱 Adds support for Webfinger API calls #70

gowthamidommety-okta · 2017-10-23T20:41:27Z

rajaguruduraisamy-okta

lgtm. Do we need to add docs for the same ?

gowthamidommety-okta · 2017-10-24T16:02:01Z

@rajaguruduraisamy-okta Yea, i started making changes to the docs, but have some questions. Will speak to Len when he's back.

mauriciocastillosilva-okta

looks good to me.
Do we need to add info about the new webfinger function in the README.md file? There is doc about signIn there, so might be a good idea to let people know about webfinger... unless it is in beta, but in any case, it will be in the repo, so might as well doc it.

gowthamidommety-okta · 2017-10-24T23:00:05Z

@mauriciocastillosilva-okta It is in beta, so i was wondering about the process for updating docs and README.md.. I'm almost done updating readme. I'll go ahead and add it to this PR

rajaguruduraisamy-okta

lgtm

yuliu-okta · 2017-10-25T18:57:02Z

README.md

+
+- `resource` - URI that identifies the entity whose information is sought, currently only acct scheme is supported (e.g acct:dade.murphy@example.com)
+- `rel` - Optional parameter to request only a subset of the information that would otherwise be returned without the "rel" parameter
+- `requestContext` - A parameter that provides Webfinger the context of that which the user is trying to access, such as the path of an app


Optional parameter

I thought only rel was optional. requestContext is optional too?

yes, it is optional.

yuliu-okta · 2017-10-25T18:58:53Z

README.md

+authClient.webfinger({
+  resource: 'acct:john.joe@example.com',
+  rel: 'okta:idp',
+  requestContext: 'https://example.okta.com'


it does not need to pass the requestContext if user just tries to access the homepage, an example of requestContext will be "/home/dropbox/0oa16630PzpWKeWrH0g4/121"

👍 Will change

yuliu-okta · 2017-10-25T19:01:23Z

test/xhr/webfinger.js

+          "und" : "Acme Partner IdP"
+        },
+        "properties": {
+          "okta:logo" : "https://ok3static.oktacdn.com/bc/image/fileStoreRecord?id=fs0w8swww6KGUZZWGSHS",


okta:logo has not implemented yet, does UI need it?

no, not yet anyway. I took this example response from the Tech Design just to test

gowthamidommety-okta · 2017-10-31T15:51:30Z

lib/http.js

@@ -5,6 +5,7 @@ var storageUtil = require('./storageUtil');
 var Q = require('q');
 var AuthApiError = require('./errors/AuthApiError');
 var config = require('./config');
+var $ = require('jquery');


Not sure about this change. Only a few files have a dependency on jquery

We'd like to keep auth-js small and jQuery is a pretty big dependency, so if a dev wants to use jquery, they have to do it explicitly.

For example, normally, okta-auth-js is imported like this: var oktaAuth = require('@okta/okta-auth-js'). This uses a small library called reqwest to make http requests. If a dev wants to use jQuery to makes requests instead, they can import okta-auth-js like this: var oktaAuth = require('@okta/okta-auth-js/jquery').

So, yeah, it's a good idea to avoid it when possible

lboyette-okta

On the right track, only a few questions

lboyette-okta · 2017-10-31T21:00:42Z

README.md

@@ -24,6 +24,7 @@ Read our [contributing guidelines](./CONTRIBUTING.md) if you wish to contribute.
  * [forgotPassword](#forgotpasswordoptions)
  * [unlockAccount](#unlockaccountoptions)
  * [verifyRecoveryToken](#verifyrecoverytokenoptions)
+  * [webfinger](#webfinger)


this doesn't point to a heading (I think you want #webfingeroptions)

lboyette-okta · 2017-10-31T21:04:33Z

README.md

@@ -244,6 +245,28 @@ authClient.verifyRecoveryToken({
 });
 ```

+## [webfinger(options)]


I couldn't find any docs on developer.okta.com for this api yet, so we can just provide a link to the spec for now: [webfinger(options)](https://tools.ietf.org/html/rfc7033)

lboyette-okta · 2017-10-31T22:01:47Z

README.md

+
+```javascript
+authClient.webfinger({
+  resource: 'acct:john.joe@example.com',


do we want to allow a custom issuer or is webfinger only available on the root Okta url?

lboyette-okta · 2017-10-31T22:04:10Z

lib/clientBuilder.js

@@ -166,6 +166,17 @@ proto.verifyRecoveryToken = function (opts) {
  return tx.postToTransaction(this, '/api/v1/authn/recovery/token', opts);
 };

+// { resource, (rel), (requestContext)}
+proto.webfinger = function (opts) {
+  var url = '/.well-known/webfinger' + util.toQueryParams(opts);


We should figure out if a custom auth server issuer is allowed. If so, we can do something like this:

var issuer = opts.issuer || sdk.options.issuer || sdk.options.url; var params = util.omit(opts, 'issuer'); var url = issuer + '/.well-known/webfinger' + util.toQueryParams(params);

I'm not so sure. @yuliu-okta Can you please comment?

spoke to @yuliu-okta offline. He said we may support custom auth server issuer in the future, but not now

lboyette-okta · 2017-10-31T22:19:29Z

lib/clientBuilder.js

+      'Accept': 'application/jrd+json'
+    }
+  };
+  return tx.getFromTransaction(this, url, options);


This isn't a transaction (transactions are only created by the /authn api), so we should make the call directly:

var http = require('./http'); // ... return http.get(this, url);

👍 Got it!

lboyette-okta · 2017-10-31T22:29:16Z

lib/http.js

@@ -5,6 +5,7 @@ var storageUtil = require('./storageUtil');
 var Q = require('q');
 var AuthApiError = require('./errors/AuthApiError');
 var config = require('./config');
+var $ = require('jquery');


We'd like to keep auth-js small and jQuery is a pretty big dependency, so if a dev wants to use jquery, they have to do it explicitly.

For example, normally, okta-auth-js is imported like this: var oktaAuth = require('@okta/okta-auth-js'). This uses a small library called reqwest to make http requests. If a dev wants to use jQuery to makes requests instead, they can import okta-auth-js like this: var oktaAuth = require('@okta/okta-auth-js/jquery').

So, yeah, it's a good idea to avoid it when possible

lboyette-okta · 2017-10-31T22:32:20Z

lib/http.js

@@ -28,7 +29,7 @@ function httpRequest(sdk, options) {
    'Content-Type': 'application/json',
    'X-Okta-User-Agent-Extended': 'okta-auth-js-' + config.SDK_VERSION
  };
-  util.extend(headers, sdk.options.headers || {});
+  $.extend(headers, sdk.options.headers, options.headers);


Let's make util.extend behave more like jQuery instead of importing jQuery.

Alternatively, you could call util.extend twice, but it'd be much cleaner if it accepted an arbitrary number of arguments.

lboyette-okta · 2017-10-31T22:35:46Z

lib/tx.js

@@ -55,6 +55,10 @@ function postToTransaction(sdk, url, options) {
    });
 }

+function getFromTransaction(sdk, url, options) {


this can be removed

lboyette-okta · 2017-10-31T22:36:42Z

test/spec/webfinger.js

+define(function(require) {
+  var util = require('../util/util');
+
+  describe('WEBFINGER', function () {


lowercase is ok here. The others are capitalized because they're states in the /authn api

lboyette-okta

lgtm

Adds support for Webfinger API calls Resolves: OKTA-145614

gowthamidommety-okta requested review from lboyette-okta, mauriciocastillosilva-okta and rajaguruduraisamy-okta October 23, 2017 20:41

rajaguruduraisamy-okta reviewed Oct 24, 2017

View reviewed changes

mauriciocastillosilva-okta reviewed Oct 24, 2017

View reviewed changes

gowthamidommety-okta requested a review from yuliu-okta October 25, 2017 18:11

rajaguruduraisamy-okta approved these changes Oct 25, 2017

View reviewed changes

yuliu-okta reviewed Oct 25, 2017

View reviewed changes

gowthamidommety-okta commented Oct 31, 2017

View reviewed changes

lboyette-okta reviewed Oct 31, 2017

View reviewed changes

gowthamidommety-okta force-pushed the gd-OKTA-145614-webfingerSupport branch from 421d2b0 to 3a9cbf7 Compare November 1, 2017 04:41

lboyette-okta approved these changes Nov 1, 2017

View reviewed changes

🌱 Adds support for Webfinger API calls

2a4a535

Adds support for Webfinger API calls Resolves: OKTA-145614

gowthamidommety-okta force-pushed the gd-OKTA-145614-webfingerSupport branch from 3a9cbf7 to 2a4a535 Compare November 1, 2017 18:29

gowthamidommety-okta merged commit 4982c06 into master Nov 1, 2017

jmelberg-okta deleted the gd-OKTA-145614-webfingerSupport branch June 15, 2018 16:07

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

🌱 Adds support for Webfinger API calls #70

🌱 Adds support for Webfinger API calls #70

gowthamidommety-okta commented Oct 23, 2017

rajaguruduraisamy-okta left a comment

gowthamidommety-okta commented Oct 24, 2017

mauriciocastillosilva-okta left a comment

gowthamidommety-okta commented Oct 24, 2017

rajaguruduraisamy-okta left a comment

yuliu-okta Oct 25, 2017

gowthamidommety-okta Oct 25, 2017

yuliu-okta Oct 25, 2017

yuliu-okta Oct 25, 2017

gowthamidommety-okta Oct 25, 2017

yuliu-okta Oct 25, 2017

gowthamidommety-okta Oct 25, 2017

gowthamidommety-okta Oct 31, 2017

lboyette-okta Oct 31, 2017 •

edited

Loading

gowthamidommety-okta Nov 1, 2017

lboyette-okta left a comment

lboyette-okta Oct 31, 2017

lboyette-okta Oct 31, 2017

lboyette-okta Oct 31, 2017

lboyette-okta Oct 31, 2017

gowthamidommety-okta Oct 31, 2017

gowthamidommety-okta Nov 1, 2017 •

edited

Loading

lboyette-okta Oct 31, 2017 •

edited

Loading

gowthamidommety-okta Oct 31, 2017

lboyette-okta Oct 31, 2017 •

edited

Loading

lboyette-okta Oct 31, 2017

lboyette-okta Oct 31, 2017

lboyette-okta Oct 31, 2017

lboyette-okta left a comment

🌱 Adds support for Webfinger API calls #70

🌱 Adds support for Webfinger API calls #70

Conversation

gowthamidommety-okta commented Oct 23, 2017

rajaguruduraisamy-okta left a comment

Choose a reason for hiding this comment

gowthamidommety-okta commented Oct 24, 2017

mauriciocastillosilva-okta left a comment

Choose a reason for hiding this comment

gowthamidommety-okta commented Oct 24, 2017

rajaguruduraisamy-okta left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lboyette-okta Oct 31, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lboyette-okta left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gowthamidommety-okta Nov 1, 2017 • edited Loading

Choose a reason for hiding this comment

lboyette-okta Oct 31, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lboyette-okta Oct 31, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lboyette-okta left a comment

Choose a reason for hiding this comment

lboyette-okta Oct 31, 2017 •

edited

Loading

gowthamidommety-okta Nov 1, 2017 •

edited

Loading

lboyette-okta Oct 31, 2017 •

edited

Loading

lboyette-okta Oct 31, 2017 •

edited

Loading