Function getSession

getSession(
    providerId: string,
    scopeListOrRequest:
        | readonly string[]
        | AuthenticationWwwAuthenticateRequest,
    options: AuthenticationGetSessionOptions & {
        createIfNone: true | AuthenticationGetSessionPresentationOptions;
    },
): Thenable<AuthenticationSession>
Get an authentication session matching the desired scopes or satisfying the WWW-Authenticate request. Rejects if a provider with providerId is not registered, or if the user does not consent to sharing authentication information with the extension. If there are multiple sessions with the same scopes, the user will be shown a quickpick to select which account they would like to use.

Built-in auth providers include:
- 'github' - For GitHub.com
- 'microsoft' For both personal & organizational Microsoft accounts
- (less common) 'github-enterprise' - for alternative GitHub hostings, GHE.com, GitHub Enterprise Server
- (less common) 'microsoft-sovereign-cloud' - for alternative Microsoft clouds
Parameters
- providerId: string
  The id of the provider to use
- scopeListOrRequest: readonly string[] | AuthenticationWwwAuthenticateRequest
  A scope list of permissions requested or a WWW-Authenticate request. These are dependent on the authentication provider.
- options: AuthenticationGetSessionOptions & {
  createIfNone: true | AuthenticationGetSessionPresentationOptions;
  }
  The AuthenticationGetSessionOptions to use
Returns Thenable<AuthenticationSession>
A thenable that resolves to an authentication session
- Defined in vscode.d.ts:18109
getSession(
    providerId: string,
    scopeListOrRequest:
        | readonly string[]
        | AuthenticationWwwAuthenticateRequest,
    options: AuthenticationGetSessionOptions & {
        forceNewSession: true | AuthenticationGetSessionPresentationOptions;
    },
): Thenable<AuthenticationSession>
Get an authentication session matching the desired scopes or request. Rejects if a provider with providerId is not registered, or if the user does not consent to sharing authentication information with the extension. If there are multiple sessions with the same scopes, the user will be shown a quickpick to select which account they would like to use.

Built-in auth providers include:
- 'github' - For GitHub.com
- 'microsoft' For both personal & organizational Microsoft accounts
- (less common) 'github-enterprise' - for alternative GitHub hostings, GHE.com, GitHub Enterprise Server
- (less common) 'microsoft-sovereign-cloud' - for alternative Microsoft clouds
Parameters
- providerId: string
  The id of the provider to use
- scopeListOrRequest: readonly string[] | AuthenticationWwwAuthenticateRequest
  A scope list of permissions requested or a WWW-Authenticate request. These are dependent on the authentication provider.
- options: AuthenticationGetSessionOptions & {
  forceNewSession: true | AuthenticationGetSessionPresentationOptions;
  }
  The AuthenticationGetSessionOptions to use
Returns Thenable<AuthenticationSession>
A thenable that resolves to an authentication session
- Defined in vscode.d.ts:18127
getSession(
    providerId: string,
    scopeListOrRequest:
        | readonly string[]
        | AuthenticationWwwAuthenticateRequest,
    options?: AuthenticationGetSessionOptions,
): Thenable<AuthenticationSession | undefined>
Get an authentication session matching the desired scopes or request. Rejects if a provider with providerId is not registered, or if the user does not consent to sharing authentication information with the extension. If there are multiple sessions with the same scopes, the user will be shown a quickpick to select which account they would like to use.

Built-in auth providers include:
- 'github' - For GitHub.com
- 'microsoft' For both personal & organizational Microsoft accounts
- (less common) 'github-enterprise' - for alternative GitHub hostings, GHE.com, GitHub Enterprise Server
- (less common) 'microsoft-sovereign-cloud' - for alternative Microsoft clouds
Parameters
- providerId: string
  The id of the provider to use
- scopeListOrRequest: readonly string[] | AuthenticationWwwAuthenticateRequest
  A scope list of permissions requested or a WWW-Authenticate request. These are dependent on the authentication provider.
- Optionaloptions: AuthenticationGetSessionOptions
  The AuthenticationGetSessionOptions to use
Returns Thenable<AuthenticationSession | undefined>
A thenable that resolves to an authentication session or undefined if a silent flow was used and no session was found
- Defined in vscode.d.ts:18145

Function getSession

Parameters

Returns Thenable<AuthenticationSession>

Parameters

Returns Thenable<AuthenticationSession>

Parameters

Returns Thenable<AuthenticationSession | undefined>

Settings