Skip to content

Fixed oidcAccessToken scope issue and improved documentation #1360

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.

Sign up for GitHub

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

Open
mauriceackel wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Fixed oidcAccessToken scope issue and improved documentation #1360

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3ebbfca
Fixed scope issue and improved regex
mauriceackel Feb 22, 2025
b60a181
Improved documentation
mauriceackel Feb 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ REST Client allows you to send HTTP request and view the response in Visual Stud
+ `{{$processEnv [%]envVarName}}`
+ `{{$dotenv [%]variableName}}`
+ `{{$aadToken [new] [public|cn|de|us|ppe] [<domain|tenantId>] [aud:<domain|tenantId>]}}`
+ `{{$oidcAccessToken [new] [<clientId:<clientId>] [<callbackPort:<callbackPort>] [authorizeEndpoint:<authorizeEndpoint}] [tokenEndpoint:<tokenEndpoint}] [scopes:<scopes}] [audience:<audience}]}`
+ `{{$oidcAccessToken [new] [clientId:<clientId>] [callbackPort:<callbackPort>] [authorizeEndpoint:<authorizeEndpoint>] [tokenEndpoint:<tokenEndpoint>] [scopes:<scope[,]>] [audience:<audience>]}}`
- Easily create/update/delete environments and environment variables in setting file
- File variables can reference both custom and system variables
- Support environment switch
Expand Down Expand Up @@ -601,12 +601,14 @@ System variables provide a pre-defined set of variables that can be used in any

`clientId:<clientid>`: Optional. Identifier of the application registration to use to obtain the token. Default uses an application registration created specifically for this plugin.

* `{{$oidcAccessToken [new] [<clientId:<clientId>] [<callbackPort:<callbackPort>] [authorizeEndpoint:<authorizeEndpoint}] [tokenEndpoint:<tokenEndpoint}] [scopes:<scopes}] [audience:<audience}]}`: Add an Oidc Identity Server token based on the following options (must be specified in order):
* `{{$oidcAccessToken [new] [clientId:<clientId>] [callbackDomain:<callbackDomain>] [callbackPort:<callbackPort>] [authorizeEndpoint:<authorizeEndpoint>] [tokenEndpoint:<tokenEndpoint>] [scopes:<scope[,]>] [audience:<audience>]}}`: Add an Oidc Identity Server token based on the following options (must be specified in order):

`new`: Optional. Specify `new` to force re-authentication and get a new token for the client. Default: Reuse previous token for clientId from an in-memory cache. Expired tokens are refreshed automatically. (Restart Visual Studio Code to clear the cache.)

`clientId:<clientid>`: Optional. Identifier of the application registration to use to obtain the token.

`callbackDomain:<callbackDomain>`: Optional. If set, redirect URI will be set to `https://<callbackDomain>:<callbackPort>`. Defaults to `localhost` resulting in `http://localhost:<callbackPort>`.

`callbackPort:<callbackPort>`: Optional. Port to use for the local callback server. Default: 7777 (random port).

`authorizeEndpoint:<authorizeEndpoint>`: The authorization endpoint to use.
Expand All @@ -615,7 +617,7 @@ System variables provide a pre-defined set of variables that can be used in any

`scopes:<scope[,]>`: Optional. Comma delimited list of scopes that must have consent to allow the call to be successful.

`audience:<audience>`: Optional.
`audience:<audience>`: Optional. When set, will be passed in the query as `audience` parameter.

* `{{$guid}}`: Add a RFC 4122 v4 UUID
* `{{$processEnv [%]envVarName}}`: Allows the resolution of a local machine environment variable to a string value. A typical use case is for secret keys that you don't want to commit to source control.
Expand Down
2 changes: 1 addition & 1 deletion src/utils/httpVariableProviders/systemVariableProvider.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ export class SystemVariableProvider implements HttpVariableProvider {
private readonly requestUrlRegex: RegExp = /^(?:[^\s]+\s+)([^:]*:\/\/\/?[^/\s]*\/?)/;

private readonly aadRegex: RegExp = new RegExp(`\\s*\\${Constants.AzureActiveDirectoryVariableName}(\\s+(${Constants.AzureActiveDirectoryForceNewOption}))?(\\s+(ppe|public|cn|de|us))?(\\s+([^\\.]+\\.[^\\}\\s]+|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}))?(\\s+aud:([^\\.]+\\.[^\\}\\s]+|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}))?\\s*`);
private readonly oidcRegex: RegExp = new RegExp(`\\s*(\\${Constants.OidcVariableName})(?:\\s+(${Constants.OIdcForceNewOption}))?(?:\\s*clientId:([\\w|.|:|/|_|-]+))?(?:\\s*issuer:([\\w|.|:|/]+))?(?:\\s*callbackDomain:([\\w|.|:|/|_|-]+))?(?:\\s*callbackPort:([\\w|_]+))?(?:\\s*authorizeEndpoint:([\\w|.|:|/|_|-]+))?(?:\\s*tokenEndpoint:([\\w|.|:|/|_|-]+))?(?:\\s*scopes:([\\w|.|:|/|_|-]+))?(?:\\s*audience:([\\w|.|:|/|_|-]+))?`);
private readonly oidcRegex: RegExp = new RegExp(`\\s*(\\${Constants.OidcVariableName})(?:\\s+(${Constants.OIdcForceNewOption}))?(?:\\s*clientId:([\\w.:/_\\-]+))?(?:\\s*issuer:([\\w.:/]+))?(?:\\s*callbackDomain:([\\w.:/_\\-]+))?(?:\\s*callbackPort:([\\w_]+))?(?:\\s*authorizeEndpoint:([\\w.:/_\\-]+))?(?:\\s*tokenEndpoint:([\\w.:/_\\-]+))?(?:\\s*scopes:([\\w.:/_\\-,]+))?(?:\\s*audience:([\\w.:/_\\-]+))?`);

private readonly innerSettingsEnvironmentVariableProvider: EnvironmentVariableProvider = EnvironmentVariableProvider.Instance;
private static _instance: SystemVariableProvider;
Expand Down