1. Backend
  2. Node Library Reference

Installation

$ npm install --save @propelauth/node

Initialize

initBaseAuth performs a one-time initialization of the library. It will verify your apiKey is correct and fetch the metadata needed to verify access tokens in validateAccessTokenAndGetUser and validateAccessTokenAndGetUserWithOrgInfo.

const propelAuth = require("@propelauth/node");
const {
  validateAccessTokenAndGetUser,
  validateAccessTokenAndGetUserWithOrgInfo,
  validateAccessTokenAndGetUserWithOrgInfoWithMinimumRole,
  validateAccessTokenAndGetUserWithOrgInfoWithExactRole,
  validateAccessTokenAndGetUserWithOrgInfoWithPermission,
  validateAccessTokenAndGetUserWithOrgInfoWithAllPermissions,
  fetchUserMetadataByUserId,
  // ...
} = propelAuth.initBaseAuth({
  authUrl: "https://auth.yourdomain.com", // The base URL where your authentication pages are hosted. You can find this under the Backend Integration section for your project at https://app.propelauth.com.
  apiKey: "YOUR_API_KEY", // You can manage your api keys under the Backend Integration section for your project.
});

We recommend putting this in its own file and exporting it:

// propelauth.js
const propelAuth = require("@propelauth/node");
module.exports = propelAuth.initBaseAuth({
  authUrl: "https://auth.yourdomain.com",
  apiKey: "YOUR_API_KEY",
});

And then importing just what you need:

const { validateAccessTokenAndGetUser } = require("./propelauth");

Protect API routes

validateAccessTokenAndGetUser

This function takes in the Authorization HTTP header and verifies the request was made by a valid user. It expects the header to be in the format Bearer ACCESS_TOKEN. If the Authorization HTTP header is malformed or doesn’t contain a valid access token, an UnauthorizedException is thrown.

const authorizationHeader = // Get the Authorization header from an HTTP request
try {
    const user = await validateAccessTokenAndGetUser(authorizationHeader)
    console.log(`Got request from user ${user.userId}`);
} catch (err) {
    // You can return a 401, or continue the request knowing it wasn't sent from a logged-in user
    console.log(`Unauthorized request ${err}`);
}

The user object looks like:

PropertyDescription
userIdThe id of the user
orgIdToOrgMemberInfoA dictionary of org ids to metadata about the org. Includes all orgs that the user is in
legacyUserIdThe original ID of the user, if the user was migrated from an external source

The values of orgIdToOrgMemberInfo are OrgMemberInfo’s, with the following fields/functions:

FieldDescription
orgIdThe id of the org
orgNameThe name of the org
urlSafeOrgNameA URL-safe version of the name of the org
assignedRole(): stringThe user’s role within the organization. See Roles and Permissions for more details.
permissions(): string[]The user’s permissions within the organization. See Roles and Permissions
isRole(role: string): booleanReturns True if the user’s role within the organization matches the role passed in
isAtLeastRole(role: string): booleanReturns True if the user’s role within the organization is at least the role passed in. If the hierarchy of roles is Owner => Admin => Member, specifying “Admin” will return True for Admins and Owners, but False for Members.
hasPermission(permission: string): booleanReturn True if the user has a specific permission. The users’ permissions are derived from their role within this organization.
hasAllPermissions(permissions: string[]): booleanReturn True if the user has all the specified permissions. The users’ permissions are derived from their role within this organization.

validateAccessTokenAndGetUserWithOrgInfo

This function will verify that a request was made by a valid user AND that user is in an organization.

ArgumentDescription
Authorization HTTP HeaderIt expects the header to be in the format Bearer ACCESS_TOKEN. If the Authorization HTTP header is malformed or doesn’t contain a valid access token, an UnauthorizedException is thrown.
Required Org InfoAn object with optional fields orgId and orgName. This function will make sure the user who made the request is a member of an organization with the specified orgId and orgName. If the user is NOT a member of the specified organization, a ForbiddenException is thrown.

It returns an object with two fields:

{
    user: //...
    orgMemberInfo: //...
}

