Skip to content

$oidcAccessToken documentation & debug information can be improved #1322

Open
@DocMoebiuz

Description

@DocMoebiuz
  • 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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions