auth0 7.0.0 → 7.2.0
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/management/Client.d.ts +5 -5
- package/dist/cjs/management/Client.js +28 -28
- package/dist/cjs/management/api/errors/GatewayTimeoutError.d.ts +5 -0
- package/dist/cjs/management/api/errors/GatewayTimeoutError.js +54 -0
- package/dist/cjs/management/api/errors/index.d.ts +1 -0
- package/dist/cjs/management/api/errors/index.js +1 -0
- package/dist/cjs/management/api/requests/requests.d.ts +117 -88
- package/dist/cjs/management/api/resources/experimentation/client/Client.d.ts +12 -0
- package/dist/cjs/management/api/resources/experimentation/client/Client.js +16 -0
- package/dist/cjs/management/api/resources/experimentation/exports.d.ts +3 -0
- package/dist/cjs/management/api/resources/experimentation/exports.js +22 -0
- package/dist/cjs/management/api/resources/experimentation/index.d.ts +2 -0
- package/dist/cjs/management/api/resources/experimentation/index.js +18 -0
- package/dist/cjs/management/api/resources/experimentation/resources/experiments/client/Client.d.ts +34 -0
- package/dist/cjs/management/api/resources/experimentation/resources/experiments/client/Client.js +131 -0
- package/dist/cjs/management/api/resources/experimentation/resources/experiments/client/index.js +2 -0
- package/dist/cjs/management/api/resources/experimentation/resources/experiments/exports.d.ts +2 -0
- package/dist/cjs/management/api/resources/{organizationTemplates → experimentation/resources/experiments}/exports.js +2 -2
- package/dist/cjs/management/api/resources/experimentation/resources/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/experimentation/resources/index.js +37 -0
- package/dist/cjs/management/api/resources/guardian/client/Client.d.ts +40 -1
- package/dist/cjs/management/api/resources/guardian/client/Client.js +172 -0
- package/dist/cjs/management/api/resources/guardian/resources/factors/client/Client.d.ts +3 -0
- package/dist/cjs/management/api/resources/guardian/resources/factors/client/Client.js +11 -6
- package/dist/cjs/management/api/resources/guardian/resources/factors/resources/email/client/Client.d.ts +46 -0
- package/dist/cjs/management/api/resources/guardian/resources/factors/resources/email/client/Client.js +181 -0
- package/dist/cjs/management/api/resources/guardian/resources/factors/resources/email/client/index.js +2 -0
- package/dist/cjs/management/api/resources/guardian/resources/factors/resources/email/exports.d.ts +2 -0
- package/dist/cjs/management/api/resources/guardian/resources/factors/resources/email/exports.js +21 -0
- package/dist/cjs/management/api/resources/guardian/resources/factors/resources/email/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/guardian/resources/factors/resources/email/index.js +17 -0
- package/dist/cjs/management/api/resources/guardian/resources/factors/resources/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/guardian/resources/factors/resources/index.js +2 -1
- package/dist/cjs/management/api/resources/guardian/resources/factors/resources/phone/client/Client.d.ts +33 -0
- package/dist/cjs/management/api/resources/guardian/resources/factors/resources/phone/client/Client.js +122 -0
- package/dist/cjs/management/api/resources/index.d.ts +1 -1
- package/dist/cjs/management/api/resources/index.js +2 -2
- package/dist/cjs/management/api/resources/organizations/client/Client.d.ts +36 -0
- package/dist/cjs/management/api/resources/organizations/client/Client.js +104 -0
- package/dist/cjs/management/api/resources/resourceServers/client/Client.d.ts +29 -0
- package/dist/cjs/management/api/resources/resourceServers/client/Client.js +103 -0
- package/dist/cjs/management/api/types/types.d.ts +287 -51
- package/dist/cjs/management/api/types/types.js +51 -36
- package/dist/cjs/management/version.d.ts +1 -1
- package/dist/cjs/management/version.js +1 -1
- package/dist/esm/management/Client.d.mts +5 -5
- package/dist/esm/management/Client.mjs +7 -7
- package/dist/esm/management/api/errors/GatewayTimeoutError.d.mts +5 -0
- package/dist/esm/management/api/errors/GatewayTimeoutError.mjs +17 -0
- package/dist/esm/management/api/errors/index.d.mts +1 -0
- package/dist/esm/management/api/errors/index.mjs +1 -0
- package/dist/esm/management/api/requests/requests.d.mts +117 -88
- package/dist/esm/management/api/resources/experimentation/client/Client.d.mts +12 -0
- package/dist/esm/management/api/resources/experimentation/client/Client.mjs +12 -0
- package/dist/esm/management/api/resources/experimentation/client/index.d.mts +1 -0
- package/dist/esm/management/api/resources/experimentation/client/index.mjs +1 -0
- package/dist/esm/management/api/resources/experimentation/exports.d.mts +3 -0
- package/dist/esm/management/api/resources/experimentation/exports.mjs +4 -0
- package/dist/esm/management/api/resources/experimentation/index.d.mts +2 -0
- package/dist/esm/management/api/resources/experimentation/index.mjs +2 -0
- package/dist/esm/management/api/resources/experimentation/resources/experiments/client/Client.d.mts +34 -0
- package/dist/esm/management/api/resources/experimentation/resources/experiments/client/Client.mjs +94 -0
- package/dist/esm/management/api/resources/experimentation/resources/experiments/client/index.d.mts +1 -0
- package/dist/esm/management/api/resources/experimentation/resources/experiments/client/index.mjs +1 -0
- package/dist/esm/management/api/resources/experimentation/resources/experiments/exports.d.mts +2 -0
- package/dist/esm/management/api/resources/{organizationTemplates → experimentation/resources/experiments}/exports.mjs +1 -1
- package/dist/esm/management/api/resources/experimentation/resources/index.d.mts +1 -0
- package/dist/esm/management/api/resources/experimentation/resources/index.mjs +1 -0
- package/dist/esm/management/api/resources/guardian/client/Client.d.mts +40 -1
- package/dist/esm/management/api/resources/guardian/client/Client.mjs +139 -0
- package/dist/esm/management/api/resources/guardian/resources/factors/client/Client.d.mts +3 -0
- package/dist/esm/management/api/resources/guardian/resources/factors/client/Client.mjs +5 -0
- package/dist/esm/management/api/resources/guardian/resources/factors/resources/email/client/Client.d.mts +46 -0
- package/dist/esm/management/api/resources/guardian/resources/factors/resources/email/client/Client.mjs +144 -0
- package/dist/esm/management/api/resources/guardian/resources/factors/resources/email/client/index.d.mts +1 -0
- package/dist/esm/management/api/resources/guardian/resources/factors/resources/email/client/index.mjs +1 -0
- package/dist/esm/management/api/resources/guardian/resources/factors/resources/email/exports.d.mts +2 -0
- package/dist/esm/management/api/resources/guardian/resources/factors/resources/email/exports.mjs +3 -0
- package/dist/esm/management/api/resources/guardian/resources/factors/resources/email/index.d.mts +1 -0
- package/dist/esm/management/api/resources/guardian/resources/factors/resources/email/index.mjs +1 -0
- package/dist/esm/management/api/resources/guardian/resources/factors/resources/index.d.mts +1 -0
- package/dist/esm/management/api/resources/guardian/resources/factors/resources/index.mjs +1 -0
- package/dist/esm/management/api/resources/guardian/resources/factors/resources/phone/client/Client.d.mts +33 -0
- package/dist/esm/management/api/resources/guardian/resources/factors/resources/phone/client/Client.mjs +122 -0
- package/dist/esm/management/api/resources/index.d.mts +1 -1
- package/dist/esm/management/api/resources/index.mjs +1 -1
- package/dist/esm/management/api/resources/organizations/client/Client.d.mts +36 -0
- package/dist/esm/management/api/resources/organizations/client/Client.mjs +104 -0
- package/dist/esm/management/api/resources/resourceServers/client/Client.d.mts +29 -0
- package/dist/esm/management/api/resources/resourceServers/client/Client.mjs +103 -0
- package/dist/esm/management/api/types/types.d.mts +287 -51
- package/dist/esm/management/api/types/types.mjs +48 -33
- package/dist/esm/management/version.d.mts +1 -1
- package/dist/esm/management/version.mjs +1 -1
- package/package.json +46 -23
- package/reference.md +654 -389
- package/dist/cjs/management/api/resources/organizationTemplates/client/Client.d.ts +0 -106
- package/dist/cjs/management/api/resources/organizationTemplates/client/Client.js +0 -411
- package/dist/cjs/management/api/resources/organizationTemplates/exports.d.ts +0 -2
- package/dist/esm/management/api/resources/organizationTemplates/client/Client.d.mts +0 -106
- package/dist/esm/management/api/resources/organizationTemplates/client/Client.mjs +0 -374
- package/dist/esm/management/api/resources/organizationTemplates/exports.d.mts +0 -2
- /package/dist/cjs/management/api/resources/{organizationTemplates → experimentation}/client/index.d.ts +0 -0
- /package/dist/cjs/management/api/resources/{organizationTemplates → experimentation}/client/index.js +0 -0
- /package/dist/{esm/management/api/resources/organizationTemplates/client/index.d.mts → cjs/management/api/resources/experimentation/resources/experiments/client/index.d.ts} +0 -0
- /package/dist/cjs/management/api/resources/{organizationTemplates → experimentation/resources/experiments}/index.d.ts +0 -0
- /package/dist/cjs/management/api/resources/{organizationTemplates → experimentation/resources/experiments}/index.js +0 -0
- /package/dist/{esm/management/api/resources/organizationTemplates/client/index.mjs → cjs/management/api/resources/guardian/resources/factors/resources/email/client/index.d.ts} +0 -0
- /package/dist/esm/management/api/resources/{organizationTemplates → experimentation/resources/experiments}/index.d.mts +0 -0
- /package/dist/esm/management/api/resources/{organizationTemplates → experimentation/resources/experiments}/index.mjs +0 -0
|
@@ -340,6 +340,7 @@ export interface CreateClientRequestContent {
|
|
|
340
340
|
/** The identifier of the resource server that this client is linked to. */
|
|
341
341
|
resource_server_identifier?: string;
|
|
342
342
|
identity_assertion_authorization_grant?: Management.CreateIdentityAssertionAuthorizationGrant;
|
|
343
|
+
anonymous_sessions?: Management.CreateAnonymousSessions;
|
|
343
344
|
third_party_security_mode?: Management.ClientThirdPartySecurityModeEnum;
|
|
344
345
|
redirection_policy?: Management.ClientRedirectionPolicyEnum;
|
|
345
346
|
express_configuration?: Management.ExpressConfiguration;
|
|
@@ -438,6 +439,7 @@ export interface UpdateClientRequestContent {
|
|
|
438
439
|
custom_login_page_preview?: string;
|
|
439
440
|
token_quota?: Management.UpdateTokenQuota | null;
|
|
440
441
|
identity_assertion_authorization_grant?: Management.UpdateIdentityAssertionAuthorizationGrant | null;
|
|
442
|
+
anonymous_sessions?: Management.UpdateAnonymousSessions | null;
|
|
441
443
|
/** Form template for WS-Federation protocol */
|
|
442
444
|
form_template?: string;
|
|
443
445
|
addons?: Management.ClientAddons;
|
|
@@ -699,7 +701,7 @@ export interface ListDeviceCredentialsRequestParameters {
|
|
|
699
701
|
user_id?: string | null;
|
|
700
702
|
/** client_id of the devices to retrieve. */
|
|
701
703
|
client_id?: string | null;
|
|
702
|
-
/** Type of credentials to retrieve. Must be `public_key`, `refresh_token` or `rotating_refresh_token`.
|
|
704
|
+
/** Type of credentials to retrieve. Must be `public_key`, `refresh_token` or `rotating_refresh_token`. If none is provided a combined list of `refresh_tokens` and `public_keys` will be returned (and no `rotating_refresh_token`), in this case `page`, `per_page` and `include_totals` will be ignored. */
|
|
703
705
|
type?: Management.DeviceCredentialTypeEnum | null;
|
|
704
706
|
}
|
|
705
707
|
/**
|
|
@@ -1024,6 +1026,25 @@ export interface ListGroupsRequestParameters {
|
|
|
1024
1026
|
/** Number of results per page. Defaults to 50. */
|
|
1025
1027
|
take?: number | null;
|
|
1026
1028
|
}
|
|
1029
|
+
/**
|
|
1030
|
+
* @example
|
|
1031
|
+
* {
|
|
1032
|
+
* display_remember_me_checkbox: true,
|
|
1033
|
+
* remember_me_default_value: true,
|
|
1034
|
+
* mfa_session_inactivity_timeout: 1,
|
|
1035
|
+
* mfa_session_overall_timeout: 1
|
|
1036
|
+
* }
|
|
1037
|
+
*/
|
|
1038
|
+
export interface SetGuardianSettingsRequestContent {
|
|
1039
|
+
/** Determines whether to display the "Remember Me" checkbox on the MFA prompt in Universal Login. */
|
|
1040
|
+
display_remember_me_checkbox: boolean;
|
|
1041
|
+
/** Determines the default state of the "Remember Me" checkbox on the MFA prompt in Universal Login. */
|
|
1042
|
+
remember_me_default_value: boolean;
|
|
1043
|
+
/** Duration of inactivity after which the user will be prompted for MFA. Represented as seconds. Minimum duration is 1 hour, maximum is 30 days, and cannot exceed the overall timeout. */
|
|
1044
|
+
mfa_session_inactivity_timeout: number;
|
|
1045
|
+
/** Maximum duration after which the user will be prompted for MFA regardless of activity. Represented as seconds. Minimum duration is 1 hour, maximum is 90 days. */
|
|
1046
|
+
mfa_session_overall_timeout: number;
|
|
1047
|
+
}
|
|
1027
1048
|
/**
|
|
1028
1049
|
* @example
|
|
1029
1050
|
* {
|
|
@@ -1204,93 +1225,6 @@ export interface UpdateNetworkAclRequestContent {
|
|
|
1204
1225
|
priority?: number;
|
|
1205
1226
|
rule?: Management.NetworkAclRule;
|
|
1206
1227
|
}
|
|
1207
|
-
/**
|
|
1208
|
-
* @example
|
|
1209
|
-
* {
|
|
1210
|
-
* from: "from",
|
|
1211
|
-
* take: 1
|
|
1212
|
-
* }
|
|
1213
|
-
*/
|
|
1214
|
-
export interface ListOrganizationTemplatesRequestParameters {
|
|
1215
|
-
/** Optional Id from which to start selection. */
|
|
1216
|
-
from?: string | null;
|
|
1217
|
-
/** Number of results per page. Defaults to 5. Values greater than 10 are capped at 10. */
|
|
1218
|
-
take?: number | null;
|
|
1219
|
-
}
|
|
1220
|
-
/**
|
|
1221
|
-
* @example
|
|
1222
|
-
* {
|
|
1223
|
-
* name: "name",
|
|
1224
|
-
* organization_deletion_behavior: "allow",
|
|
1225
|
-
* enforce_permission_ceiling: true,
|
|
1226
|
-
* enforce_self_assignment_restriction: true
|
|
1227
|
-
* }
|
|
1228
|
-
*/
|
|
1229
|
-
export interface CreateOrganizationTemplateRequestContent {
|
|
1230
|
-
/** The name of the organization template. */
|
|
1231
|
-
name: string;
|
|
1232
|
-
/** Whether this is the default template applied to new organizations. */
|
|
1233
|
-
is_default?: boolean;
|
|
1234
|
-
organization_deletion_behavior: Management.OrganizationDeletionBehaviorEnum;
|
|
1235
|
-
connection_deletion_behavior?: Management.ConnectionDeletionBehaviorEnum;
|
|
1236
|
-
/** Whether to enforce permission ceiling for organizations using this template. */
|
|
1237
|
-
enforce_permission_ceiling: boolean;
|
|
1238
|
-
/** Whether to enforce self-assignment restrictions for organizations using this template. */
|
|
1239
|
-
enforce_self_assignment_restriction: boolean;
|
|
1240
|
-
/** The connection profile to apply to new connections. */
|
|
1241
|
-
connection_profile_id?: string | null;
|
|
1242
|
-
/** The user attribute profile to apply to organizations. */
|
|
1243
|
-
user_attribute_profile_id?: string | null;
|
|
1244
|
-
/** List of allowed connection strategies for this template. */
|
|
1245
|
-
allowed_strategies?: Management.OrganizationTemplateAllowedStrategyEnum[] | null;
|
|
1246
|
-
/** The client ID for the invitation landing page. */
|
|
1247
|
-
invitation_landing_client_id?: string | null;
|
|
1248
|
-
/** Default admin roles to assign to organization creators. */
|
|
1249
|
-
admin_roles_assignment?: string[] | null;
|
|
1250
|
-
use_for_organization_discovery?: Management.OrganizationTemplateUseForOrganizationDiscovery | null;
|
|
1251
|
-
role_visibility_policy?: Management.OrganizationTemplateRoleVisibilityPolicy | null;
|
|
1252
|
-
}
|
|
1253
|
-
/**
|
|
1254
|
-
* @example
|
|
1255
|
-
* {}
|
|
1256
|
-
*/
|
|
1257
|
-
export interface UpdateOrganizationTemplateRequestContent {
|
|
1258
|
-
/** The name of the organization template. */
|
|
1259
|
-
name?: string;
|
|
1260
|
-
/** Whether this is the default template applied to new organizations. */
|
|
1261
|
-
is_default?: boolean;
|
|
1262
|
-
organization_deletion_behavior?: Management.OrganizationDeletionBehaviorEnum;
|
|
1263
|
-
connection_deletion_behavior?: Management.ConnectionDeletionBehaviorEnum;
|
|
1264
|
-
/** Whether to enforce permission ceiling for organizations using this template. */
|
|
1265
|
-
enforce_permission_ceiling?: boolean;
|
|
1266
|
-
/** Whether to enforce self-assignment restrictions for organizations using this template. */
|
|
1267
|
-
enforce_self_assignment_restriction?: boolean;
|
|
1268
|
-
/** The connection profile to apply to new connections. */
|
|
1269
|
-
connection_profile_id?: string | null;
|
|
1270
|
-
/** The user attribute profile to apply to organizations. */
|
|
1271
|
-
user_attribute_profile_id?: string | null;
|
|
1272
|
-
/** List of allowed connection strategies for this template. */
|
|
1273
|
-
allowed_strategies?: Management.OrganizationTemplateAllowedStrategyEnum[] | null;
|
|
1274
|
-
/** The client ID for the invitation landing page. */
|
|
1275
|
-
invitation_landing_client_id?: string | null;
|
|
1276
|
-
/** Default admin roles to assign to organization creators. */
|
|
1277
|
-
admin_roles_assignment?: string[] | null;
|
|
1278
|
-
use_for_organization_discovery?: Management.OrganizationTemplateUseForOrganizationDiscovery | null;
|
|
1279
|
-
role_visibility_policy?: Management.OrganizationTemplateRoleVisibilityPolicy | null;
|
|
1280
|
-
}
|
|
1281
|
-
/**
|
|
1282
|
-
* @example
|
|
1283
|
-
* {
|
|
1284
|
-
* from: "from",
|
|
1285
|
-
* take: 1
|
|
1286
|
-
* }
|
|
1287
|
-
*/
|
|
1288
|
-
export interface ListTemplateOrganizationsRequestParameters {
|
|
1289
|
-
/** Optional Id from which to start selection. */
|
|
1290
|
-
from?: string | null;
|
|
1291
|
-
/** Number of results per page. Defaults to 5. Values greater than 10 are capped at 10. */
|
|
1292
|
-
take?: number | null;
|
|
1293
|
-
}
|
|
1294
1228
|
/**
|
|
1295
1229
|
* @example
|
|
1296
1230
|
* {
|
|
@@ -1333,6 +1267,28 @@ export interface CreateOrganizationRequestContent {
|
|
|
1333
1267
|
/** Whether app entitlement is active for this organization. */
|
|
1334
1268
|
is_app_entitlement_active?: boolean;
|
|
1335
1269
|
}
|
|
1270
|
+
/**
|
|
1271
|
+
* @example
|
|
1272
|
+
* {
|
|
1273
|
+
* q: "q",
|
|
1274
|
+
* parser: "scim",
|
|
1275
|
+
* take: 1,
|
|
1276
|
+
* from: "from",
|
|
1277
|
+
* sort: "name"
|
|
1278
|
+
* }
|
|
1279
|
+
*/
|
|
1280
|
+
export interface SearchOrganizationsRequestParameters {
|
|
1281
|
+
/** Filter expression in SCIM or Lucene syntax (depending on parser parameter, default: Lucene). Lucene examples: `name:acme*`, `display_name:*auth*`. SCIM examples: `name eq "Auth0"`, `display_name sw "auth" and created_at gt "2024-01-01"`. SCIM operators: eq, ne, sw, ew, co, pr, gt, ge, lt, le, and, or. <br /><br /><b>Supported Fields</b>:<ul><li><i>id</i> - Organization ID (case-sensitive, exact match)</li><li><i>name</i> - Organization name (supports contains, starts-with, ends-with operators; sortable)</li><li><i>display_name</i> - Organization display name (supports contains, starts-with, ends-with operators; sortable)</li><li><i>created_at</i> - Creation timestamp (supports date range operators; sortable)</li><li><i>metadata.{key}</i> - Filter by organization metadata key-value pairs</li></ul>Maximum 5 filter operations per query. Results are eventually consistent and may not reflect recent updates. */
|
|
1282
|
+
q?: string | null;
|
|
1283
|
+
/** Query parser to use for the filter expression. Use "scim" for SCIM filter syntax or "lucene" for Lucene query syntax (default). */
|
|
1284
|
+
parser?: Management.SearchParserEnum | null;
|
|
1285
|
+
/** Maximum number of results to return per page (1-100). Defaults to 50. */
|
|
1286
|
+
take?: number | null;
|
|
1287
|
+
/** Cursor for the next page of results. Use the value from the next field in the previous response. */
|
|
1288
|
+
from?: string | null;
|
|
1289
|
+
/** Field name to sort results by in ascending order only. Defaults to insertion order (oldest first) if not provided. */
|
|
1290
|
+
sort?: Management.OrganizationSortFieldEnum | null;
|
|
1291
|
+
}
|
|
1336
1292
|
/**
|
|
1337
1293
|
* @example
|
|
1338
1294
|
* {}
|
|
@@ -1504,11 +1460,14 @@ export interface CreateResourceServerRequestContent {
|
|
|
1504
1460
|
allow_online_access_with_ephemeral_sessions?: boolean;
|
|
1505
1461
|
/** Expiration value (in seconds) for access tokens issued for this API from the token endpoint. */
|
|
1506
1462
|
token_lifetime?: number;
|
|
1463
|
+
/** Expiration value (in seconds) for anonymous-session access tokens issued for this API. */
|
|
1464
|
+
token_lifetime_for_anonymous_access_tokens?: number | null;
|
|
1507
1465
|
token_dialect?: Management.ResourceServerTokenDialectSchemaEnum;
|
|
1508
1466
|
/** Whether to skip user consent for applications flagged as first party (true) or not (false). */
|
|
1509
1467
|
skip_consent_for_verifiable_first_party_clients?: boolean;
|
|
1510
1468
|
/** Whether to enforce authorization policies (true) or to ignore them (false). */
|
|
1511
1469
|
enforce_policies?: boolean;
|
|
1470
|
+
access_token?: Management.ResourceServerAccessToken | null;
|
|
1512
1471
|
token_encryption?: Management.ResourceServerTokenEncryption | null;
|
|
1513
1472
|
consent_policy?: Management.ResourceServerConsentPolicyEnum | null;
|
|
1514
1473
|
authorization_details?: unknown[] | null;
|
|
@@ -1516,6 +1475,34 @@ export interface CreateResourceServerRequestContent {
|
|
|
1516
1475
|
subject_type_authorization?: Management.ResourceServerSubjectTypeAuthorization;
|
|
1517
1476
|
authorization_policy?: Management.ResourceServerAuthorizationPolicy | null;
|
|
1518
1477
|
}
|
|
1478
|
+
/**
|
|
1479
|
+
* @example
|
|
1480
|
+
* {
|
|
1481
|
+
* q: "q",
|
|
1482
|
+
* parser: "scim",
|
|
1483
|
+
* fields: "fields",
|
|
1484
|
+
* include_fields: true,
|
|
1485
|
+
* take: 1,
|
|
1486
|
+
* from: "from",
|
|
1487
|
+
* sort: "identifier"
|
|
1488
|
+
* }
|
|
1489
|
+
*/
|
|
1490
|
+
export interface SearchResourceServersRequestParameters {
|
|
1491
|
+
/** Filter expression in SCIM or Lucene syntax (depending on parser parameter). SCIM examples: `name eq "My API"`, `identifier sw "https://"`. SCIM operators: eq, ne, sw, ew, co, pr, gt, ge, lt, le, and, or. <br /><br /><b>Supported Fields</b>:<ul><li><i>id</i> - Filter by resource server ID</li><li><i>identifier</i> - Filter by resource server identifier</li><li><i>name</i> - Filter by resource server name</li><li><i>updated_at</i> - Filter by last update date</li></ul>Maximum 5 filter operations per query. Results are eventually consistent and may not reflect recent updates. */
|
|
1492
|
+
q?: string | null;
|
|
1493
|
+
/** Query parser to use for the filter expression. Use "scim" for SCIM filter syntax or "lucene" for Lucene query syntax (default). */
|
|
1494
|
+
parser?: Management.SearchParserEnum | null;
|
|
1495
|
+
/** Comma-separated list of fields to include or exclude in the response. Works with the include_fields parameter to control projection mode. */
|
|
1496
|
+
fields?: string | null;
|
|
1497
|
+
/** Controls field projection mode. Set to true to include only fields specified in the fields parameter. Set to false to exclude fields specified in the fields parameter. Defaults to true if not specified. */
|
|
1498
|
+
include_fields?: boolean | null;
|
|
1499
|
+
/** Maximum number of results to return per page (1-100). Defaults to 50. */
|
|
1500
|
+
take?: number | null;
|
|
1501
|
+
/** Cursor for the next page of results. Use the value from the next field in the previous response. */
|
|
1502
|
+
from?: string | null;
|
|
1503
|
+
/** Field name to sort results by in ascending order only. Defaults to insertion order (oldest first) if not provided. */
|
|
1504
|
+
sort?: Management.ResourceServerSortFieldEnum | null;
|
|
1505
|
+
}
|
|
1519
1506
|
/**
|
|
1520
1507
|
* @example
|
|
1521
1508
|
* {
|
|
@@ -1548,9 +1535,12 @@ export interface UpdateResourceServerRequestContent {
|
|
|
1548
1535
|
allow_online_access_with_ephemeral_sessions?: boolean;
|
|
1549
1536
|
/** Expiration value (in seconds) for access tokens issued for this API from the token endpoint. */
|
|
1550
1537
|
token_lifetime?: number;
|
|
1538
|
+
/** Expiration value (in seconds) for anonymous-session access tokens issued for this API. */
|
|
1539
|
+
token_lifetime_for_anonymous_access_tokens?: number | null;
|
|
1551
1540
|
token_dialect?: Management.ResourceServerTokenDialectSchemaEnum;
|
|
1552
1541
|
/** Whether authorization policies are enforced (true) or not enforced (false). */
|
|
1553
1542
|
enforce_policies?: boolean;
|
|
1543
|
+
access_token?: Management.ResourceServerAccessToken | null;
|
|
1554
1544
|
token_encryption?: Management.ResourceServerTokenEncryption | null;
|
|
1555
1545
|
consent_policy?: Management.ResourceServerConsentPolicyEnum | null;
|
|
1556
1546
|
authorization_details?: unknown[] | null;
|
|
@@ -2834,6 +2824,16 @@ export interface CreateEventStreamRedeliveryRequestContent {
|
|
|
2834
2824
|
/** Filter by event type */
|
|
2835
2825
|
event_types?: Management.EventStreamEventTypeEnum[];
|
|
2836
2826
|
}
|
|
2827
|
+
/**
|
|
2828
|
+
* @example
|
|
2829
|
+
* {
|
|
2830
|
+
* target_level: 1
|
|
2831
|
+
* }
|
|
2832
|
+
*/
|
|
2833
|
+
export interface AdvanceRampRequestContent {
|
|
2834
|
+
/** The target percentage level from the experiment schedule. Must be the immediate next level. */
|
|
2835
|
+
target_level: number;
|
|
2836
|
+
}
|
|
2837
2837
|
/**
|
|
2838
2838
|
* @example
|
|
2839
2839
|
* {
|
|
@@ -2966,6 +2966,19 @@ export interface SetGuardianFactorRequestContent {
|
|
|
2966
2966
|
/** Whether this factor is enabled (true) or disabled (false). */
|
|
2967
2967
|
enabled: boolean;
|
|
2968
2968
|
}
|
|
2969
|
+
/**
|
|
2970
|
+
* @example
|
|
2971
|
+
* {
|
|
2972
|
+
* otp_length: 1,
|
|
2973
|
+
* otp_expiration_time: 1
|
|
2974
|
+
* }
|
|
2975
|
+
*/
|
|
2976
|
+
export interface SetEmailFactorSettingsRequestContent {
|
|
2977
|
+
/** The length of the OTP code. */
|
|
2978
|
+
otp_length: number;
|
|
2979
|
+
/** The OTP expiration time in seconds. */
|
|
2980
|
+
otp_expiration_time: number;
|
|
2981
|
+
}
|
|
2969
2982
|
/**
|
|
2970
2983
|
* @example
|
|
2971
2984
|
* {
|
|
@@ -2999,6 +3012,19 @@ export interface SetGuardianFactorsProviderPhoneTwilioRequestContent {
|
|
|
2999
3012
|
export interface SetGuardianFactorsProviderPhoneRequestContent {
|
|
3000
3013
|
provider: Management.GuardianFactorsProviderSmsProviderEnum;
|
|
3001
3014
|
}
|
|
3015
|
+
/**
|
|
3016
|
+
* @example
|
|
3017
|
+
* {
|
|
3018
|
+
* otp_length: 1,
|
|
3019
|
+
* otp_expiration_time: 1
|
|
3020
|
+
* }
|
|
3021
|
+
*/
|
|
3022
|
+
export interface SetPhoneFactorSettingsRequestContent {
|
|
3023
|
+
/** The length of the OTP code. */
|
|
3024
|
+
otp_length: number;
|
|
3025
|
+
/** The OTP expiration time in seconds. */
|
|
3026
|
+
otp_expiration_time: number;
|
|
3027
|
+
}
|
|
3002
3028
|
/**
|
|
3003
3029
|
* @example
|
|
3004
3030
|
* {
|
|
@@ -3365,6 +3391,7 @@ export interface CreateOrganizationAllConnectionRequestParameters {
|
|
|
3365
3391
|
/** Determines whether organization signup should be enabled for this organization connection. Only applicable for database connections. Default: false. */
|
|
3366
3392
|
is_signup_enabled?: boolean;
|
|
3367
3393
|
organization_access_level?: Management.OrganizationAccessLevelEnum;
|
|
3394
|
+
organization_member_access_level?: Management.OrganizationMemberAccessLevelEnum;
|
|
3368
3395
|
/** Whether the connection is enabled for the organization. */
|
|
3369
3396
|
is_enabled?: boolean;
|
|
3370
3397
|
/** Connection identifier. */
|
|
@@ -3384,6 +3411,7 @@ export interface UpdateOrganizationConnectionRequestParameters {
|
|
|
3384
3411
|
/** Determines whether organization signup should be enabled for this organization connection. Only applicable for database connections. Default: false. */
|
|
3385
3412
|
is_signup_enabled?: boolean;
|
|
3386
3413
|
organization_access_level?: Management.OrganizationAccessLevelEnumWithNull | null;
|
|
3414
|
+
organization_member_access_level?: Management.OrganizationMemberAccessLevelEnumWithNull | null;
|
|
3387
3415
|
/** Whether the connection is enabled for the organization. */
|
|
3388
3416
|
is_enabled?: boolean | null;
|
|
3389
3417
|
}
|
|
@@ -3981,6 +4009,7 @@ export interface UpdateTenantSettingsRequestContent {
|
|
|
3981
4009
|
default_redirection_uri?: string;
|
|
3982
4010
|
/** Supported locales for the user interface */
|
|
3983
4011
|
enabled_locales?: Management.TenantSettingsSupportedLocalesEnum[];
|
|
4012
|
+
access_token?: Management.ResourceServerAccessToken | null;
|
|
3984
4013
|
security_headers?: Management.TenantSettingsNullableSecurityHeaders | null;
|
|
3985
4014
|
session_cookie?: Management.SessionCookieSchema | null;
|
|
3986
4015
|
sessions?: Management.TenantSettingsSessions | null;
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import type { BaseClientOptions } from "../../../../BaseClient.mjs";
|
|
2
|
+
import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.mjs";
|
|
3
|
+
import { ExperimentsClient } from "../resources/experiments/client/Client.mjs";
|
|
4
|
+
export declare namespace ExperimentationClient {
|
|
5
|
+
type Options = BaseClientOptions;
|
|
6
|
+
}
|
|
7
|
+
export declare class ExperimentationClient {
|
|
8
|
+
protected readonly _options: NormalizedClientOptionsWithAuth<ExperimentationClient.Options>;
|
|
9
|
+
protected _experiments: ExperimentsClient | undefined;
|
|
10
|
+
constructor(options: ExperimentationClient.Options);
|
|
11
|
+
get experiments(): ExperimentsClient;
|
|
12
|
+
}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
2
|
+
import { normalizeClientOptionsWithAuth } from "../../../../BaseClient.mjs";
|
|
3
|
+
import { ExperimentsClient } from "../resources/experiments/client/Client.mjs";
|
|
4
|
+
export class ExperimentationClient {
|
|
5
|
+
constructor(options) {
|
|
6
|
+
this._options = normalizeClientOptionsWithAuth(options);
|
|
7
|
+
}
|
|
8
|
+
get experiments() {
|
|
9
|
+
var _a;
|
|
10
|
+
return ((_a = this._experiments) !== null && _a !== void 0 ? _a : (this._experiments = new ExperimentsClient(this._options)));
|
|
11
|
+
}
|
|
12
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
package/dist/esm/management/api/resources/experimentation/resources/experiments/client/Client.d.mts
ADDED
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
import type { BaseClientOptions, BaseRequestOptions } from "../../../../../../BaseClient.mjs";
|
|
2
|
+
import { type NormalizedClientOptionsWithAuth } from "../../../../../../BaseClient.mjs";
|
|
3
|
+
import * as core from "../../../../../../core/index.mjs";
|
|
4
|
+
import * as Management from "../../../../../index.mjs";
|
|
5
|
+
export declare namespace ExperimentsClient {
|
|
6
|
+
type Options = BaseClientOptions;
|
|
7
|
+
interface RequestOptions extends BaseRequestOptions {
|
|
8
|
+
}
|
|
9
|
+
}
|
|
10
|
+
export declare class ExperimentsClient {
|
|
11
|
+
protected readonly _options: NormalizedClientOptionsWithAuth<ExperimentsClient.Options>;
|
|
12
|
+
constructor(options: ExperimentsClient.Options);
|
|
13
|
+
/**
|
|
14
|
+
* Increments the current ramp index to the requested target level. Up-only: the target must be the immediate next level in the schedule. Idempotent: calling with the current level returns success without writing anything.
|
|
15
|
+
*
|
|
16
|
+
* @param {string} id - The ID of the experiment to advance.
|
|
17
|
+
* @param {Management.AdvanceRampRequestContent} request
|
|
18
|
+
* @param {ExperimentsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
19
|
+
*
|
|
20
|
+
* @throws {@link Management.BadRequestError}
|
|
21
|
+
* @throws {@link Management.UnauthorizedError}
|
|
22
|
+
* @throws {@link Management.ForbiddenError}
|
|
23
|
+
* @throws {@link Management.NotFoundError}
|
|
24
|
+
* @throws {@link Management.ConflictError}
|
|
25
|
+
* @throws {@link Management.TooManyRequestsError}
|
|
26
|
+
*
|
|
27
|
+
* @example
|
|
28
|
+
* await client.experimentation.experiments.advanceRamp("id", {
|
|
29
|
+
* target_level: 1
|
|
30
|
+
* })
|
|
31
|
+
*/
|
|
32
|
+
advanceRamp(id: string, request: Management.AdvanceRampRequestContent, requestOptions?: ExperimentsClient.RequestOptions): core.HttpResponsePromise<Management.AdvanceRampResponseContent>;
|
|
33
|
+
private __advanceRamp;
|
|
34
|
+
}
|
package/dist/esm/management/api/resources/experimentation/resources/experiments/client/Client.mjs
ADDED
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
2
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
3
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
4
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
5
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
6
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
7
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
8
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
9
|
+
});
|
|
10
|
+
};
|
|
11
|
+
import { normalizeClientOptionsWithAuth } from "../../../../../../BaseClient.mjs";
|
|
12
|
+
import * as core from "../../../../../../core/index.mjs";
|
|
13
|
+
import { mergeHeaders } from "../../../../../../core/headers.mjs";
|
|
14
|
+
import * as environments from "../../../../../../environments.mjs";
|
|
15
|
+
import { handleNonStatusCodeError } from "../../../../../../errors/handleNonStatusCodeError.mjs";
|
|
16
|
+
import * as errors from "../../../../../../errors/index.mjs";
|
|
17
|
+
import * as Management from "../../../../../index.mjs";
|
|
18
|
+
export class ExperimentsClient {
|
|
19
|
+
constructor(options) {
|
|
20
|
+
this._options = normalizeClientOptionsWithAuth(options);
|
|
21
|
+
}
|
|
22
|
+
/**
|
|
23
|
+
* Increments the current ramp index to the requested target level. Up-only: the target must be the immediate next level in the schedule. Idempotent: calling with the current level returns success without writing anything.
|
|
24
|
+
*
|
|
25
|
+
* @param {string} id - The ID of the experiment to advance.
|
|
26
|
+
* @param {Management.AdvanceRampRequestContent} request
|
|
27
|
+
* @param {ExperimentsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
28
|
+
*
|
|
29
|
+
* @throws {@link Management.BadRequestError}
|
|
30
|
+
* @throws {@link Management.UnauthorizedError}
|
|
31
|
+
* @throws {@link Management.ForbiddenError}
|
|
32
|
+
* @throws {@link Management.NotFoundError}
|
|
33
|
+
* @throws {@link Management.ConflictError}
|
|
34
|
+
* @throws {@link Management.TooManyRequestsError}
|
|
35
|
+
*
|
|
36
|
+
* @example
|
|
37
|
+
* await client.experimentation.experiments.advanceRamp("id", {
|
|
38
|
+
* target_level: 1
|
|
39
|
+
* })
|
|
40
|
+
*/
|
|
41
|
+
advanceRamp(id, request, requestOptions) {
|
|
42
|
+
return core.HttpResponsePromise.fromPromise(this.__advanceRamp(id, request, requestOptions));
|
|
43
|
+
}
|
|
44
|
+
__advanceRamp(id, request, requestOptions) {
|
|
45
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
46
|
+
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
|
|
47
|
+
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
48
|
+
let _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
49
|
+
const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
|
|
50
|
+
url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.ManagementEnvironment.Default, `experimentation/experiments/${core.url.encodePathParam(id)}/advance-ramp`),
|
|
51
|
+
method: "POST",
|
|
52
|
+
headers: _headers,
|
|
53
|
+
contentType: "application/json",
|
|
54
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
|
|
55
|
+
requestType: "json",
|
|
56
|
+
body: request,
|
|
57
|
+
timeoutMs: ((_g = (_e = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _e !== void 0 ? _e : (_f = this._options) === null || _f === void 0 ? void 0 : _f.timeoutInSeconds) !== null && _g !== void 0 ? _g : 60) * 1000,
|
|
58
|
+
maxRetries: (_h = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _h !== void 0 ? _h : (_j = this._options) === null || _j === void 0 ? void 0 : _j.maxRetries,
|
|
59
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
60
|
+
fetchFn: (_k = this._options) === null || _k === void 0 ? void 0 : _k.fetch,
|
|
61
|
+
logging: this._options.logging,
|
|
62
|
+
});
|
|
63
|
+
if (_response.ok) {
|
|
64
|
+
return {
|
|
65
|
+
data: _response.body,
|
|
66
|
+
rawResponse: _response.rawResponse,
|
|
67
|
+
};
|
|
68
|
+
}
|
|
69
|
+
if (_response.error.reason === "status-code") {
|
|
70
|
+
switch (_response.error.statusCode) {
|
|
71
|
+
case 400:
|
|
72
|
+
throw new Management.BadRequestError(_response.error.body, _response.rawResponse);
|
|
73
|
+
case 401:
|
|
74
|
+
throw new Management.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
75
|
+
case 403:
|
|
76
|
+
throw new Management.ForbiddenError(_response.error.body, _response.rawResponse);
|
|
77
|
+
case 404:
|
|
78
|
+
throw new Management.NotFoundError(_response.error.body, _response.rawResponse);
|
|
79
|
+
case 409:
|
|
80
|
+
throw new Management.ConflictError(_response.error.body, _response.rawResponse);
|
|
81
|
+
case 429:
|
|
82
|
+
throw new Management.TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
83
|
+
default:
|
|
84
|
+
throw new errors.ManagementError({
|
|
85
|
+
statusCode: _response.error.statusCode,
|
|
86
|
+
body: _response.error.body,
|
|
87
|
+
rawResponse: _response.rawResponse,
|
|
88
|
+
});
|
|
89
|
+
}
|
|
90
|
+
}
|
|
91
|
+
return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/experimentation/experiments/{id}/advance-ramp");
|
|
92
|
+
});
|
|
93
|
+
}
|
|
94
|
+
}
|
package/dist/esm/management/api/resources/experimentation/resources/experiments/client/index.d.mts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
package/dist/esm/management/api/resources/experimentation/resources/experiments/client/index.mjs
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * as experiments from "./experiments/index.mjs";
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * as experiments from "./experiments/index.mjs";
|
|
@@ -1,10 +1,14 @@
|
|
|
1
|
-
import type { BaseClientOptions } from "../../../../BaseClient.mjs";
|
|
1
|
+
import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.mjs";
|
|
2
2
|
import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.mjs";
|
|
3
|
+
import * as core from "../../../../core/index.mjs";
|
|
4
|
+
import * as Management from "../../../index.mjs";
|
|
3
5
|
import { EnrollmentsClient } from "../resources/enrollments/client/Client.mjs";
|
|
4
6
|
import { FactorsClient } from "../resources/factors/client/Client.mjs";
|
|
5
7
|
import { PoliciesClient } from "../resources/policies/client/Client.mjs";
|
|
6
8
|
export declare namespace GuardianClient {
|
|
7
9
|
type Options = BaseClientOptions;
|
|
10
|
+
interface RequestOptions extends BaseRequestOptions {
|
|
11
|
+
}
|
|
8
12
|
}
|
|
9
13
|
export declare class GuardianClient {
|
|
10
14
|
protected readonly _options: NormalizedClientOptionsWithAuth<GuardianClient.Options>;
|
|
@@ -15,4 +19,39 @@ export declare class GuardianClient {
|
|
|
15
19
|
get enrollments(): EnrollmentsClient;
|
|
16
20
|
get factors(): FactorsClient;
|
|
17
21
|
get policies(): PoliciesClient;
|
|
22
|
+
/**
|
|
23
|
+
* TODO: Link this endpoint to relevant documentation when available.
|
|
24
|
+
*
|
|
25
|
+
* @param {GuardianClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
26
|
+
*
|
|
27
|
+
* @throws {@link Management.UnauthorizedError}
|
|
28
|
+
* @throws {@link Management.ForbiddenError}
|
|
29
|
+
* @throws {@link Management.TooManyRequestsError}
|
|
30
|
+
*
|
|
31
|
+
* @example
|
|
32
|
+
* await client.guardian.get()
|
|
33
|
+
*/
|
|
34
|
+
get(requestOptions?: GuardianClient.RequestOptions): core.HttpResponsePromise<Management.GetGuardianSettingsResponseContent>;
|
|
35
|
+
private __get;
|
|
36
|
+
/**
|
|
37
|
+
* Update a tenant's guardian settings such as Remember Me
|
|
38
|
+
*
|
|
39
|
+
* @param {Management.SetGuardianSettingsRequestContent} request
|
|
40
|
+
* @param {GuardianClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
41
|
+
*
|
|
42
|
+
* @throws {@link Management.BadRequestError}
|
|
43
|
+
* @throws {@link Management.UnauthorizedError}
|
|
44
|
+
* @throws {@link Management.ForbiddenError}
|
|
45
|
+
* @throws {@link Management.TooManyRequestsError}
|
|
46
|
+
*
|
|
47
|
+
* @example
|
|
48
|
+
* await client.guardian.set({
|
|
49
|
+
* display_remember_me_checkbox: true,
|
|
50
|
+
* remember_me_default_value: true,
|
|
51
|
+
* mfa_session_inactivity_timeout: 1,
|
|
52
|
+
* mfa_session_overall_timeout: 1
|
|
53
|
+
* })
|
|
54
|
+
*/
|
|
55
|
+
set(request: Management.SetGuardianSettingsRequestContent, requestOptions?: GuardianClient.RequestOptions): core.HttpResponsePromise<Management.SetGuardianSettingsResponseContent>;
|
|
56
|
+
private __set;
|
|
18
57
|
}
|