@descope/node-sdk 2.11.0 → 2.12.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/index.cjs.js +1 -1
- package/dist/cjs/index.cjs.js.map +1 -1
- package/dist/index.d.ts +308 -1
- package/dist/index.esm.js +1 -1
- package/dist/index.esm.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -315,6 +315,9 @@ declare type SSOApplication = {
|
|
|
315
315
|
oidcSettings: SSOApplicationOIDCSettings;
|
|
316
316
|
wsfedSettings?: SSOApplicationWSFedSettings;
|
|
317
317
|
};
|
|
318
|
+
declare type SSOApplicationSecretResponse = {
|
|
319
|
+
cleartext: string;
|
|
320
|
+
};
|
|
318
321
|
/** Represents a permission in a project. It has a name and optionally a description.
|
|
319
322
|
* It also has a flag indicating whether it is system default or not.
|
|
320
323
|
*/
|
|
@@ -333,6 +336,8 @@ declare type Role = {
|
|
|
333
336
|
createdTime: number;
|
|
334
337
|
tenantId?: string;
|
|
335
338
|
default?: boolean;
|
|
339
|
+
private?: boolean;
|
|
340
|
+
id?: string;
|
|
336
341
|
};
|
|
337
342
|
/** Search roles based on the parameters */
|
|
338
343
|
declare type RoleSearchOptions = {
|
|
@@ -659,6 +664,44 @@ declare type AuditRecord = {
|
|
|
659
664
|
tenants: string[];
|
|
660
665
|
data: Record<string, any>;
|
|
661
666
|
};
|
|
667
|
+
/** Response for the searchAll audit method, including the total number of matching records. */
|
|
668
|
+
declare type AuditSearchAllResponse = {
|
|
669
|
+
audits: AuditRecord[];
|
|
670
|
+
total: number;
|
|
671
|
+
};
|
|
672
|
+
/** Basic authentication for an HTTP connector. */
|
|
673
|
+
declare type ConnectorHTTPBasicAuthentication = {
|
|
674
|
+
username?: string;
|
|
675
|
+
password?: string;
|
|
676
|
+
};
|
|
677
|
+
/** API key authentication for an HTTP connector. */
|
|
678
|
+
declare type ConnectorHTTPAPIKeyAuthentication = {
|
|
679
|
+
key?: string;
|
|
680
|
+
token?: string;
|
|
681
|
+
};
|
|
682
|
+
/** Authentication configuration for an HTTP connector. */
|
|
683
|
+
declare type ConnectorHTTPAuthentication = {
|
|
684
|
+
bearerToken?: string;
|
|
685
|
+
basic?: ConnectorHTTPBasicAuthentication;
|
|
686
|
+
apiKey?: ConnectorHTTPAPIKeyAuthentication;
|
|
687
|
+
};
|
|
688
|
+
/** Filters that determine which audit events are streamed by an audit webhook. */
|
|
689
|
+
declare type AuditFilters = {
|
|
690
|
+
key?: string;
|
|
691
|
+
operator?: string;
|
|
692
|
+
values?: string[];
|
|
693
|
+
};
|
|
694
|
+
/** Configuration for an audit webhook connector. */
|
|
695
|
+
declare type AuditWebhook = {
|
|
696
|
+
name: string;
|
|
697
|
+
description?: string;
|
|
698
|
+
url?: string;
|
|
699
|
+
authentication?: ConnectorHTTPAuthentication;
|
|
700
|
+
hmacSecret?: string;
|
|
701
|
+
headers?: Record<string, string>;
|
|
702
|
+
insecure?: boolean;
|
|
703
|
+
filters?: AuditFilters[];
|
|
704
|
+
};
|
|
662
705
|
declare type UserStatus = 'enabled' | 'disabled' | 'invited' | 'expired';
|
|
663
706
|
declare type AuthzNodeExpressionType = 'self' | 'targetSet' | 'relationLeft' | 'relationRight';
|
|
664
707
|
/**
|
|
@@ -837,6 +880,31 @@ interface FGAResourceDetails {
|
|
|
837
880
|
resourceType: string;
|
|
838
881
|
displayName: string;
|
|
839
882
|
}
|
|
883
|
+
declare type FGASchemaDryRunResponse = {
|
|
884
|
+
deletesPreview?: {
|
|
885
|
+
hasDeletes: boolean;
|
|
886
|
+
relations?: string[];
|
|
887
|
+
types?: string[];
|
|
888
|
+
};
|
|
889
|
+
};
|
|
890
|
+
declare type FGAMappableResource = {
|
|
891
|
+
resource: string;
|
|
892
|
+
};
|
|
893
|
+
declare type FGAMappableResources = {
|
|
894
|
+
type: string;
|
|
895
|
+
resources: FGAMappableResource[];
|
|
896
|
+
};
|
|
897
|
+
declare type FGAMappableSchema = {
|
|
898
|
+
schema?: AuthzSchema | null;
|
|
899
|
+
mappableResources?: FGAMappableResources[];
|
|
900
|
+
};
|
|
901
|
+
declare type FGAMappableResourcesQuery = {
|
|
902
|
+
type: string;
|
|
903
|
+
queries: string[];
|
|
904
|
+
};
|
|
905
|
+
declare type FGAMappableResourcesOptions = {
|
|
906
|
+
resourcesLimit?: number;
|
|
907
|
+
};
|
|
840
908
|
/**
|
|
841
909
|
* Configuration for FGA cache proxy support.
|
|
842
910
|
* When fgaCacheUrl is provided along with managementKey, certain FGA operations
|
|
@@ -932,6 +1000,11 @@ declare type InboundApplicationConsentDeleteOptions = {
|
|
|
932
1000
|
appId?: string;
|
|
933
1001
|
userIds?: string[];
|
|
934
1002
|
};
|
|
1003
|
+
declare type InboundApplicationTenantConsentDeleteOptions = {
|
|
1004
|
+
consentIds?: string[];
|
|
1005
|
+
appId?: string;
|
|
1006
|
+
tenantId?: string;
|
|
1007
|
+
};
|
|
935
1008
|
declare type PromptType = 'none' | 'login' | 'consent' | 'select_account';
|
|
936
1009
|
declare type AccessType = 'offline' | 'online';
|
|
937
1010
|
declare type OutboundApplication = {
|
|
@@ -1173,6 +1246,161 @@ declare type Engine = {
|
|
|
1173
1246
|
declare type EngineSecretResponse = {
|
|
1174
1247
|
secret: string;
|
|
1175
1248
|
};
|
|
1249
|
+
/** A single option for a custom attribute of type "select". */
|
|
1250
|
+
declare type CustomAttributeOption = {
|
|
1251
|
+
value?: string;
|
|
1252
|
+
label?: string;
|
|
1253
|
+
};
|
|
1254
|
+
/** Represents a custom attribute definition in the project schema. */
|
|
1255
|
+
declare type CustomAttribute = {
|
|
1256
|
+
name?: string;
|
|
1257
|
+
type?: number;
|
|
1258
|
+
options?: CustomAttributeOption[];
|
|
1259
|
+
displayName?: string;
|
|
1260
|
+
defaultValue?: any;
|
|
1261
|
+
viewPermissions?: string[];
|
|
1262
|
+
editPermissions?: string[];
|
|
1263
|
+
};
|
|
1264
|
+
/** A registered passkey (WebAuthn credential) for a user. */
|
|
1265
|
+
declare type UserPasskey = {
|
|
1266
|
+
id?: string;
|
|
1267
|
+
rpId?: string;
|
|
1268
|
+
kind?: string;
|
|
1269
|
+
displayName?: string;
|
|
1270
|
+
createdTime?: number;
|
|
1271
|
+
};
|
|
1272
|
+
/** A trusted device associated with a user. */
|
|
1273
|
+
declare type UserTrustedDevice = {
|
|
1274
|
+
id?: string;
|
|
1275
|
+
name?: string;
|
|
1276
|
+
deviceType?: string;
|
|
1277
|
+
lastLoginTime?: number;
|
|
1278
|
+
expirationTime?: number;
|
|
1279
|
+
lastLocation?: string;
|
|
1280
|
+
};
|
|
1281
|
+
/** A single failure entry returned from a user import. */
|
|
1282
|
+
declare type UserImportFailure = {
|
|
1283
|
+
user: string;
|
|
1284
|
+
reason: string;
|
|
1285
|
+
};
|
|
1286
|
+
/** Response of a user import operation. */
|
|
1287
|
+
declare type UserImportResponse = {
|
|
1288
|
+
users?: UserResponse[];
|
|
1289
|
+
failures?: UserImportFailure[];
|
|
1290
|
+
};
|
|
1291
|
+
/** Request to update an existing permission by its ID as part of a batch update. */
|
|
1292
|
+
declare type PermissionUpdateRequest = {
|
|
1293
|
+
id: string;
|
|
1294
|
+
newName: string;
|
|
1295
|
+
description?: string;
|
|
1296
|
+
};
|
|
1297
|
+
/** Request to update an existing role by its ID as part of a batch update. */
|
|
1298
|
+
declare type RoleUpdateRequest = {
|
|
1299
|
+
id: string;
|
|
1300
|
+
newName: string;
|
|
1301
|
+
description?: string;
|
|
1302
|
+
permissionNames?: string[];
|
|
1303
|
+
tenantId?: string;
|
|
1304
|
+
default?: boolean;
|
|
1305
|
+
};
|
|
1306
|
+
/** The type of a project list (currently "ip" or "text"). */
|
|
1307
|
+
declare type ListType = string;
|
|
1308
|
+
/** Represents a project list of IPs or texts. */
|
|
1309
|
+
declare type List = {
|
|
1310
|
+
id?: string;
|
|
1311
|
+
name?: string;
|
|
1312
|
+
description?: string;
|
|
1313
|
+
type?: ListType;
|
|
1314
|
+
data?: any;
|
|
1315
|
+
};
|
|
1316
|
+
/** Request payload for creating or updating a list. */
|
|
1317
|
+
declare type ListRequest = {
|
|
1318
|
+
name: string;
|
|
1319
|
+
description?: string;
|
|
1320
|
+
type: ListType;
|
|
1321
|
+
data?: any;
|
|
1322
|
+
};
|
|
1323
|
+
/** Represents a JWT template configuration. */
|
|
1324
|
+
declare type JWTTemplate = {
|
|
1325
|
+
id?: string;
|
|
1326
|
+
name?: string;
|
|
1327
|
+
description?: string;
|
|
1328
|
+
template?: Record<string, any>;
|
|
1329
|
+
source?: string;
|
|
1330
|
+
tags?: string[];
|
|
1331
|
+
authSchema?: string;
|
|
1332
|
+
type?: string;
|
|
1333
|
+
conformanceIssuer?: boolean;
|
|
1334
|
+
autoDCT?: boolean;
|
|
1335
|
+
enforceIssuer?: boolean;
|
|
1336
|
+
emptyClaimPolicy?: string;
|
|
1337
|
+
overrideSubject?: boolean;
|
|
1338
|
+
issuerType?: string;
|
|
1339
|
+
omitCustomClaimsFromDSR?: boolean;
|
|
1340
|
+
addJti?: boolean;
|
|
1341
|
+
excludePermissions?: boolean;
|
|
1342
|
+
};
|
|
1343
|
+
/** A single validation issue found while validating a JWT template. */
|
|
1344
|
+
declare type JWTTemplateValidationIssue = {
|
|
1345
|
+
message?: string;
|
|
1346
|
+
severity?: string;
|
|
1347
|
+
path?: string;
|
|
1348
|
+
};
|
|
1349
|
+
/** Result of validating a JWT template. */
|
|
1350
|
+
declare type JWTTemplateValidationResult = {
|
|
1351
|
+
valid: boolean;
|
|
1352
|
+
issues?: JWTTemplateValidationIssue[];
|
|
1353
|
+
};
|
|
1354
|
+
/** A JWT template entry available in the shared template library. */
|
|
1355
|
+
declare type JWTTemplateLibraryEntry = JWTTemplate & {
|
|
1356
|
+
experimental?: boolean;
|
|
1357
|
+
logoLight?: string;
|
|
1358
|
+
logoDark?: string;
|
|
1359
|
+
};
|
|
1360
|
+
/** Request payload for applying a JWT template from the library. */
|
|
1361
|
+
declare type ApplyJWTTemplateFromLibraryRequest = {
|
|
1362
|
+
libraryEntryId: string;
|
|
1363
|
+
nameOverride?: string;
|
|
1364
|
+
descriptionOverride?: string;
|
|
1365
|
+
tagsOverride?: string[];
|
|
1366
|
+
templateOverride?: Record<string, any>;
|
|
1367
|
+
};
|
|
1368
|
+
/** A single scope-to-claims mapping entry. */
|
|
1369
|
+
declare type ScopeClaimMappingEntry = {
|
|
1370
|
+
scope?: string;
|
|
1371
|
+
claims?: Record<string, string>;
|
|
1372
|
+
description?: string;
|
|
1373
|
+
};
|
|
1374
|
+
/** Options for searching analytics records. Time fields are epoch milliseconds. */
|
|
1375
|
+
declare type AnalyticsSearchOptions = {
|
|
1376
|
+
actions?: string[];
|
|
1377
|
+
excludedActions?: string[];
|
|
1378
|
+
from?: number;
|
|
1379
|
+
to?: number;
|
|
1380
|
+
devices?: string[];
|
|
1381
|
+
methods?: string[];
|
|
1382
|
+
geos?: string[];
|
|
1383
|
+
tenants?: string[];
|
|
1384
|
+
groupByAction?: boolean;
|
|
1385
|
+
groupByDevice?: boolean;
|
|
1386
|
+
groupByMethod?: boolean;
|
|
1387
|
+
groupByGeo?: boolean;
|
|
1388
|
+
groupByTenant?: boolean;
|
|
1389
|
+
groupByReferrer?: boolean;
|
|
1390
|
+
groupByCreated?: string;
|
|
1391
|
+
};
|
|
1392
|
+
/** A single analytics record returned from an analytics search. */
|
|
1393
|
+
declare type AnalyticRecord = {
|
|
1394
|
+
projectId?: string;
|
|
1395
|
+
action?: string;
|
|
1396
|
+
created?: string;
|
|
1397
|
+
device?: string;
|
|
1398
|
+
method?: string;
|
|
1399
|
+
geo?: string;
|
|
1400
|
+
tenant?: string;
|
|
1401
|
+
referrer?: string;
|
|
1402
|
+
cnt?: string;
|
|
1403
|
+
};
|
|
1176
1404
|
|
|
1177
1405
|
interface PatchUserOptions {
|
|
1178
1406
|
email?: string;
|
|
@@ -1362,10 +1590,22 @@ declare const nodeSdk: {
|
|
|
1362
1590
|
removeAllPasskeys: (loginId: string) => Promise<SdkResponse<never>>;
|
|
1363
1591
|
removeTOTPSeed: (loginId: string) => Promise<SdkResponse<never>>;
|
|
1364
1592
|
history: (userIds: string[]) => Promise<SdkResponse<_descope_core_js_sdk.UserHistoryResponse[]>>;
|
|
1593
|
+
import: (source: string, users?: string | Uint8Array, hashes?: string | Uint8Array, dryrun?: boolean) => Promise<SdkResponse<UserImportResponse>>;
|
|
1594
|
+
updateRecoveryEmail: (loginIdOrUserId: string, email: string, isVerified?: boolean) => Promise<SdkResponse<_descope_core_js_sdk.UserResponse>>;
|
|
1595
|
+
updateRecoveryPhone: (loginIdOrUserId: string, phone: string, isVerified?: boolean) => Promise<SdkResponse<_descope_core_js_sdk.UserResponse>>;
|
|
1596
|
+
updateUserNames: (loginIdOrUserId: string, givenName?: string, middleName?: string, familyName?: string) => Promise<SdkResponse<_descope_core_js_sdk.UserResponse>>;
|
|
1597
|
+
getCustomAttributes: () => Promise<SdkResponse<CustomAttribute[]>>;
|
|
1598
|
+
createCustomAttributes: (attributes: CustomAttribute[]) => Promise<SdkResponse<CustomAttribute[]>>;
|
|
1599
|
+
deleteCustomAttributes: (names: string[]) => Promise<SdkResponse<CustomAttribute[]>>;
|
|
1600
|
+
removePasskey: (loginId: string, credentialId: string) => Promise<SdkResponse<never>>;
|
|
1601
|
+
listPasskeys: (loginId: string) => Promise<SdkResponse<UserPasskey[]>>;
|
|
1602
|
+
listTrustedDevices: (loginIdsOrUserIds: string[]) => Promise<SdkResponse<UserTrustedDevice[]>>;
|
|
1603
|
+
removeTrustedDevices: (loginIdOrUserId: string, deviceIds: string[]) => Promise<SdkResponse<never>>;
|
|
1365
1604
|
};
|
|
1366
1605
|
project: {
|
|
1367
1606
|
updateName: (name: string) => Promise<SdkResponse<never>>;
|
|
1368
1607
|
updateTags: (tags: string[]) => Promise<SdkResponse<never>>;
|
|
1608
|
+
delete: () => Promise<SdkResponse<never>>;
|
|
1369
1609
|
clone: (name: string, environment?: "production", tags?: string[]) => Promise<SdkResponse<CloneProjectResponse>>;
|
|
1370
1610
|
listProjects: () => Promise<SdkResponse<Project[]>>;
|
|
1371
1611
|
exportSnapshot: () => Promise<SdkResponse<ExportSnapshotResponse>>;
|
|
@@ -1380,8 +1620,12 @@ declare const nodeSdk: {
|
|
|
1380
1620
|
searchAll: (tenantIds?: string[], boundUserId?: string, creatingUser?: string, customAttributes?: Record<string, any>) => Promise<SdkResponse<AccessKey[]>>;
|
|
1381
1621
|
update: (id: string, name: string, description?: string, roles?: string[], tenants?: AssociatedTenant[], customClaims?: Record<string, any>, permittedIps?: string[], customAttributes?: Record<string, any>) => Promise<SdkResponse<AccessKey>>;
|
|
1382
1622
|
deactivate: (id: string) => Promise<SdkResponse<never>>;
|
|
1623
|
+
deactivateBatch: (ids: string[]) => Promise<SdkResponse<never>>;
|
|
1383
1624
|
activate: (id: string) => Promise<SdkResponse<never>>;
|
|
1625
|
+
activateBatch: (ids: string[]) => Promise<SdkResponse<never>>;
|
|
1384
1626
|
delete: (id: string) => Promise<SdkResponse<never>>;
|
|
1627
|
+
deleteBatch: (ids: string[]) => Promise<SdkResponse<never>>;
|
|
1628
|
+
rotate: (id: string) => Promise<SdkResponse<CreatedAccessKeyResponse>>;
|
|
1385
1629
|
};
|
|
1386
1630
|
tenant: {
|
|
1387
1631
|
create: (name: string, selfProvisioningDomains?: string[], customAttributes?: Record<string, AttributesTypes>, enforceSSO?: boolean, disabled?: boolean, parent?: string, roleInheritance?: "" | "none" | "userOnly") => Promise<SdkResponse<CreateTenantResponse>>;
|
|
@@ -1395,6 +1639,7 @@ declare const nodeSdk: {
|
|
|
1395
1639
|
getSettings: (tenantId: string) => Promise<SdkResponse<TenantSettings>>;
|
|
1396
1640
|
configureSettings: (tenantId: string, settings: TenantSettings) => Promise<SdkResponse<never>>;
|
|
1397
1641
|
generateSSOConfigurationLink: (tenantId: string, expireDuration: number, ssoId?: string, email?: string, templateId?: string, actorId?: string) => Promise<SdkResponse<GenerateSSOConfigurationLinkResponse>>;
|
|
1642
|
+
revokeSSOConfigurationLink: (tenantId: string, ssoId?: string) => Promise<SdkResponse<never>>;
|
|
1398
1643
|
};
|
|
1399
1644
|
ssoApplication: {
|
|
1400
1645
|
createOidcApplication: (options: OidcApplicationOptions) => Promise<SdkResponse<CreateSSOApplicationResponse>>;
|
|
@@ -1412,6 +1657,8 @@ declare const nodeSdk: {
|
|
|
1412
1657
|
delete: (id: string) => Promise<SdkResponse<never>>;
|
|
1413
1658
|
load: (id: string) => Promise<SdkResponse<SSOApplication>>;
|
|
1414
1659
|
loadAll: () => Promise<SdkResponse<SSOApplication[]>>;
|
|
1660
|
+
getApplicationSecret: (id: string) => Promise<SdkResponse<SSOApplicationSecretResponse>>;
|
|
1661
|
+
rotateApplicationSecret: (id: string) => Promise<SdkResponse<SSOApplicationSecretResponse>>;
|
|
1415
1662
|
};
|
|
1416
1663
|
inboundApplication: {
|
|
1417
1664
|
createApplication: (options: InboundApplicationOptions) => Promise<SdkResponse<CreateInboundApplicationResponse>>;
|
|
@@ -1422,12 +1669,14 @@ declare const nodeSdk: {
|
|
|
1422
1669
|
id: string;
|
|
1423
1670
|
}) => Promise<SdkResponse<never>>;
|
|
1424
1671
|
deleteApplication: (id: string) => Promise<SdkResponse<never>>;
|
|
1672
|
+
deleteApplicationBatch: (ids: string[]) => Promise<SdkResponse<never>>;
|
|
1425
1673
|
loadApplication: (id: string) => Promise<SdkResponse<InboundApplication>>;
|
|
1426
1674
|
loadAllApplications: () => Promise<SdkResponse<InboundApplication[]>>;
|
|
1427
1675
|
getApplicationSecret: (id: string) => Promise<SdkResponse<InboundApplicationSecretResponse>>;
|
|
1428
1676
|
rotateApplicationSecret: (id: string) => Promise<SdkResponse<never>>;
|
|
1429
1677
|
searchConsents: (options?: InboundApplicationConsentSearchOptions) => Promise<SdkResponse<InboundApplicationConsent[]>>;
|
|
1430
1678
|
deleteConsents: (options: InboundApplicationConsentDeleteOptions) => Promise<SdkResponse<never>>;
|
|
1679
|
+
deleteTenantConsents: (options: InboundApplicationTenantConsentDeleteOptions) => Promise<SdkResponse<never>>;
|
|
1431
1680
|
};
|
|
1432
1681
|
outboundApplication: {
|
|
1433
1682
|
createApplication: (app: Omit<OutboundApplication, "id"> & Partial<Pick<OutboundApplication, "id">> & {
|
|
@@ -1464,12 +1713,15 @@ declare const nodeSdk: {
|
|
|
1464
1713
|
configureOIDCSettings: (tenantId: string, settings: SSOOIDCSettings, domains?: string[], ssoId?: string) => Promise<SdkResponse<never>>;
|
|
1465
1714
|
configureSAMLSettings: (tenantId: string, settings: SSOSAMLSettings, redirectUrl?: string, domains?: string[], ssoId?: string) => Promise<SdkResponse<never>>;
|
|
1466
1715
|
configureSAMLByMetadata: (tenantId: string, settings: SSOSAMLByMetadataSettings, redirectUrl?: string, domains?: string[], ssoId?: string) => Promise<SdkResponse<never>>;
|
|
1716
|
+
configureSSORedirectURL: (tenantId: string, samlRedirectUrl?: string, oauthRedirectUrl?: string, ssoId?: string) => Promise<SdkResponse<never>>;
|
|
1717
|
+
recalculateSSOMappings: (tenantId: string, ssoId?: string) => Promise<SdkResponse<never>>;
|
|
1467
1718
|
loadSettings: (tenantId: string, ssoId?: string) => Promise<SdkResponse<SSOSettings>>;
|
|
1468
1719
|
loadAllSettings: (tenantId: string) => Promise<SdkResponse<SSOSettings[]>>;
|
|
1469
1720
|
};
|
|
1470
1721
|
jwt: {
|
|
1471
1722
|
update: (jwt: string, customClaims?: Record<string, any>, refreshDuration?: number) => Promise<SdkResponse<UpdateJWTResponse>>;
|
|
1472
1723
|
impersonate: (impersonatorId: string, loginId: string, validateConsent: boolean, customClaims?: Record<string, any>, selectedTenant?: string, refreshDuration?: number) => Promise<SdkResponse<UpdateJWTResponse>>;
|
|
1724
|
+
impersonateStepup: (impersonatorId: string, loginId: string, validateConsent: boolean, customClaims?: Record<string, any>, selectedTenant?: string, refreshDuration?: number) => Promise<SdkResponse<UpdateJWTResponse>>;
|
|
1473
1725
|
stopImpersonation: (jwt: string, customClaims?: Record<string, any>, selectedTenant?: string, refreshDuration?: number) => Promise<SdkResponse<UpdateJWTResponse>>;
|
|
1474
1726
|
signIn: (loginId: string, loginOptions?: MgmtLoginOptions) => Promise<SdkResponse<JWTResponse>>;
|
|
1475
1727
|
signUp: (loginId: string, user?: MgmtUserOptions, signUpOptions?: MgmtSignUpOptions) => Promise<SdkResponse<JWTResponse>>;
|
|
@@ -1491,8 +1743,13 @@ declare const nodeSdk: {
|
|
|
1491
1743
|
};
|
|
1492
1744
|
permission: {
|
|
1493
1745
|
create: (name: string, description?: string) => Promise<SdkResponse<never>>;
|
|
1746
|
+
createBatch: (permissions: Permission[]) => Promise<SdkResponse<never>>;
|
|
1494
1747
|
update: (name: string, newName: string, description?: string) => Promise<SdkResponse<never>>;
|
|
1748
|
+
updateWithId: (id: string, newName: string, description?: string) => Promise<SdkResponse<never>>;
|
|
1749
|
+
updateBatch: (permissions: PermissionUpdateRequest[]) => Promise<SdkResponse<never>>;
|
|
1495
1750
|
delete: (name: string) => Promise<SdkResponse<never>>;
|
|
1751
|
+
deleteWithId: (id: string) => Promise<SdkResponse<never>>;
|
|
1752
|
+
deleteBatch: (names?: string[], ids?: string[]) => Promise<SdkResponse<never>>;
|
|
1496
1753
|
loadAll: () => Promise<SdkResponse<Permission[]>>;
|
|
1497
1754
|
};
|
|
1498
1755
|
password: {
|
|
@@ -1501,8 +1758,14 @@ declare const nodeSdk: {
|
|
|
1501
1758
|
};
|
|
1502
1759
|
role: {
|
|
1503
1760
|
create: (name: string, description?: string, permissionNames?: string[], tenantId?: string, defaultRole?: boolean) => Promise<SdkResponse<never>>;
|
|
1761
|
+
createBatch: (roles: Role[]) => Promise<SdkResponse<Role[]>>;
|
|
1762
|
+
/** Configuration arguments which include the Descope core SDK args and an optional management key */
|
|
1504
1763
|
update: (name: string, newName: string, description?: string, permissionNames?: string[], tenantId?: string, defaultRole?: boolean) => Promise<SdkResponse<never>>;
|
|
1764
|
+
updateWithId: (id: string, newName: string, description?: string, permissionNames?: string[], tenantId?: string, defaultRole?: boolean) => Promise<SdkResponse<never>>;
|
|
1765
|
+
updateBatch: (roles: RoleUpdateRequest[]) => Promise<SdkResponse<Role[]>>;
|
|
1505
1766
|
delete: (name: string, tenantId?: string) => Promise<SdkResponse<never>>;
|
|
1767
|
+
deleteWithId: (id: string, tenantId?: string) => Promise<SdkResponse<never>>;
|
|
1768
|
+
deleteBatch: (roleNames?: string[], tenantId?: string, roleIds?: string[]) => Promise<SdkResponse<never>>;
|
|
1506
1769
|
loadAll: () => Promise<SdkResponse<Role[]>>;
|
|
1507
1770
|
search: (options: RoleSearchOptions) => Promise<SdkResponse<Role[]>>;
|
|
1508
1771
|
};
|
|
@@ -1524,7 +1787,9 @@ declare const nodeSdk: {
|
|
|
1524
1787
|
};
|
|
1525
1788
|
audit: {
|
|
1526
1789
|
search: (searchOptions: AuditSearchOptions) => Promise<SdkResponse<AuditRecord[]>>;
|
|
1790
|
+
searchAll: (searchOptions: AuditSearchOptions) => Promise<SdkResponse<AuditSearchAllResponse>>;
|
|
1527
1791
|
createEvent: (createOptions: AuditCreateOptions) => Promise<SdkResponse<never>>;
|
|
1792
|
+
createAuditWebhook: (options: AuditWebhook) => Promise<SdkResponse<never>>;
|
|
1528
1793
|
};
|
|
1529
1794
|
authz: {
|
|
1530
1795
|
saveSchema: (schema: AuthzSchema, upgrade: boolean) => Promise<SdkResponse<never>>;
|
|
@@ -1542,19 +1807,26 @@ declare const nodeSdk: {
|
|
|
1542
1807
|
hasRelations: (relationQueries: AuthzRelationQuery[]) => Promise<SdkResponse<AuthzRelationQuery[]>>;
|
|
1543
1808
|
whoCanAccess: (resource: string, relationDefinition: string, namespace: string) => Promise<SdkResponse<string[]>>;
|
|
1544
1809
|
resourceRelations: (resource: string, ignoreTargetSetRelations?: boolean) => Promise<SdkResponse<AuthzRelation[]>>;
|
|
1810
|
+
resourceRelationsWithTargetSetsFilter: (resource: string, includeTargetSetRelations?: boolean) => Promise<SdkResponse<AuthzRelation[]>>;
|
|
1545
1811
|
targetsRelations: (targets: string[], includeTargetSetRelations?: boolean) => Promise<SdkResponse<AuthzRelation[]>>;
|
|
1812
|
+
targetsRelationsWithTargetSetsFilter: (targets: string[], includeTargetSetRelations?: boolean) => Promise<SdkResponse<AuthzRelation[]>>;
|
|
1546
1813
|
whatCanTargetAccess: (target: string) => Promise<SdkResponse<AuthzRelation[]>>;
|
|
1547
1814
|
whatCanTargetAccessWithRelation: (target: string, relationDefinition: string, namespace: string) => Promise<SdkResponse<AuthzResource[]>>;
|
|
1548
1815
|
getModified: (since: Date) => Promise<SdkResponse<AuthzModified>>;
|
|
1549
1816
|
};
|
|
1550
1817
|
fga: {
|
|
1551
1818
|
saveSchema: (schema: FGASchema) => Promise<SdkResponse<never>>;
|
|
1819
|
+
loadSchema: () => Promise<SdkResponse<FGASchema>>;
|
|
1820
|
+
dryRunSchema: (schema: FGASchema) => Promise<SdkResponse<FGASchemaDryRunResponse>>;
|
|
1552
1821
|
deleteSchema: () => Promise<SdkResponse<never>>;
|
|
1553
1822
|
createRelations: (relations: FGARelation[]) => Promise<SdkResponse<never>>;
|
|
1554
1823
|
deleteRelations: (relations: FGARelation[]) => Promise<SdkResponse<never>>;
|
|
1555
1824
|
check: (relations: FGARelation[]) => Promise<SdkResponse<CheckResponseRelation[]>>;
|
|
1825
|
+
checkWithContext: (relations: FGARelation[], context?: Record<string, any>) => Promise<SdkResponse<CheckResponseRelation[]>>;
|
|
1556
1826
|
loadResourcesDetails: (resourceIdentifiers: FGAResourceIdentifier[]) => Promise<SdkResponse<FGAResourceDetails[]>>;
|
|
1557
1827
|
saveResourcesDetails: (resourcesDetails: FGAResourceDetails[]) => Promise<SdkResponse<never>>;
|
|
1828
|
+
loadMappableSchema: (tenantId: string, options?: FGAMappableResourcesOptions) => Promise<SdkResponse<FGAMappableSchema>>;
|
|
1829
|
+
searchMappableResources: (tenantId: string, resourcesQueries: FGAMappableResourcesQuery[], options?: FGAMappableResourcesOptions) => Promise<SdkResponse<FGAMappableResources[]>>;
|
|
1558
1830
|
deleteAllRelations: () => Promise<SdkResponse<never>>;
|
|
1559
1831
|
};
|
|
1560
1832
|
descoper: {
|
|
@@ -1585,6 +1857,41 @@ declare const nodeSdk: {
|
|
|
1585
1857
|
loadAll: () => Promise<SdkResponse<Engine[]>>;
|
|
1586
1858
|
rotateSecret: (id: string) => Promise<SdkResponse<EngineSecretResponse>>;
|
|
1587
1859
|
};
|
|
1860
|
+
list: {
|
|
1861
|
+
create: (request: ListRequest) => Promise<SdkResponse<List>>;
|
|
1862
|
+
update: (id: string, request: ListRequest) => Promise<SdkResponse<List>>;
|
|
1863
|
+
delete: (id: string) => Promise<SdkResponse<never>>;
|
|
1864
|
+
load: (id: string) => Promise<SdkResponse<List>>;
|
|
1865
|
+
loadByName: (name: string) => Promise<SdkResponse<List>>;
|
|
1866
|
+
loadAll: () => Promise<SdkResponse<List[]>>;
|
|
1867
|
+
import: (lists: List[]) => Promise<SdkResponse<never>>;
|
|
1868
|
+
addIPs: (id: string, ips: string[]) => Promise<SdkResponse<never>>;
|
|
1869
|
+
removeIPs: (id: string, ips: string[]) => Promise<SdkResponse<never>>;
|
|
1870
|
+
checkIP: (id: string, ip: string) => Promise<SdkResponse<any>>;
|
|
1871
|
+
addTexts: (id: string, texts: string[]) => Promise<SdkResponse<never>>;
|
|
1872
|
+
removeTexts: (id: string, texts: string[]) => Promise<SdkResponse<never>>;
|
|
1873
|
+
checkText: (id: string, text: string) => Promise<SdkResponse<any>>;
|
|
1874
|
+
clear: (id: string) => Promise<SdkResponse<never>>;
|
|
1875
|
+
};
|
|
1876
|
+
jwtTemplate: {
|
|
1877
|
+
create: (template: JWTTemplate) => Promise<SdkResponse<JWTTemplate>>;
|
|
1878
|
+
update: (template: JWTTemplate) => Promise<SdkResponse<JWTTemplate>>;
|
|
1879
|
+
delete: (id: string) => Promise<SdkResponse<never>>;
|
|
1880
|
+
list: () => Promise<SdkResponse<JWTTemplate[]>>;
|
|
1881
|
+
load: (id: string) => Promise<SdkResponse<JWTTemplate>>;
|
|
1882
|
+
validate: (id: string, template?: JWTTemplate) => Promise<SdkResponse<JWTTemplateValidationResult>>;
|
|
1883
|
+
listLibrary: () => Promise<SdkResponse<JWTTemplateLibraryEntry[]>>;
|
|
1884
|
+
loadLibraryEntry: (id: string) => Promise<SdkResponse<JWTTemplateLibraryEntry>>;
|
|
1885
|
+
applyFromLibrary: (request: ApplyJWTTemplateFromLibraryRequest) => Promise<SdkResponse<JWTTemplate>>;
|
|
1886
|
+
};
|
|
1887
|
+
scopeClaimMapping: {
|
|
1888
|
+
get: () => Promise<SdkResponse<ScopeClaimMappingEntry[]>>;
|
|
1889
|
+
set: (mappings: ScopeClaimMappingEntry[]) => Promise<SdkResponse<never>>;
|
|
1890
|
+
delete: () => Promise<SdkResponse<never>>;
|
|
1891
|
+
};
|
|
1892
|
+
analytics: {
|
|
1893
|
+
search: (options: AnalyticsSearchOptions) => Promise<SdkResponse<AnalyticRecord[]>>;
|
|
1894
|
+
};
|
|
1588
1895
|
};
|
|
1589
1896
|
getKey: (header: JWTHeaderParameters) => Promise<KeyLike | Uint8Array>;
|
|
1590
1897
|
validateJwt: (jwt: string, options?: VerifyOptions) => Promise<AuthenticationInfo>;
|
|
@@ -2403,4 +2710,4 @@ declare const nodeSdk: {
|
|
|
2403
2710
|
};
|
|
2404
2711
|
};
|
|
2405
2712
|
|
|
2406
|
-
export { AccessKey, AccessType, AssociatedTenant, AttributeMapping, AttributesTypes, AuditCreateOptions, AuditRecord, AuditSearchOptions, AuditType, AuthenticationInfo, AuthzModified, AuthzNamespace, AuthzNode, AuthzNodeExpression, AuthzNodeExpressionType, AuthzNodeType, AuthzRelation, AuthzRelationDefinition, AuthzRelationQuery, AuthzResource, AuthzSchema, AuthzUserQuery, BatchUploadOutboundAppTokensResponse, CheckResponseRelation, ClientAssertionResponse, CloneProjectResponse, CreateInboundApplicationResponse, CreateOrInviteBatchResponse, CreateOutboundAppByTemplateOptions, CreateSSOApplicationResponse, CreateTenantResponse, CreatedAccessKeyResponse, Descoper, DescoperAttributes, DescoperCreate, DescoperProjectRole, DescoperRBAC, DescoperRole, DescoperTagRole, Engine, EngineSecretResponse, ExpirationUnit, ExportSnapshotResponse, FGAConfig, FGARelation, FGAResourceDetails, FGAResourceIdentifier, FGASchema, FetchLatestOutboundAppTenantTokenRequest, FetchLatestOutboundAppUserTokenRequest, FetchOutboundAppTenantTokenRequest, FetchOutboundAppTokenOptions, FetchOutboundAppUserTokenRequest, Flow, FlowMetadata, FlowResponse, FlowsResponse, GenerateEmbeddedLinkResponse, GenerateEnchantedLinkForTestResponse, GenerateMagicLinkForTestResponse, GenerateOTPForTestResponse, GenerateSSOConfigurationLinkResponse, Group, GroupMember, GroupsMapping, IDPResponse, ImportSnapshotRequest, InboundApplication, InboundApplicationConsent, InboundApplicationConsentDeleteOptions, InboundApplicationConsentSearchOptions, InboundApplicationOptions, InboundApplicationScope, InboundApplicationSecretResponse, License, ManagementFlowOptions, MgmtKey, MgmtKeyCreateResponse, MgmtKeyProjectRole, MgmtKeyReBac, MgmtKeyStatus, MgmtKeyTagRole, MgmtLoginOptions, MgmtSignUpOptions, MgmtUserOptions, OIDCAttributeMapping, OIDCRoleMapping, OidcApplicationOptions, OutboundAppTemplateOverrides, OutboundAppTenantTokenToUpload, OutboundAppToken, OutboundAppTokenResponse, OutboundAppTokenUploadFailure, OutboundAppUserTokenToUpload, OutboundApplication, PasswordSettings, PatchUserBatchResponse, PatchUserOptions, Permission, Project, ProjectEnvironment, Prompt, PromptType, ProviderTokenOptions, ProviderTokenResponse, RefreshAuthenticationInfo, Role, RoleItem, RoleMapping, RoleMappings, RoleSearchOptions, RunManagementFlowResponse, SAMLIDPRoleGroupMappingInfo, SSOApplication, SSOApplicationOIDCSettings, SSOApplicationSAMLSettings, SSOApplicationWSFedSettings, SSOOIDCSettings, SSOSAMLByMetadataSettings, SSOSAMLSettings, SSOSAMLSettingsResponse, SSOSettings, SSOSettingsResponse, SSOSetupSuiteSettings, SSOSetupSuiteSettingsDisabledFeatures, SamlApplicationOptions, SamlIdpAttributeMappingInfo, SamlIdpGroupsMappingInfo, Screen, SnapshotSecret, SnapshotSecrets, TemplateOptions, Tenant, TenantSettings, Theme, ThemeResponse, URLParam, UpdateJWTResponse, UploadOutboundAppTenantTokenRequest, UploadOutboundAppUserTokenRequest, User, UserFailedResponse, UserMapping, UserOptions, UserPasswordBcrypt, UserPasswordDjango, UserPasswordFirebase, UserPasswordHashed, UserPasswordMd5, UserPasswordPbkdf2, UserPasswordPhpass, UserSearchResponse, UserStatus, ValidateSnapshotRequest, ValidateSnapshotResponse, VerifyOptions, WsFedApplicationOptions, nodeSdk as default };
|
|
2713
|
+
export { AccessKey, AccessType, AnalyticRecord, AnalyticsSearchOptions, ApplyJWTTemplateFromLibraryRequest, AssociatedTenant, AttributeMapping, AttributesTypes, AuditCreateOptions, AuditFilters, AuditRecord, AuditSearchAllResponse, AuditSearchOptions, AuditType, AuditWebhook, AuthenticationInfo, AuthzModified, AuthzNamespace, AuthzNode, AuthzNodeExpression, AuthzNodeExpressionType, AuthzNodeType, AuthzRelation, AuthzRelationDefinition, AuthzRelationQuery, AuthzResource, AuthzSchema, AuthzUserQuery, BatchUploadOutboundAppTokensResponse, CheckResponseRelation, ClientAssertionResponse, CloneProjectResponse, ConnectorHTTPAPIKeyAuthentication, ConnectorHTTPAuthentication, ConnectorHTTPBasicAuthentication, CreateInboundApplicationResponse, CreateOrInviteBatchResponse, CreateOutboundAppByTemplateOptions, CreateSSOApplicationResponse, CreateTenantResponse, CreatedAccessKeyResponse, CustomAttribute, CustomAttributeOption, Descoper, DescoperAttributes, DescoperCreate, DescoperProjectRole, DescoperRBAC, DescoperRole, DescoperTagRole, Engine, EngineSecretResponse, ExpirationUnit, ExportSnapshotResponse, FGAConfig, FGAMappableResource, FGAMappableResources, FGAMappableResourcesOptions, FGAMappableResourcesQuery, FGAMappableSchema, FGARelation, FGAResourceDetails, FGAResourceIdentifier, FGASchema, FGASchemaDryRunResponse, FetchLatestOutboundAppTenantTokenRequest, FetchLatestOutboundAppUserTokenRequest, FetchOutboundAppTenantTokenRequest, FetchOutboundAppTokenOptions, FetchOutboundAppUserTokenRequest, Flow, FlowMetadata, FlowResponse, FlowsResponse, GenerateEmbeddedLinkResponse, GenerateEnchantedLinkForTestResponse, GenerateMagicLinkForTestResponse, GenerateOTPForTestResponse, GenerateSSOConfigurationLinkResponse, Group, GroupMember, GroupsMapping, IDPResponse, ImportSnapshotRequest, InboundApplication, InboundApplicationConsent, InboundApplicationConsentDeleteOptions, InboundApplicationConsentSearchOptions, InboundApplicationOptions, InboundApplicationScope, InboundApplicationSecretResponse, InboundApplicationTenantConsentDeleteOptions, JWTTemplate, JWTTemplateLibraryEntry, JWTTemplateValidationIssue, JWTTemplateValidationResult, License, List, ListRequest, ListType, ManagementFlowOptions, MgmtKey, MgmtKeyCreateResponse, MgmtKeyProjectRole, MgmtKeyReBac, MgmtKeyStatus, MgmtKeyTagRole, MgmtLoginOptions, MgmtSignUpOptions, MgmtUserOptions, OIDCAttributeMapping, OIDCRoleMapping, OidcApplicationOptions, OutboundAppTemplateOverrides, OutboundAppTenantTokenToUpload, OutboundAppToken, OutboundAppTokenResponse, OutboundAppTokenUploadFailure, OutboundAppUserTokenToUpload, OutboundApplication, PasswordSettings, PatchUserBatchResponse, PatchUserOptions, Permission, PermissionUpdateRequest, Project, ProjectEnvironment, Prompt, PromptType, ProviderTokenOptions, ProviderTokenResponse, RefreshAuthenticationInfo, Role, RoleItem, RoleMapping, RoleMappings, RoleSearchOptions, RoleUpdateRequest, RunManagementFlowResponse, SAMLIDPRoleGroupMappingInfo, SSOApplication, SSOApplicationOIDCSettings, SSOApplicationSAMLSettings, SSOApplicationSecretResponse, SSOApplicationWSFedSettings, SSOOIDCSettings, SSOSAMLByMetadataSettings, SSOSAMLSettings, SSOSAMLSettingsResponse, SSOSettings, SSOSettingsResponse, SSOSetupSuiteSettings, SSOSetupSuiteSettingsDisabledFeatures, SamlApplicationOptions, SamlIdpAttributeMappingInfo, SamlIdpGroupsMappingInfo, ScopeClaimMappingEntry, Screen, SnapshotSecret, SnapshotSecrets, TemplateOptions, Tenant, TenantSettings, Theme, ThemeResponse, URLParam, UpdateJWTResponse, UploadOutboundAppTenantTokenRequest, UploadOutboundAppUserTokenRequest, User, UserFailedResponse, UserImportFailure, UserImportResponse, UserMapping, UserOptions, UserPasskey, UserPasswordBcrypt, UserPasswordDjango, UserPasswordFirebase, UserPasswordHashed, UserPasswordMd5, UserPasswordPbkdf2, UserPasswordPhpass, UserSearchResponse, UserStatus, UserTrustedDevice, ValidateSnapshotRequest, ValidateSnapshotResponse, VerifyOptions, WsFedApplicationOptions, nodeSdk as default };
|