You can see the structure of the user and orgMemberInfo objects above: validateAccessTokenAndGetUser.

Roles and Permissions

A user has a Role within an organization. By default, the available roles are Owner, Admin, or Member, but these can be configured. These roles are also hierarchical, so Owner > Admin > Member.

Roles allow you to control what different users can do within your product. If you want to check a user’s role, you can use validateAccessTokenAndGetUserWithOrgInfoWithExactRole or validateAccessTokenAndGetUserWithOrgInfoWithMinimumRole.

Permissions are arbitrary strings associated with a role. For example, can_view_billing, ProductA::CanCreate, and ReadOnly are all valid permissions. The PropelAuth dashboard allows you to set up these permissions.

You can use validateAccessTokenAndGetUserWithOrgInfoWithPermission* or validateAccessTokenAndGetUserWithOrgInfoWithAllPermissions to check for a given permission.

All of these functions, just like validateAccessTokenAndGetUserWithOrgInfo, will take in an authorization header and an organization ID. The last parameter is either a role, permission, or list of permissions depending on the function.

Fetch user metadata by id

function fetchUserMetadataByUserId(userId: string, includeOrgs?: boolean): Promise<UserMetadata | null>

Successful response (UserMetadata):

{
    userId:            "e9d3520f-836e-403c-82c2-09843517e1ce",
    email:             "user@example.com",
    emailConfirmed:    true,
    hasPassword:       true,

    username:          "example",
    firstName:         "first",
    lastName:          "last",
    pictureUrl:        "https://...",

    // True if the user's account is locked for security purposes.
    locked:            false,
    enabled:           true,
    mfaEnabled:        false,

    createdAt:         1645131680,
    lastActiveAt:      1650654711,

    // Only returned if includeOrgs = true
    orgIdToOrgInfo: {
        "2ef0e1fc-234f-4dc0-a50c-35adb1bbb7e4" : {
            orgId: "2ef0e1fc-234f-4dc0-a50c-35adb1bbb7e4",
            orgName: "ExampleOrganization",
            userAssignedRole: "Owner",
        }
    },

    // Only returned if user was migrated from an external system
    legacyUserId:    "507f191e810c19729de860ea"
}

Fetch user metadata by email

function fetchUserMetadataByEmail(email: string, includeOrgs?: boolean): Promise<UserMetadata | null>

Successful response is the same as Fetch user metadata by id.

Fetch user metadata by username

function fetchUserMetadataByUsername(username: string, includeOrgs?: boolean): Promise<UserMetadata | null>

Successful response is the same as Fetch user metadata by id.

Batch fetch users by ids

function fetchBatchUserMetadataByUserIds(userIds: string[], includeOrgs?: boolean): Promise<{ [userId: string]: UserMetadata }>

Any IDs that don’t have a match are not returned. Duplicate users are only returned once.

Successful response:

{
    "e9d3520f-836e-403c-82c2-09843517e1ce": {
        userId:            "e9d3520f-836e-403c-82c2-09843517e1ce",
        email:             "user@example.com",
        emailConfirmed:    true,
        hasPassword:       true,

        username:          "example",
        firstName:         "first",
        lastName:          "last",
        pictureUrl:        "https://...",

        // True if the user's account is locked for security purposes.
        locked:            false,
        enabled:           true,
        mfaEnabled:        false,

        createdAt:         1645131680,
        lastActiveAt:      1650654711,

        // Only returned if includeOrgs = true
        orgIdToOrgInfo: {
            "2ef0e1fc-234f-4dc0-a50c-35adb1bbb7e4" : {
                orgId: "2ef0e1fc-234f-4dc0-a50c-35adb1bbb7e4",
                orgName: "ExampleOrganization",
                userAssignedRole: "Owner",
            }
        },

        // Only returned if user was migrated from an external system
        legacyUserId:    "507f191e810c19729de860ea"
    },
    // other user_ids
}

Batch fetch users by emails

function fetchBatchUserMetadataByEmails(emails: string[], includeOrgs?: boolean): Promise<{ [email: string]: UserMetadata }>

Successful response is the same as Batch fetch users by ids, but the keys are matching email addresses.

