Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "src/crud/user"

Index

Variables

Functions

Variables

Const facebook

facebook: ClientOAuth2 = new ClientOAuth2({clientId: FACEBOOK_CLIENT_ID,clientSecret: FACEBOOK_CLIENT_SECRET,redirectUri: `${FRONTEND_URL}/auth/connect-identity/facebook`,authorizationUri: "https://www.facebook.com/v4.0/dialog/oauth",accessTokenUri: "https://graph.facebook.com/v4.0/oauth/access_token",scopes: ["default"]})

Const github

github: ClientOAuth2 = new ClientOAuth2({clientId: GITHUB_CLIENT_ID,clientSecret: GITHUB_CLIENT_SECRET,redirectUri: `${FRONTEND_URL}/auth/connect-identity/github`,authorizationUri: "https://github.com/login/oauth/authorize",accessTokenUri: "https://github.com/login/oauth/access_token",scopes: ["read:user", "user:email"]})

Const microsoft

microsoft: ClientOAuth2 = new ClientOAuth2({clientId: MICROSOFT_CLIENT_ID,clientSecret: MICROSOFT_CLIENT_SECRET,redirectUri: `${FRONTEND_URL}/auth/connect-identity/microsoft`,authorizationUri: "https://login.microsoftonline.com/common/oauth2/authorize",accessTokenUri: "https://login.microsoftonline.com/common/oauth2/token",scopes: ["user.read"]})

Functions

Const addApprovedLocation

  • addApprovedLocation(userId: string, ipAddress: string): Promise<any>

  • Add a new approved location for a user

    Parameters

    • userId: string
    • ipAddress: string

      IP address for the new location

    Returns Promise<any>

Const checkApprovedLocation

  • checkApprovedLocation(userId: string, ipAddress: string): Promise<boolean>

  • Check whether a location is approved for a user

    Parameters

    • userId: string
    • ipAddress: string

      IP address for checking

    Returns Promise<boolean>

Const checkIdentityAvailability

  • checkIdentityAvailability(service: string, id: string): Promise<boolean>

  • Create a identity: Check if available

    Parameters

    • service: string
    • id: string

    Returns Promise<boolean>

Const checkUsernameAvailability

  • checkUsernameAvailability(username: string): Promise<boolean>

  • Get a user by their username

    Parameters

    • username: string

    Returns Promise<boolean>

Const createAccessToken

  • createAccessToken(newAccessToken: AccessToken): Promise<any>

  • Create an API key

    Parameters

    Returns Promise<any>

Const createBackupCodes

  • createBackupCodes(userId: string, count?: number): Promise<void>

  • Create 2FA backup codes for user

    Parameters

    • userId: string
    • Default value count: number = 1

      Number of backup codes to create

    Returns Promise<void>

Const createIdentity

  • createIdentity(newIdentity: Identity): Promise<any>

  • Create a identity

    Parameters

    Returns Promise<any>

Const createIdentityConnect

  • createIdentityConnect(userId: string, service: string, url: string): Promise<object>

  • Create a identity: Connect OAuth

    Parameters

    • userId: string
    • service: string
    • url: string

    Returns Promise<object>

Const createIdentityGetOAuthLink

  • createIdentityGetOAuthLink(userId: string, newIdentity: KeyValue): Promise<object>

  • Create a identity: Get an OAuth link

    Parameters

    Returns Promise<object>

Const createSession

  • createSession(newSession: Session): Promise<any>

  • Create a session

    Parameters

    Returns Promise<any>

Const createUser

  • createUser(user: User): Promise<any>

  • Create a new user

    Parameters

    Returns Promise<any>

Const deleteAccessToken

  • deleteAccessToken(userId: string, accessTokenId: string): Promise<any>

  • Delete an API key

    Parameters

    • userId: string
    • accessTokenId: string

    Returns Promise<any>

Const deleteAllUserApprovedLocations

  • deleteAllUserApprovedLocations(userId: string): Promise<any>

  • Delete all approved locations for a user

    Parameters

    • userId: string

    Returns Promise<any>

Const deleteBackupCode

  • deleteBackupCode(backupCode: number): Promise<any>

  • Delete a backup code

    Parameters

    • backupCode: number

    Returns Promise<any>

Const deleteIdentity

  • deleteIdentity(userId: string, identityId: string): Promise<any>

  • Delete an identity

    Parameters

    • userId: string
    • identityId: string

    Returns Promise<any>

Const deleteSession

  • deleteSession(userId: string, sessionId: string): Promise<any>

  • Invalidate a session

    Parameters

    • userId: string
    • sessionId: string

    Returns Promise<any>

Const deleteSessionByJwt

  • deleteSessionByJwt(userId: string, sessionJwt: string): Promise<any>

  • Update a user's details

    Parameters

    • userId: string
    • sessionJwt: string

    Returns Promise<any>

