Next.js API Routes Reference

import { initBaseAuth } from "@propelauth/node";

const propelauth = initBaseAuth({
  // You can find these fields under the Backend Integration section for your project in PropelAuth.
  authUrl: "YOUR_AUTH_URL",
  apiKey: "YOUR_API_KEY",
  manualTokenVerificationMetadata: {
    verifierKey: `YOUR
        MULTILINE
        KEY`,
    issuer: "YOUR_ISSUER_URL",
  },
});

import { validateAccessTokenAndGetUser } from "../../lib/propelauth";

import { validateAccessTokenAndGetUser } from "../../lib/propelauth";
export default async function handler(req, res) {
    try {
        const authHeader = req.headers.authorization
        const user = await validateAccessTokenAndGetUser(authHeader)
        res.status(200).json(user)
    } catch (e) {
        res.status(401).send("Unauthorized")
    }
}

import { validateAccessTokenAndGetUserWithOrgInfo } from "../../lib/propelauth";
export default async function handler(req, res) {
    try {
        const authHeader = req.headers.authorization
        const orgId = req.query.orgId
        const {user, orgMemberInfo} = await validateAccessTokenAndGetUserWithOrgInfo(
            authHeader,
            {orgId: orgId}
        )
        res.status(200).json(user)
    } catch (e) {
        res.status(401).send("Unauthorized")
    }
}

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

function fetchUserMetadataByUserId(userId, includeOrgs)

{
    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",

    properties: {
        // Arbitrary key-value pairs
        "key1": "value1",
        "key2": "value2",
    }
}

function fetchUserMetadataByEmail(email, includeOrgs)

function fetchUserMetadataByUsername(username, includeOrgs)

function fetchBatchUserMetadataByUserIds(userIds, includeOrgs)

{
    "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",

        properties: {
            // Arbitrary key-value pairs
            "key1": "value1",
            "key2": "value2",
        }
    },
    // other user_ids
}

function fetchBatchUserMetadataByEmails(emails, includeOrgs)

function fetchBatchUserMetadataByUsernames(usernames, includeOrgs)

function fetchUsersByQuery(usersQuery)

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

function fetchOrg(orgId)

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

function fetchOrgsByQuery(orgQuery)

{
    "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
    }]
}

function fetchUsersInOrg(usersInOrgQuery)

{
    "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
    }]
}

function createUser(createUserRequest)

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

// Returns true if it was successful, false if the user was not found
function updateUserEmailWrapper(userId, updateUserEmailRequest)

// Returns true if it was successful, false if the user was not found
function updateUserMetadata(userId, updateUserMetadataRequest)

// Returns true if it was successful, false if the user was not found
function updateUserPassword(userId, updateUserPasswordRequest)

function deleteUser(userId)

function disableUser(userId)

function enableUser(userId)

function migrateUserFromExternalSource(migrateUserFromExternalSourceRequest)

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

function createMagicLink(createUserRequest)

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

function createAccessToken(createAccessTokenRequest)

{
    "access_token": "..."
}

function enableUserCanCreateOrgs(userId)

function disableUserCanCreateOrgs(userId)

function createOrg(createOrgRequest)

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

function addUserToOrg(addUserToOrgRequest)

function allowOrgToSetupSamlConnection(orgId)

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

// Returns true if it was successful, false if the user was not found
function updateOrg(updateOrgRequest)

function validatePersonalApiKey(apiKeyToken)

{

   "user":{
      "userId":"98cef184-7c15-45c5-8918-8c2295aa7ffe",
      "email":"test@propelauth.com",
      //...
   },
    "metadata":{},
}

function validateOrgApiKey(apiKeyToken)

function validateApiKey(apiKeyToken)

function fetchApiKey(apiKeyId)

function fetchCurrentApiKeys(apiKeyRequest)

function fetchArchivedApiKeys(apiKeyRequest)

function createApiKey(createApiKeyRequest)

function updateApiKey(apiKeyId, updateApiKeyRequest)

function deleteApiKey(apiKeyId)