Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

$oidcAccessToken documentation & debug information can be improved #1322

Open
DocMoebiuz opened this issue Nov 12, 2024 · 0 comments
Open

$oidcAccessToken documentation & debug information can be improved #1322

DocMoebiuz opened this issue Nov 12, 2024 · 0 comments

Comments

@DocMoebiuz
Copy link

  • REST Client Version: n/a
  • VSCode Version: n/a
  • OS Version: n/a

Steps to Reproduce:

  1. Navigate to $oidcAccessToken in Readme.md
  2. Check the parameter documentation
  3. The < and > for optional parameters are confusing
  4. There is one curly brace } missing at the end

optional paramater list confusing format

Current:

{{$oidcAccessToken  [new]  [<clientId:<clientId>] [<callbackPort:<callbackPort>] [authorizeEndpoint:<authorizeEndpoint}] [tokenEndpoint:<tokenEndpoint}] [scopes:<scopes}] [audience:<audience}]}

Should be:

{{$oidcAccessToken  [new]  [clientId:<clientId>] [callbackPort:<callbackPort>] [authorizeEndpoint:<authorizeEndpoint>] [tokenEndpoint:<tokenEndpoint>] [scopes:<scopes>] [audience:<audience>]}}

Provide example

It would be helpful to add a working example, e.g. for Google (taken from pull request)

GET https://openidconnect.googleapis.com/v1/userinfo
Authorization: Bearer {{$oidcAccessToken clientId:786371393912-ahu1p5p81n2pj4fa90bo33pirr1mroeu.apps.googleusercontent.com callbackPort:7777 authorizeEndpoint:https://accounts.google.com/o/oauth2/v2/auth tokenEndpoint:https://oauth2.googleapis.com/token}}
Accept: application/json

Provide snippet

Similar to the example, this $oidcAccessToken could be included as snippet

Better debug information

With my OIDC settings and parameters it is not working right away. I cannot see any log or debug information and I cannot troubleshoot the issue.

@DocMoebiuz DocMoebiuz changed the title $oidcAccessToken documentation can be improved $oidcAccessToken documentation & debug information can be improved Nov 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant