Interface AuthenticationProvider

ReadonlyonDidChangeSessions

createSession

• createSession(
      scopes: readonly string[],
      options: AuthenticationProviderSessionOptions,
  ): Thenable<AuthenticationSession>

  Prompts a user to login.

  If login is successful, the onDidChangeSessions event should be fired.

  If login fails, a rejected promise should be returned.

  If the provider has specified that it does not support multiple accounts, then this should never be called if there is already an existing session matching these scopes.

  Parameters

  • scopes: readonly string[]

    A list of scopes, permissions, that the new session should be created with.

  • options: AuthenticationProviderSessionOptions

    Additional options for creating a session.

  Returns Thenable<AuthenticationSession>

  A promise that resolves to an authentication session.

getSessions

• getSessions(
      scopes: undefined | readonly string[],
      options: AuthenticationProviderSessionOptions,
  ): Thenable<AuthenticationSession[]>

  Get a list of sessions.

  Parameters

  • scopes: undefined | readonly string[]

    An optional list of scopes. If provided, the sessions returned should match these permissions, otherwise all sessions should be returned.

  • options: AuthenticationProviderSessionOptions

    Additional options for getting sessions.

  Returns Thenable<AuthenticationSession[]>

  A promise that resolves to an array of authentication sessions.

removeSession

• removeSession(sessionId: string): Thenable<void>

  Removes the session corresponding to session id.

  If the removal is successful, the onDidChangeSessions event should be fired.

  If a session cannot be removed, the provider should reject with an error message.

  Parameters

  • sessionId: string

    The id of the session to remove.

  Returns Thenable<void>