New apis april 2026 (#43)

* new apis

* new-apis

* Update magicLink.ts

Author: pfvatterott

package.json

@@ -4,7 +4,7 @@
         "type": "git",
         "url": "https://github.com/PropelAuth/node-apis"
     },
-    "version": "2.1.34",
+    "version": "2.1.35",
     "license": "MIT",
     "keywords": [
         "auth",

src/api.ts

@@ -16,23 +16,15 @@ import {
     importApiKey,
     ApiKeysImportRequest,
     ApiKeysImportResponse,
-    validateImportedApiKey
+    validateImportedApiKey,
 } from "./api/endUserApiKeys"
 import {
     StepUpMfaVerifyTotpResponse,
     VerifyTotpChallengeRequest,
     verifyStepUpTotpChallenge,
 } from "./api/mfa/verifyTotp"
-import {
-    sendSmsMfaCode,
-    SendSmsMfaCodeRequestResponse,
-    SendSmsMfaCodeRequest
-} from "./api/mfa/sendSmsMfaCode"
-import {
-    verifySmsChallenge,
-    VerifySmsChallengeRequest,
-    VerifySmsChallengeResponse
-} from "./api/mfa/verifySmsChallenge"
+import { sendSmsMfaCode, SendSmsMfaCodeRequestResponse, SendSmsMfaCodeRequest } from "./api/mfa/sendSmsMfaCode"
+import { verifySmsChallenge, VerifySmsChallengeRequest, VerifySmsChallengeResponse } from "./api/mfa/verifySmsChallenge"
 import { StepUpMfaVerifyGrantResponse, VerifyStepUpGrantRequest, verifyStepUpGrant } from "./api/mfa/verifyGrant"
 import { createMagicLink, CreateMagicLinkRequest, MagicLink } from "./api/magicLink"
 import { fetchEmployeeById, Employee } from "./api/employee"
@@ -70,6 +62,8 @@ import {
     revokePendingOrgInvite,
     RevokePendingOrgInviteRequest,
     samlGoLive,
+    setOidcIdpMetadata,
+    SetOidcIdpMetadataRequest,
     setSamlIdpMetadata,
     SetSamlIdpMetadataRequest,
     subscribeOrgToRoleMapping,
@@ -114,7 +108,9 @@ import {
     MfaPhoneType,
     MfaPhones,
     MfaTotpType,
-    FetchUserMfaMethodsResponse
+    FetchUserMfaMethodsResponse,
+    fetchFreshTokenFromProvider,
+    fetchUserOAuthTokens,
 } from "./api/user"
 import { CustomRoleMappings } from "./customRoleMappings"
 import {
@@ -127,8 +123,13 @@ import {
     Organization,
     OrgApiKeyValidation,
     PersonalApiKeyValidation,
+    SocialLoginToken,
+    SocialLoginTokenProvider,
+    SocialLoginTokensResponse,
     UserMetadata,
 } from "./user"
+import { ScimGroup, ScimGroupResultPage, FetchOrgScimGroupsRequest, FetchScimGroupRequest } from "./scim"
+import { fetchScimGroup, fetchOrgScimGroups } from "./api/scim"
 import { validateOrgApiKey, validatePersonalApiKey } from "./validators"
 
 export function getApis(authUrl: URL, integrationApiKey: string) {
@@ -270,6 +271,17 @@ export function getApis(authUrl: URL, integrationApiKey: string) {
         return enableUserCanCreateOrgs(authUrl, integrationApiKey, userId)
     }
 
+    function fetchUserOAuthTokensWrapper(userId: string): Promise<SocialLoginTokensResponse | null> {
+        return fetchUserOAuthTokens(authUrl, integrationApiKey, userId)
+    }
+
+    function fetchFreshTokenFromProviderWrapper(
+        userId: string,
+        provider: SocialLoginTokenProvider
+    ): Promise<SocialLoginToken | null> {
+        return fetchFreshTokenFromProvider(authUrl, integrationApiKey, userId, provider)
+    }
+
     function disableUserCanCreateOrgsWrapper(userId: string): Promise<boolean> {
         return disableUserCanCreateOrgs(authUrl, integrationApiKey, userId)
     }
@@ -347,6 +359,10 @@ export function getApis(authUrl: URL, integrationApiKey: string) {
         return setSamlIdpMetadata(authUrl, integrationApiKey, orgId, samlIdpMetadata)
     }
 
+    function setOidcIdpMetadataWrapper(setOidcIdpMetadataRequest: SetOidcIdpMetadataRequest): Promise<boolean> {
+        return setOidcIdpMetadata(authUrl, integrationApiKey, setOidcIdpMetadataRequest)
+    }
+
     function samlGoLiveWrapper(orgId: string): Promise<boolean> {
         return samlGoLive(authUrl, integrationApiKey, orgId)
     }
@@ -359,7 +375,9 @@ export function getApis(authUrl: URL, integrationApiKey: string) {
         return inviteUserToOrg(authUrl, integrationApiKey, inviteUserToOrgRequest)
     }
 
-    function inviteUserToOrgByUserIdWrapper(inviteUserToOrgByUserIdRequest: InviteUserToOrgByUserIdRequest): Promise<boolean> {
+    function inviteUserToOrgByUserIdWrapper(
+        inviteUserToOrgByUserIdRequest: InviteUserToOrgByUserIdRequest
+    ): Promise<boolean> {
         return inviteUserToOrgByUserId(authUrl, integrationApiKey, inviteUserToOrgByUserIdRequest)
     }
 
@@ -426,27 +444,19 @@ export function getApis(authUrl: URL, integrationApiKey: string) {
         return verifyStepUpGrant(authUrl, integrationApiKey, verifyStepUpGrantRequest)
     }
 
-    function fetchApiKeyUsageWrapper(
-        apiKeyUsageQuery: ApiKeyUsageQueryRequest
-    ): Promise<ApiKeyUsageQueryResponse> {
+    function fetchApiKeyUsageWrapper(apiKeyUsageQuery: ApiKeyUsageQueryRequest): Promise<ApiKeyUsageQueryResponse> {
         return fetchApiKeyUsage(authUrl, integrationApiKey, apiKeyUsageQuery)
     }
 
-    function importApiKeyWrapper(
-        apiKeysImportRequest: ApiKeysImportRequest
-    ): Promise<ApiKeysImportResponse> {
+    function importApiKeyWrapper(apiKeysImportRequest: ApiKeysImportRequest): Promise<ApiKeysImportResponse> {
         return importApiKey(authUrl, integrationApiKey, apiKeysImportRequest)
     }
 
-    function validateImportedApiKeyWrapper(
-        apiKeyToken: string
-    ): Promise<ApiKeyValidation> {
+    function validateImportedApiKeyWrapper(apiKeyToken: string): Promise<ApiKeyValidation> {
         return validateImportedApiKey(authUrl, integrationApiKey, apiKeyToken)
     }
 
-    function fetchUserMfaMethodsWrapper(
-        userId: string
-    ): Promise<FetchUserMfaMethodsResponse | null> {
+    function fetchUserMfaMethodsWrapper(userId: string): Promise<FetchUserMfaMethodsResponse | null> {
         return fetchUserMfaMethods(authUrl, integrationApiKey, userId)
     }
 
@@ -462,6 +472,16 @@ export function getApis(authUrl: URL, integrationApiKey: string) {
         return verifySmsChallenge(authUrl, integrationApiKey, verifySmsChallengeRequest)
     }
 
+    function fetchScimGroupWrapper(fetchScimGroupRequest: FetchScimGroupRequest): Promise<ScimGroup> {
+        return fetchScimGroup(authUrl, integrationApiKey, fetchScimGroupRequest)
+    }
+
+    function fetchOrgScimGroupsWrapper(
+        fetchOrgScimGroupsRequest: FetchOrgScimGroupsRequest
+    ): Promise<ScimGroupResultPage> {
+        return fetchOrgScimGroups(authUrl, integrationApiKey, fetchOrgScimGroupsRequest)
+    }
+
     return {
         // fetching functions
         fetchTokenVerificationMetadata: fetchTokenVerificationMetadataWrapper,
@@ -497,6 +517,8 @@ export function getApis(authUrl: URL, integrationApiKey: string) {
         disableUserCanCreateOrgs: disableUserCanCreateOrgsWrapper,
         logoutAllUserSessions: logoutAllUserSessionsWrapper,
         fetchUserMfaMethods: fetchUserMfaMethodsWrapper,
+        fetchUserOAuthTokens: fetchUserOAuthTokensWrapper,
+        fetchFreshTokenFromProvider: fetchFreshTokenFromProviderWrapper,
         // org management functions
         createOrg: createOrgWrapper,
         addUserToOrg: addUserToOrgWrapper,
@@ -514,6 +536,7 @@ export function getApis(authUrl: URL, integrationApiKey: string) {
         revokePendingOrgInvite: revokePendingOrgInviteWrapper,
         fetchSamlSpMetadata: fetchSamlSpMetadataWrapper,
         setSamlIdpMetadata: setSamlIdpMetadataWrapper,
+        setOidcIdpMetadata: setOidcIdpMetadataWrapper,
         samlGoLive: samlGoLiveWrapper,
         deleteSamlConnection: deleteSamlConnectionWrapper,
         // api keys functions
@@ -536,5 +559,8 @@ export function getApis(authUrl: URL, integrationApiKey: string) {
         verifySmsChallenge: verifySmsChallengeWrapper,
         // employee functions
         fetchEmployeeById: fetchEmployeeByIdWrapper,
+        // scim functions
+        fetchScimGroup: fetchScimGroupWrapper,
+        fetchOrgScimGroups: fetchOrgScimGroupsWrapper,
     }
 }

src/api/endUserApiKeys.ts

@@ -109,6 +109,7 @@ export type ApiKeysCreateRequest = {
     userId?: string
     expiresAtSeconds?: number
     metadata?: object
+    displayName?: string
 }
 
 export function createApiKey(
@@ -121,6 +122,7 @@ export function createApiKey(
         user_id: apiKeyCreate.userId,
         expires_at_seconds: apiKeyCreate.expiresAtSeconds,
         metadata: apiKeyCreate.metadata,
+        display_name: apiKeyCreate.displayName,
     }
 
     return httpRequest(authUrl, integrationApiKey, `${ENDPOINT_PATH}`, "POST", JSON.stringify(request)).then(
@@ -178,6 +180,7 @@ export type ApiKeysImportRequest = {
     userId?: string
     expiresAtSeconds?: number
     metadata?: object
+    displayName?: string
 }
 
 export type ApiKeysImportResponse = {
@@ -195,6 +198,7 @@ export function importApiKey(
         user_id: apiKeyImport.userId,
         expires_at_seconds: apiKeyImport.expiresAtSeconds,
         metadata: apiKeyImport.metadata,
+        display_name: apiKeyImport.displayName,
     }
 
     return httpRequest(authUrl, integrationApiKey, `${ENDPOINT_PATH}/import`, "POST", JSON.stringify(request)).then(

src/api/magicLink.ts

@@ -9,6 +9,8 @@ export type CreateMagicLinkRequest = {
     expiresInHours?: number
     createNewUserIfOneDoesntExist?: boolean
     expiresAfterFirstUse?: boolean
+    requiresInterstitial?: boolean
+    userSignupQueryParameters?: { [key: string]: string }
 }
 
 export type MagicLink = {
@@ -27,6 +29,8 @@ export function createMagicLink(
         expires_in_hours: createMagicLinkRequest.expiresInHours,
         create_new_user_if_one_doesnt_exist: createMagicLinkRequest.createNewUserIfOneDoesntExist,
         expire_after_first_use: createMagicLinkRequest.expiresAfterFirstUse,
+        requires_interstitial: createMagicLinkRequest.requiresInterstitial,
+        user_signup_query_parameters: createMagicLinkRequest.userSignupQueryParameters,
     }
     return httpRequest(authUrl, integrationApiKey, ENDPOINT_PATH, "POST", JSON.stringify(request)).then(
         (httpResponse) => {