Batch fetch users by usernames

function fetchBatchUserMetadataByUsernames(usernames: string[], includeOrgs?: boolean): Promise<{ [username: string]: UserMetadata }>

Successful response is the same as Batch fetch users by ids, but the keys are matching usernames.

Search for users

function fetchUsersByQuery(usersQuery: UsersQuery): Promise<UsersPagedResponse>

// Example
const usersResponse = await auth.fetchUsersByQuery({emailOrUsername: "@example.com", orderBy: "LAST_ACTIVE_AT_DESC"})
for (const user of userResponse.users) {
    console.log("Found user " + user)
}
ArgumentDescription
pageSizeThe number of results to return at a time. Must be between 1 and 100, default 10.
pageNumberUsed to page over results
orderByHow to order the results. Must be one of: CREATED_AT_ASC, CREATED_AT_DESC, LAST_ACTIVE_AT_ASC, LAST_ACTIVE_AT_DESC, EMAIL, USERNAME
emailOrUsernameSearches for partial matches within email addresses or usernames. port would match a user with email address support@propelauth.com.
includeOrgsWhether or not to include the user’s organization information in the response. Default false

Successful response:

{
    "totalUsers": 103,
    "currentPage": 0,
    "pageSize": 10,
    "hasMoreResults": true,
    "users": [{
        // See (1) for example users
    }, {
        // There will be 10 users in this response
    }]
}
  1. Example user in response

Fetch users in organization

function fetchUsersInOrg(usersInOrgQuery: UsersInOrgQuery): Promise<UsersPagedResponse>

// Example
const usersResponse = await auth.fetchUsersInOrg({
    orgId: req.params.orgId,
    pageNumber: req.params.pageNumber,
})
ArgumentDescription
orgIdThe organization to fetch users for
pageSizeThe number of results to return at a time. Must be between 1 and 100, default 10.
pageNumberUsed to page over results
includeOrgsWhether or not to include the user’s organization information in the response. Default false

Successful response:

{
    "totalUsers": 43,
    "currentPage": 0,
    "pageSize": 10,
    "hasMoreResults": true,
    "users": [{
        // See (1) for example users
    }, {
        // There will be 10 users in this response, all in the specified organization
    }]
}
  1. Example user in response

Create User

function createUser(createUserRequest: CreateUserRequest): Promise<User>
ArgumentDescription
emailThe user’s email address
emailConfirmedWhether the email address should start off as already confirmed. If false, the user is required to confirm the email address before they sign in.
sendEmailToConfirmEmailAddressWhether we should send an email immediately to confirm the user’s email address. If false, the user will get a confirmation email when they first sign in.
passwordOptional password. If unset, the user can set it themselves via their account page
usernameOptional username. Can only be used if username is enabled in your user schema
firstNameOptional first name. Can only be used if name is enabled in your user schema
lastNameOptional last name. Can only be used if name is enabled in your user schema

Successful response:

{
    "userId": "b5f667fb-e51a-49c6-a396-711e62948689"
}

Migrate User from External Source

Similar to Create User, but for cases where you already have a user stored in an external system. You can, for example, pass in a password hash for an existing user, and they will be able to login with their same password. It is also possible to provide an existing identifier, and we will store and return it along with our future identifiers, allowing you to link them.

function migrateUserFromExternalSource(migrateUserFromExternalSourceRequest: MigrateUserFromExternalSourceRequest): Promise<User>
ArgumentDescription
emailThe user’s email address
emailConfirmedWhether the email address should start off as already confirmed. If false, the user is required to confirm the email address before they sign in.
existingUserId(Optional) The user’s ID in the existing system. This ID will be stored on the user as a legacyUserId and it is present everywhere userId’s are (e.g. fetching user metadata or validating a user’s token).
existingPasswordHash(Optional) The user’s hashed password. We support both bcrypt and argon2 password hashes.
existingMfaBase32EncodedSecret(Optional) The user’s MFA secret, base32 encoded. If specified the user will have MFA enabled by default.
enabled(Optional) Whether or not the user can login
usernameOptional username. Can only be used if username is enabled in your user schema
firstNameOptional first name. Can only be used if name is enabled in your user schema
lastNameOptional last name. Can only be used if name is enabled in your user schema

