Interface AuthProvider

Readonly clientId

getAccessTokenForUser

• getAccessTokenForUser(user, scopes?): Promise<AccessTokenWithUserId>

• Gets the access token data for the given user.

  Parameters

  • user: UserIdResolvable

    The ID of the user to get the access token of.

  • Optional scopes: string[]

    The list of required scopes that will be compared against the existing token scopes.

  Returns Promise<AccessTokenWithUserId>

  Throws

  UnregisteredUserError if user is not registered in the provider.

  Throws

  MissingScopeError if user is not registered in the provider.

getScopesForUser

• getScopesForUser(user): string[]

• Gets the scopes for a user that are currently available using the access token.

  If scopes were not set on user registration then it returns an empty array.

  Parameters

  • user: UserIdResolvable

  Returns string[]

  Throws

  UnregisteredUserError if user is not registered in the provider.

Optional refreshAccessTokenForUser

• refreshAccessTokenForUser(user): Promise<AccessTokenWithUserId>

• Refreshes the access token.

  This method is optional to implement.

  Parameters

  • user: UserIdResolvable

    The ID of the user to refresh the access token of.

  Returns Promise<AccessTokenWithUserId>