Interface AuthenticationProvider

Our authentication provider should at least contain the following information:

The signature of authentication providers from vscode
Registration information about the provider (id, label)
Provider options (supportsMultipleAccounts)

Additionally, we provide the possibility to sign out of a specific account name.

interface AuthenticationProvider {
    id: string;
    label: string;
    onDidChangeSessions: Event<
        AuthenticationProviderAuthenticationSessionsChangeEvent,
    >;
    supportsMultipleAccounts: boolean;
    createSession(
        scopes: string[],
        options: AuthenticationProviderSessionOptions,
    ): Thenable<AuthenticationSession>;
    getSessions(
        scopes: undefined | string[],
        account?: AuthenticationSessionAccountInformation,
    ): Thenable<readonly AuthenticationSession[]>;
    hasSessions(): boolean;
    removeSession(sessionId: string): Thenable<void>;
    signOut(accountName: string): Promise<void>;
    updateSessionItems(
        event: AuthenticationProviderAuthenticationSessionsChangeEvent,
    ): Promise<void>;
}

Implemented by

AuthenticationProviderImpl

Index

Properties

id label onDidChangeSessions supportsMultipleAccounts

Methods

createSession getSessions hasSessions removeSession signOut updateSessionItems

Properties

id

id: string

label

label: string

`Readonly`onDidChangeSessions

onDidChangeSessions: Event<
AuthenticationProviderAuthenticationSessionsChangeEvent,
>

An event which fires when the array of sessions has changed, or data within a session has changed.

supportsMultipleAccounts

supportsMultipleAccounts: boolean

Methods

createSession

createSession(
scopes: string[],
options: AuthenticationProviderSessionOptions,
): Thenable<AuthenticationSession>
Prompts a user to login.
Parameters
- scopes: string[]
  A list of scopes, permissions, that the new session should be created with.
- options: AuthenticationProviderSessionOptions
  The options for createing the session
Returns Thenable<AuthenticationSession>
A promise that resolves to an authentication session.
- Defined in packages/core/src/browser/authentication-service.ts:113

getSessions

getSessions(
scopes: undefined | string[],
account?: AuthenticationSessionAccountInformation,
): Thenable<readonly AuthenticationSession[]>
Get a list of sessions.
Parameters
- scopes: undefined | string[]
  An optional list of scopes. If provided, the sessions returned should match these permissions, otherwise all sessions should be returned.
- Optionalaccount: AuthenticationSessionAccountInformation
  The optional account that you would like to get the session for
Returns Thenable<readonly AuthenticationSession[]>
A promise that resolves to an array of authentication sessions.
- Defined in packages/core/src/browser/authentication-service.ts:105

hasSessions

hasSessions(): boolean
Returns boolean
- Defined in packages/core/src/browser/authentication-service.ts:86

removeSession

removeSession(sessionId: string): Thenable<void>
Removes the session corresponding to session id.
Parameters
- sessionId: string
  The id of the session to remove.
Returns Thenable<void>
- Defined in packages/core/src/browser/authentication-service.ts:119

signOut

signOut(accountName: string): Promise<void>
Parameters
- accountName: string
Returns Promise<void>
- Defined in packages/core/src/browser/authentication-service.ts:88

updateSessionItems

updateSessionItems(
event: AuthenticationProviderAuthenticationSessionsChangeEvent,
): Promise<void>
Parameters
- event: AuthenticationProviderAuthenticationSessionsChangeEvent
Returns Promise<void>
- Defined in packages/core/src/browser/authentication-service.ts:90