Successful response:

{
    "userId": "b5f667fb-e51a-49c6-a396-711e62948689"
}

Creates a magic link that a user can use to log in. Use this API if you’d prefer to send the magic link to the customer yourself, otherwise, we have createUser which will email them directly.

function createMagicLink(createUserRequest: CreateMagicLinkRequest): Promise<MagicLink>
ArgumentDescription
emailThe user’s email address
redirectToUrl(Optional) Where to redirect the user after they login. If unspecified, will use the login redirect path specified in your dashboard.
expiresInHours(Optional) How many hours should the link be valid for?
createNewUserIfOneDoesntExist(Optional) If true, createMagicLink will create a new user if one matching the provided email address doesn’t exist. If false, the request will fail if no user with that email exists. Default is true.

Successful response:

{
    "url": "https://auth.yourdomain.com/..."
}

Update User Email

// Returns true if it was successful, false if the user was not found
function updateUserEmailWrapper(userId: string, updateUserEmailRequest: UpdateUserEmailRequest): Promise<boolean>
ArgumentDescription
newEmailNew email address for this user
requireEmailConfirmationWhether the new email address requires confirmation. If true, an email will be sent to the new email address to confirm. If false, the users email address will be updated and confirmed immediately.

Update User Metadata

// Returns true if it was successful, false if the user was not found
function updateUserMetadata(userId: string, updateUserMetadataRequest: UpdateUserMetadataRequest): Promise<boolean>
ArgumentDescription
usernameOptional username. Can only be used if username is enabled in your user schema
firstNameOptional first name. Can only be used if name is enabled in your user schema
lastNameOptional last name. Can only be used if name is enabled in your user schema

Delete user

function deleteUser(userId: string): Promise<boolean>

Returns true if the user was deleted.

Disable user

function disableUser(userId: string): Promise<boolean>

Returns true if the user was disabled. Afterwards, the user is logged out and unable to log back in.

Enable user

function enableUser(userId: string): Promise<boolean>

Returns true if the user was enabled, allowing them to log in again.

Fetch an organization

function fetchOrg(orgId: string): Promise<Org | null>

Successful response:

{
    "orgId": "d488996d-8ccc-4101-b5f2-131f5f09ddb6"
    "name": "OneOfYourCustomers"
}

Fetch all organizations

function fetchOrgsByQuery(orgQuery: OrgQuery): Promise<OrgQueryResponse>
ArgumentDescription
pageSizeThe number of results to return at a time. Must be between 1 and 100, default 10.
pageNumberUsed to page over results
orderByHow to order the results. Must be one of: CREATED_AT_ASC, CREATED_AT_DESC, NAME

Successful response:

{
    "totalOrgs": 21,
    "currentPage": 0,
    "pageSize": 10,
    "hasMoreResults": true,
    "orgs": [{
        "orgId": "d488996d-8ccc-4101-b5f2-131f5f09ddb6",
        "name": "OneOfYourCustomers"
    }, {
        // There will be 10 orgs in this response
    }]
}

Create Organization

function createOrg(createOrgRequest: CreateOrgRequest): Promise<Org>
ArgumentDescription
nameThe organization’s name

Successful response:

{
    "orgId": "d488996d-8ccc-4101-b5f2-131f5f09ddb6"
}

Add user to organization

function addUserToOrg(addUserToOrgRequest: AddUserToOrgRequest): Promise<boolean>
ArgumentDescription
userIdThe user’s ID
orgIdThe org’s ID
roleThe role of the user in that organization, e.g. Admin

Returns true if the user was successfully added to the organization.

Allow organization to set up SAML connection

function allowOrgToSetupSamlConnection(orgId: string): Promise<boolean>

Returns true if successful, meaning the organization can now set up SAML connections.

Disallow organization to set up SAML connection

function disallowOrgToSetupSamlConnection(orgId: string): Promise<boolean>

Returns true if successful, meaning the organization can no longer set up SAML connections.