auth0.js: Docs are missing callback and `relay_url`

Looks like auth.popup.authorize() assumes that the second arg is a callback, but the docs don’t mention it:

https://auth0.com/docs/libraries/auth0js/v8#webauth-popup-authorize-

Docs also don’t mention a relay_url:

  auth.popup.authorize(
    {
      connection: 'github',
      responseType: 'token'
    },
    (err, authResult) => {
      console.log({ err, authResult })
    }
  )

{original: "missing required 'relay_url' parameter", code: null, description: null}

This doesn’t fix it:

  auth.popup.authorize(
    {
      connection: 'github',
      responseType: 'token',
      relay_url: 'http://localhost:3000/'

v8.12.1

About this issue

Original URL
State: closed
Created 7 years ago
Comments: 15 (7 by maintainers)

Most upvoted comments

@luisrudge, thanks for the info on the OWP param. Is that a valid long term solution to this issue? I’m migrating from v6 to v9 as we speak. The redirect error when using a popup was unintuitive, as we want the pop-up to close, not redirect.

We also noticed that there are missing docs for:

Existence and purpose of owp option
Existence and signature of callback parameter
The fact that the function returns an object with focus and close methods

BennettStaley on Mar 26, 2018

Right… can you try passing owp: true to the authorize call and see if that works?

luisrudge on Dec 21, 2017

I’m not sure your value is valid tbh… I think you’re better off asking in our support channels: https://support.auth0.com

I’ll ping the docs team to add the owp param.

luisrudge on Dec 21, 2017