Official docs out of date for API grant types needed

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

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
php

Research direction

Start with the linked Configure Login by Auth0 documentation and the README, then reproduce the failure from the listed Sync settings steps using the stated WordPress and Auth0 versions. Confirm which grant types each sync option requires and document them; done when setup no longer relies on undocumented scopes and the failure provides useful guidance.

Written by the indexing model from the issue text.

Description

Scope: Documentation
Checklist
  • I have looked into the Readme and the documentation, and have not found a suitable solution or answer.
  • I have searched the issues and have not found a suitable solution or answer.
  • I have searched the Auth0 Community forums and have not found a suitable solution or answer.
  • I agree to the terms within the Auth0 Code of Conduct.
Description

Adding Sync configuration settings in the admin fails with a fatal error and no useful error message if the application API is not configured to have the currently undocumented grant types of read:connections and I think create:user_tickets. Additionally depending on the sync options chosen you might need delete:users as well as read:users and create:users and update:users.

Those should at least be documented in the readme here, but you'll know best which scopes are actually needed now with v5.

To provide proper error messages and handling it probably needs read:client_grants too to help users know how to resolve the problem.

Reproduction
  1. Create an auth0 application and configure the API per the current docs with read:users and update:users scopes enabled
  2. Go to the admin Sync settings page for the plugin and enter a db connection name
  3. Save changes
  4. Fatal error screen shows
Additional context

No response

wp-auth0 version

5.5

WordPress version

6.9

PHP version

8.4

Dominant language
PHP
Stars
182
Forks
103
PR merge metrics
No merged PRs in 30d

Contributor guide

Open the contributing guide

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.

More from auth0/wordpress

All issues in auth0/wordpress

Similar issues

More PHP issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.