Const deleteUser

  • deleteUser(id: string): Promise<any>

  • Delete a user

    Parameters

    • id: string

    Returns Promise<any>

Const deleteUserBackupCodes

  • deleteUserBackupCodes(userId: string): Promise<any>

  • Delete all backup codes of a user

    Parameters

    • userId: string

    Returns Promise<any>

Const getAccessToken

  • getAccessToken(userId: string, accessTokenId: string): Promise<AccessToken>

  • Get an API key

    Parameters

    • userId: string
    • accessTokenId: string

    Returns Promise<AccessToken>

Const getAllUsers

  • getAllUsers(): Promise<User[]>

  • Get a list of all ${tableName("users")}

    Returns Promise<User[]>

Const getIdentity

  • getIdentity(userId: string, identityId: string): Promise<Identity>

  • Get a identity

    Parameters

    • userId: string
    • identityId: string

    Returns Promise<Identity>

Const getIdentityByServiceId

  • getIdentityByServiceId(service: string, id: string): Promise<Identity>

  • Get a identity

    Parameters

    • service: string
    • id: string

    Returns Promise<Identity>

Const getSession

  • getSession(userId: string, sessionId: string): Promise<Session>

  • Get a session

    Parameters

    • userId: string
    • sessionId: string

    Returns Promise<Session>

Const getUser

  • getUser(id: string, secureOrigin?: boolean): Promise<User>

  • Get the details of a user

    Parameters

    • id: string
    • Default value secureOrigin: boolean = false

      Whether security keys (password/tokens) should be returned too

    Returns Promise<User>

Const getUserAccessTokens

  • getUserAccessTokens(userId: string, query: KeyValue): Promise<object>

  • Get a list of all approved locations of a user

    Parameters

    Returns Promise<object>

Const getUserApprovedLocations

  • getUserApprovedLocations(userId: string): Promise<any>

  • Get a list of all approved locations of a user

    Parameters

    • userId: string

    Returns Promise<any>

Const getUserBackupCode

  • getUserBackupCode(userId: string, backupCode: number): Promise<BackupCode>

  • Get a specific backup code

    Parameters

    • userId: string
    • backupCode: number

    Returns Promise<BackupCode>

Const getUserBackupCodes

  • getUserBackupCodes(userId: string): Promise<any>

  • Get all backup codes of a user

    Parameters

    • userId: string

    Returns Promise<any>

Const getUserByEmail

  • getUserByEmail(email: string, secureOrigin?: boolean): Promise<User>

  • Get the details of a user by their email

    Parameters

    • email: string
    • Default value secureOrigin: boolean = false

    Returns Promise<User>

Const getUserByUsername

  • getUserByUsername(username: string): Promise<User>

  • Get a user by their username

    Parameters

    • username: string

    Returns Promise<User>

Const getUserIdFromUsername

  • getUserIdFromUsername(username: string): Promise<string>

  • Parameters

    • username: string

    Returns Promise<string>

Const getUserIdentities

  • getUserIdentities(userId: string, query: KeyValue): Promise<object>

  • Get a list of all identities of a user

    Parameters

    Returns Promise<object>

Const getUserSessions

  • getUserSessions(userId: string, query: KeyValue): Promise<object>

  • Get a list of all valid sessions of a user

    Parameters

    Returns Promise<object>

Const updateAccessToken

  • updateAccessToken(userId: string, accessTokenId: string, data: KeyValue): Promise<any>

  • Update a user's details

    Parameters

    • userId: string
    • accessTokenId: string
    • data: KeyValue

    Returns Promise<any>

Const updateBackupCode

  • updateBackupCode(backupCode: number, code: KeyValue): Promise<any>

  • Update a backup code

    Parameters

    Returns Promise<any>

Const updateIdentity

  • updateIdentity(userId: string, identityId: string, data: KeyValue): Promise<any>

  • Update a user's identity

    Parameters

    • userId: string
    • identityId: string
    • data: KeyValue

    Returns Promise<any>

Const updateSession

  • updateSession(userId: string, sessionId: string, data: KeyValue): Promise<any>

  • Update a user's details

    Parameters

    • userId: string
    • sessionId: string
    • data: KeyValue

    Returns Promise<any>

Const updateSessionByJwt

  • updateSessionByJwt(userId: string, sessionJwt: string, data: KeyValue): Promise<any>

  • Update a user's details

    Parameters

    • userId: string
    • sessionJwt: string
    • data: KeyValue

    Returns Promise<any>

Const updateUser

  • updateUser(id: string, user: KeyValue): Promise<any>

  • Update a user's details

    Parameters

    Returns Promise<any>

Generated using TypeDoc