auth0 6.4.0 → 7.1.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/README.md +20 -15
- package/dist/cjs/index.d.ts +0 -2
- package/dist/cjs/index.js +0 -2
- package/dist/cjs/lib/errors.d.ts +0 -18
- package/dist/cjs/lib/errors.js +1 -25
- package/dist/cjs/lib/middleware/auth0-client-telemetry.d.ts +3 -7
- package/dist/cjs/lib/middleware/auth0-client-telemetry.js +1 -25
- package/dist/cjs/lib/models.d.ts +0 -24
- package/dist/cjs/lib/models.js +0 -53
- 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 +112 -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/{lib → management/api/resources/guardian/resources/factors/resources/email}/index.js +1 -2
- 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 +226 -51
- package/dist/cjs/management/api/types/types.js +37 -36
- package/dist/cjs/management/version.d.ts +1 -1
- package/dist/cjs/management/version.js +1 -1
- package/dist/cjs/management/wrapper/ManagementClient.d.ts +9 -2
- package/dist/cjs/management/wrapper/ManagementClient.js +0 -1
- package/dist/cjs/management/wrapper/token-provider.d.ts +4 -2
- package/dist/cjs/management/wrapper/token-provider.js +142 -11
- package/dist/cjs/utils.d.ts +0 -18
- package/dist/cjs/utils.js +1 -32
- package/dist/esm/index.d.mts +0 -2
- package/dist/esm/index.mjs +0 -2
- package/dist/esm/lib/errors.d.mts +0 -18
- package/dist/esm/lib/errors.mjs +0 -22
- package/dist/esm/lib/middleware/auth0-client-telemetry.d.mts +3 -7
- package/dist/esm/lib/middleware/auth0-client-telemetry.mjs +1 -25
- package/dist/esm/lib/models.d.mts +0 -24
- package/dist/esm/lib/models.mjs +1 -49
- 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 +112 -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 +226 -51
- package/dist/esm/management/api/types/types.mjs +34 -33
- package/dist/esm/management/version.d.mts +1 -1
- package/dist/esm/management/version.mjs +1 -1
- package/dist/esm/management/wrapper/ManagementClient.d.mts +9 -2
- package/dist/esm/management/wrapper/ManagementClient.mjs +0 -1
- package/dist/esm/management/wrapper/token-provider.d.mts +4 -2
- package/dist/esm/management/wrapper/token-provider.mjs +142 -11
- package/dist/esm/utils.d.mts +0 -18
- package/dist/esm/utils.mjs +0 -30
- package/package.json +45 -23
- package/reference.md +654 -389
- package/dist/cjs/auth/backchannel.d.ts +0 -158
- package/dist/cjs/auth/backchannel.js +0 -135
- package/dist/cjs/auth/base-auth-api.d.ts +0 -41
- package/dist/cjs/auth/base-auth-api.js +0 -109
- package/dist/cjs/auth/client-authentication.d.ts +0 -27
- package/dist/cjs/auth/client-authentication.js +0 -82
- package/dist/cjs/auth/database.d.ts +0 -157
- package/dist/cjs/auth/database.js +0 -94
- package/dist/cjs/auth/id-token-validator.d.ts +0 -18
- package/dist/cjs/auth/id-token-validator.js +0 -158
- package/dist/cjs/auth/index.d.ts +0 -65
- package/dist/cjs/auth/index.js +0 -80
- package/dist/cjs/auth/oauth.d.ts +0 -462
- package/dist/cjs/auth/oauth.js +0 -280
- package/dist/cjs/auth/passwordless.d.ts +0 -165
- package/dist/cjs/auth/passwordless.js +0 -173
- package/dist/cjs/auth/tokenExchange.d.ts +0 -166
- package/dist/cjs/auth/tokenExchange.js +0 -74
- package/dist/cjs/lib/index.d.ts +0 -3
- package/dist/cjs/lib/runtime.d.ts +0 -61
- package/dist/cjs/lib/runtime.js +0 -222
- 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/cjs/userinfo/index.d.ts +0 -87
- package/dist/cjs/userinfo/index.js +0 -104
- package/dist/esm/auth/backchannel.d.mts +0 -158
- package/dist/esm/auth/backchannel.mjs +0 -131
- package/dist/esm/auth/base-auth-api.d.mts +0 -41
- package/dist/esm/auth/base-auth-api.mjs +0 -103
- package/dist/esm/auth/client-authentication.d.mts +0 -27
- package/dist/esm/auth/client-authentication.mjs +0 -45
- package/dist/esm/auth/database.d.mts +0 -157
- package/dist/esm/auth/database.mjs +0 -90
- package/dist/esm/auth/id-token-validator.d.mts +0 -18
- package/dist/esm/auth/id-token-validator.mjs +0 -120
- package/dist/esm/auth/index.d.mts +0 -65
- package/dist/esm/auth/index.mjs +0 -60
- package/dist/esm/auth/oauth.d.mts +0 -462
- package/dist/esm/auth/oauth.mjs +0 -276
- package/dist/esm/auth/passwordless.d.mts +0 -165
- package/dist/esm/auth/passwordless.mjs +0 -169
- package/dist/esm/auth/tokenExchange.d.mts +0 -166
- package/dist/esm/auth/tokenExchange.mjs +0 -70
- package/dist/esm/lib/index.d.mts +0 -3
- package/dist/esm/lib/index.mjs +0 -2
- package/dist/esm/lib/runtime.d.mts +0 -61
- package/dist/esm/lib/runtime.mjs +0 -201
- 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/esm/userinfo/index.d.mts +0 -87
- package/dist/esm/userinfo/index.mjs +0 -98
- /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
package/reference.md
CHANGED
|
@@ -5442,6 +5442,131 @@ await client.groups.delete("id");
|
|
|
5442
5442
|
</dl>
|
|
5443
5443
|
</details>
|
|
5444
5444
|
|
|
5445
|
+
## Guardian
|
|
5446
|
+
|
|
5447
|
+
<details><summary><code>client.guardian.<a href="/src/management/api/resources/guardian/client/Client.ts">get</a>() -> Management.GetGuardianSettingsResponseContent</code></summary>
|
|
5448
|
+
<dl>
|
|
5449
|
+
<dd>
|
|
5450
|
+
|
|
5451
|
+
#### 📝 Description
|
|
5452
|
+
|
|
5453
|
+
<dl>
|
|
5454
|
+
<dd>
|
|
5455
|
+
|
|
5456
|
+
<dl>
|
|
5457
|
+
<dd>
|
|
5458
|
+
|
|
5459
|
+
TODO: Link this endpoint to relevant documentation when available.
|
|
5460
|
+
|
|
5461
|
+
</dd>
|
|
5462
|
+
</dl>
|
|
5463
|
+
</dd>
|
|
5464
|
+
</dl>
|
|
5465
|
+
|
|
5466
|
+
#### 🔌 Usage
|
|
5467
|
+
|
|
5468
|
+
<dl>
|
|
5469
|
+
<dd>
|
|
5470
|
+
|
|
5471
|
+
<dl>
|
|
5472
|
+
<dd>
|
|
5473
|
+
|
|
5474
|
+
```typescript
|
|
5475
|
+
await client.guardian.get();
|
|
5476
|
+
```
|
|
5477
|
+
|
|
5478
|
+
</dd>
|
|
5479
|
+
</dl>
|
|
5480
|
+
</dd>
|
|
5481
|
+
</dl>
|
|
5482
|
+
|
|
5483
|
+
#### ⚙️ Parameters
|
|
5484
|
+
|
|
5485
|
+
<dl>
|
|
5486
|
+
<dd>
|
|
5487
|
+
|
|
5488
|
+
<dl>
|
|
5489
|
+
<dd>
|
|
5490
|
+
|
|
5491
|
+
**requestOptions:** `GuardianClient.RequestOptions`
|
|
5492
|
+
|
|
5493
|
+
</dd>
|
|
5494
|
+
</dl>
|
|
5495
|
+
</dd>
|
|
5496
|
+
</dl>
|
|
5497
|
+
|
|
5498
|
+
</dd>
|
|
5499
|
+
</dl>
|
|
5500
|
+
</details>
|
|
5501
|
+
|
|
5502
|
+
<details><summary><code>client.guardian.<a href="/src/management/api/resources/guardian/client/Client.ts">set</a>({ ...params }) -> Management.SetGuardianSettingsResponseContent</code></summary>
|
|
5503
|
+
<dl>
|
|
5504
|
+
<dd>
|
|
5505
|
+
|
|
5506
|
+
#### 📝 Description
|
|
5507
|
+
|
|
5508
|
+
<dl>
|
|
5509
|
+
<dd>
|
|
5510
|
+
|
|
5511
|
+
<dl>
|
|
5512
|
+
<dd>
|
|
5513
|
+
|
|
5514
|
+
Update a tenant's guardian settings such as Remember Me
|
|
5515
|
+
|
|
5516
|
+
</dd>
|
|
5517
|
+
</dl>
|
|
5518
|
+
</dd>
|
|
5519
|
+
</dl>
|
|
5520
|
+
|
|
5521
|
+
#### 🔌 Usage
|
|
5522
|
+
|
|
5523
|
+
<dl>
|
|
5524
|
+
<dd>
|
|
5525
|
+
|
|
5526
|
+
<dl>
|
|
5527
|
+
<dd>
|
|
5528
|
+
|
|
5529
|
+
```typescript
|
|
5530
|
+
await client.guardian.set({
|
|
5531
|
+
display_remember_me_checkbox: true,
|
|
5532
|
+
remember_me_default_value: true,
|
|
5533
|
+
mfa_session_inactivity_timeout: 1,
|
|
5534
|
+
mfa_session_overall_timeout: 1,
|
|
5535
|
+
});
|
|
5536
|
+
```
|
|
5537
|
+
|
|
5538
|
+
</dd>
|
|
5539
|
+
</dl>
|
|
5540
|
+
</dd>
|
|
5541
|
+
</dl>
|
|
5542
|
+
|
|
5543
|
+
#### ⚙️ Parameters
|
|
5544
|
+
|
|
5545
|
+
<dl>
|
|
5546
|
+
<dd>
|
|
5547
|
+
|
|
5548
|
+
<dl>
|
|
5549
|
+
<dd>
|
|
5550
|
+
|
|
5551
|
+
**request:** `Management.SetGuardianSettingsRequestContent`
|
|
5552
|
+
|
|
5553
|
+
</dd>
|
|
5554
|
+
</dl>
|
|
5555
|
+
|
|
5556
|
+
<dl>
|
|
5557
|
+
<dd>
|
|
5558
|
+
|
|
5559
|
+
**requestOptions:** `GuardianClient.RequestOptions`
|
|
5560
|
+
|
|
5561
|
+
</dd>
|
|
5562
|
+
</dl>
|
|
5563
|
+
</dd>
|
|
5564
|
+
</dl>
|
|
5565
|
+
|
|
5566
|
+
</dd>
|
|
5567
|
+
</dl>
|
|
5568
|
+
</details>
|
|
5569
|
+
|
|
5445
5570
|
## Hooks
|
|
5446
5571
|
|
|
5447
5572
|
<details><summary><code>client.hooks.<a href="/src/management/api/resources/hooks/client/Client.ts">list</a>({ ...params }) -> core.Page<Management.Hook, Management.ListHooksOffsetPaginatedResponseContent></code></summary>
|
|
@@ -7309,9 +7434,9 @@ await client.networkAcls.update("id");
|
|
|
7309
7434
|
</dl>
|
|
7310
7435
|
</details>
|
|
7311
7436
|
|
|
7312
|
-
##
|
|
7437
|
+
## Organizations
|
|
7313
7438
|
|
|
7314
|
-
<details><summary><code>client.
|
|
7439
|
+
<details><summary><code>client.organizations.<a href="/src/management/api/resources/organizations/client/Client.ts">list</a>({ ...params }) -> core.Page<Management.Organization, Management.ListOrganizationsPaginatedResponseContent></code></summary>
|
|
7315
7440
|
<dl>
|
|
7316
7441
|
<dd>
|
|
7317
7442
|
|
|
@@ -7323,7 +7448,23 @@ await client.networkAcls.update("id");
|
|
|
7323
7448
|
<dl>
|
|
7324
7449
|
<dd>
|
|
7325
7450
|
|
|
7326
|
-
Retrieve
|
|
7451
|
+
Retrieve detailed list of all Organizations available in your tenant. For more information, see Auth0 Organizations.
|
|
7452
|
+
|
|
7453
|
+
This endpoint supports two types of pagination:
|
|
7454
|
+
|
|
7455
|
+
- Offset pagination
|
|
7456
|
+
- Checkpoint pagination
|
|
7457
|
+
|
|
7458
|
+
Checkpoint pagination must be used if you need to retrieve more than 1000 organizations.
|
|
7459
|
+
|
|
7460
|
+
**Checkpoint Pagination**
|
|
7461
|
+
|
|
7462
|
+
To search by checkpoint, use the following parameters:
|
|
7463
|
+
|
|
7464
|
+
- `from`: Optional id from which to start selection.
|
|
7465
|
+
- `take`: The total number of entries to retrieve when using the `from` parameter. Defaults to 50.
|
|
7466
|
+
|
|
7467
|
+
**Note**: The first time you call this endpoint using checkpoint pagination, omit the `from` parameter. If there are more results, a `next` value is included in the response. You can use this for subsequent API calls. When `next` is no longer included in the response, no pages are remaining.
|
|
7327
7468
|
|
|
7328
7469
|
</dd>
|
|
7329
7470
|
</dl>
|
|
@@ -7339,18 +7480,24 @@ Retrieve a list of Organization Templates. This endpoint supports Checkpoint pag
|
|
|
7339
7480
|
<dd>
|
|
7340
7481
|
|
|
7341
7482
|
```typescript
|
|
7342
|
-
const pageableResponse = await client.
|
|
7483
|
+
const pageableResponse = await client.organizations.list({
|
|
7484
|
+
include_totals: true,
|
|
7343
7485
|
from: "from",
|
|
7344
7486
|
take: 1,
|
|
7487
|
+
sort: "sort",
|
|
7488
|
+
include_client_association_for: "include_client_association_for",
|
|
7345
7489
|
});
|
|
7346
7490
|
for await (const item of pageableResponse) {
|
|
7347
7491
|
console.log(item);
|
|
7348
7492
|
}
|
|
7349
7493
|
|
|
7350
7494
|
// Or you can manually iterate page-by-page
|
|
7351
|
-
let page = await client.
|
|
7495
|
+
let page = await client.organizations.list({
|
|
7496
|
+
include_totals: true,
|
|
7352
7497
|
from: "from",
|
|
7353
7498
|
take: 1,
|
|
7499
|
+
sort: "sort",
|
|
7500
|
+
include_client_association_for: "include_client_association_for",
|
|
7354
7501
|
});
|
|
7355
7502
|
while (page.hasNextPage()) {
|
|
7356
7503
|
page = page.getNextPage();
|
|
@@ -7373,7 +7520,7 @@ const response = page.response;
|
|
|
7373
7520
|
<dl>
|
|
7374
7521
|
<dd>
|
|
7375
7522
|
|
|
7376
|
-
**request:** `Management.
|
|
7523
|
+
**request:** `Management.ListOrganizationsRequestParameters`
|
|
7377
7524
|
|
|
7378
7525
|
</dd>
|
|
7379
7526
|
</dl>
|
|
@@ -7381,7 +7528,7 @@ const response = page.response;
|
|
|
7381
7528
|
<dl>
|
|
7382
7529
|
<dd>
|
|
7383
7530
|
|
|
7384
|
-
**requestOptions:** `
|
|
7531
|
+
**requestOptions:** `OrganizationsClient.RequestOptions`
|
|
7385
7532
|
|
|
7386
7533
|
</dd>
|
|
7387
7534
|
</dl>
|
|
@@ -7392,7 +7539,7 @@ const response = page.response;
|
|
|
7392
7539
|
</dl>
|
|
7393
7540
|
</details>
|
|
7394
7541
|
|
|
7395
|
-
<details><summary><code>client.
|
|
7542
|
+
<details><summary><code>client.organizations.<a href="/src/management/api/resources/organizations/client/Client.ts">create</a>({ ...params }) -> Management.CreateOrganizationResponseContent</code></summary>
|
|
7396
7543
|
<dl>
|
|
7397
7544
|
<dd>
|
|
7398
7545
|
|
|
@@ -7404,7 +7551,7 @@ const response = page.response;
|
|
|
7404
7551
|
<dl>
|
|
7405
7552
|
<dd>
|
|
7406
7553
|
|
|
7407
|
-
Create
|
|
7554
|
+
Create a new Organization within your tenant. To learn more about Organization settings, behavior, and configuration options, review [Create Your First Organization](https://auth0.com/docs/manage-users/organizations/create-first-organization).
|
|
7408
7555
|
|
|
7409
7556
|
</dd>
|
|
7410
7557
|
</dl>
|
|
@@ -7420,11 +7567,8 @@ Create an Organization Template.
|
|
|
7420
7567
|
<dd>
|
|
7421
7568
|
|
|
7422
7569
|
```typescript
|
|
7423
|
-
await client.
|
|
7570
|
+
await client.organizations.create({
|
|
7424
7571
|
name: "name",
|
|
7425
|
-
organization_deletion_behavior: "allow",
|
|
7426
|
-
enforce_permission_ceiling: true,
|
|
7427
|
-
enforce_self_assignment_restriction: true,
|
|
7428
7572
|
});
|
|
7429
7573
|
```
|
|
7430
7574
|
|
|
@@ -7441,7 +7585,7 @@ await client.organizationTemplates.create({
|
|
|
7441
7585
|
<dl>
|
|
7442
7586
|
<dd>
|
|
7443
7587
|
|
|
7444
|
-
**request:** `Management.
|
|
7588
|
+
**request:** `Management.CreateOrganizationRequestContent`
|
|
7445
7589
|
|
|
7446
7590
|
</dd>
|
|
7447
7591
|
</dl>
|
|
@@ -7449,7 +7593,7 @@ await client.organizationTemplates.create({
|
|
|
7449
7593
|
<dl>
|
|
7450
7594
|
<dd>
|
|
7451
7595
|
|
|
7452
|
-
**requestOptions:** `
|
|
7596
|
+
**requestOptions:** `OrganizationsClient.RequestOptions`
|
|
7453
7597
|
|
|
7454
7598
|
</dd>
|
|
7455
7599
|
</dl>
|
|
@@ -7460,7 +7604,7 @@ await client.organizationTemplates.create({
|
|
|
7460
7604
|
</dl>
|
|
7461
7605
|
</details>
|
|
7462
7606
|
|
|
7463
|
-
<details><summary><code>client.
|
|
7607
|
+
<details><summary><code>client.organizations.<a href="/src/management/api/resources/organizations/client/Client.ts">getByName</a>(name) -> Management.GetOrganizationByNameResponseContent</code></summary>
|
|
7464
7608
|
<dl>
|
|
7465
7609
|
<dd>
|
|
7466
7610
|
|
|
@@ -7472,7 +7616,7 @@ await client.organizationTemplates.create({
|
|
|
7472
7616
|
<dl>
|
|
7473
7617
|
<dd>
|
|
7474
7618
|
|
|
7475
|
-
Retrieve details about a single Organization
|
|
7619
|
+
Retrieve details about a single Organization specified by name.
|
|
7476
7620
|
|
|
7477
7621
|
</dd>
|
|
7478
7622
|
</dl>
|
|
@@ -7488,7 +7632,7 @@ Retrieve details about a single Organization Template specified by ID.
|
|
|
7488
7632
|
<dd>
|
|
7489
7633
|
|
|
7490
7634
|
```typescript
|
|
7491
|
-
await client.
|
|
7635
|
+
await client.organizations.getByName("name");
|
|
7492
7636
|
```
|
|
7493
7637
|
|
|
7494
7638
|
</dd>
|
|
@@ -7504,7 +7648,7 @@ await client.organizationTemplates.get("id");
|
|
|
7504
7648
|
<dl>
|
|
7505
7649
|
<dd>
|
|
7506
7650
|
|
|
7507
|
-
**
|
|
7651
|
+
**name:** `string` — name of the organization to retrieve.
|
|
7508
7652
|
|
|
7509
7653
|
</dd>
|
|
7510
7654
|
</dl>
|
|
@@ -7512,7 +7656,7 @@ await client.organizationTemplates.get("id");
|
|
|
7512
7656
|
<dl>
|
|
7513
7657
|
<dd>
|
|
7514
7658
|
|
|
7515
|
-
**requestOptions:** `
|
|
7659
|
+
**requestOptions:** `OrganizationsClient.RequestOptions`
|
|
7516
7660
|
|
|
7517
7661
|
</dd>
|
|
7518
7662
|
</dl>
|
|
@@ -7523,7 +7667,7 @@ await client.organizationTemplates.get("id");
|
|
|
7523
7667
|
</dl>
|
|
7524
7668
|
</details>
|
|
7525
7669
|
|
|
7526
|
-
<details><summary><code>client.
|
|
7670
|
+
<details><summary><code>client.organizations.<a href="/src/management/api/resources/organizations/client/Client.ts">search</a>({ ...params }) -> core.Page<Management.SearchOrganization, Management.SearchOrganizationsPaginatedResponseContent></code></summary>
|
|
7527
7671
|
<dl>
|
|
7528
7672
|
<dd>
|
|
7529
7673
|
|
|
@@ -7535,7 +7679,21 @@ await client.organizationTemplates.get("id");
|
|
|
7535
7679
|
<dl>
|
|
7536
7680
|
<dd>
|
|
7537
7681
|
|
|
7538
|
-
|
|
7682
|
+
Retrieve details of organizations matching a search criteria. It is possible to:
|
|
7683
|
+
|
|
7684
|
+
- Specify a search criteria for organizations
|
|
7685
|
+
- Search via `name`
|
|
7686
|
+
- Search via `display_name`
|
|
7687
|
+
- Substring matching (`contains` and `ends-with`) requires at least 3 characters
|
|
7688
|
+
- Use wildcards
|
|
7689
|
+
|
|
7690
|
+
The `q` query parameter can be used to get organizations that match the specified criteria on `name` OR `display_name`.
|
|
7691
|
+
|
|
7692
|
+
This endpoint supports SCIM or Lucene filter syntax with low-latency, cursor-based pagination. Use the `parser` parameter to specify "scim" or "lucene" syntax (default: "lucene").
|
|
7693
|
+
|
|
7694
|
+
Results are eventually consistent and may not reflect recent updates immediately.
|
|
7695
|
+
|
|
7696
|
+
**Sortable fields:** `name`, `display_name`, `created_at` (ascending only). Defaults to insertion order (oldest first).
|
|
7539
7697
|
|
|
7540
7698
|
</dd>
|
|
7541
7699
|
</dl>
|
|
@@ -7551,7 +7709,31 @@ Update the details of a specific Organization Template.
|
|
|
7551
7709
|
<dd>
|
|
7552
7710
|
|
|
7553
7711
|
```typescript
|
|
7554
|
-
await client.
|
|
7712
|
+
const pageableResponse = await client.organizations.search({
|
|
7713
|
+
q: "q",
|
|
7714
|
+
parser: "scim",
|
|
7715
|
+
take: 1,
|
|
7716
|
+
from: "from",
|
|
7717
|
+
sort: "name",
|
|
7718
|
+
});
|
|
7719
|
+
for await (const item of pageableResponse) {
|
|
7720
|
+
console.log(item);
|
|
7721
|
+
}
|
|
7722
|
+
|
|
7723
|
+
// Or you can manually iterate page-by-page
|
|
7724
|
+
let page = await client.organizations.search({
|
|
7725
|
+
q: "q",
|
|
7726
|
+
parser: "scim",
|
|
7727
|
+
take: 1,
|
|
7728
|
+
from: "from",
|
|
7729
|
+
sort: "name",
|
|
7730
|
+
});
|
|
7731
|
+
while (page.hasNextPage()) {
|
|
7732
|
+
page = page.getNextPage();
|
|
7733
|
+
}
|
|
7734
|
+
|
|
7735
|
+
// You can also access the underlying response
|
|
7736
|
+
const response = page.response;
|
|
7555
7737
|
```
|
|
7556
7738
|
|
|
7557
7739
|
</dd>
|
|
@@ -7567,15 +7749,7 @@ await client.organizationTemplates.update("id");
|
|
|
7567
7749
|
<dl>
|
|
7568
7750
|
<dd>
|
|
7569
7751
|
|
|
7570
|
-
**
|
|
7571
|
-
|
|
7572
|
-
</dd>
|
|
7573
|
-
</dl>
|
|
7574
|
-
|
|
7575
|
-
<dl>
|
|
7576
|
-
<dd>
|
|
7577
|
-
|
|
7578
|
-
**request:** `Management.UpdateOrganizationTemplateRequestContent`
|
|
7752
|
+
**request:** `Management.SearchOrganizationsRequestParameters`
|
|
7579
7753
|
|
|
7580
7754
|
</dd>
|
|
7581
7755
|
</dl>
|
|
@@ -7583,7 +7757,7 @@ await client.organizationTemplates.update("id");
|
|
|
7583
7757
|
<dl>
|
|
7584
7758
|
<dd>
|
|
7585
7759
|
|
|
7586
|
-
**requestOptions:** `
|
|
7760
|
+
**requestOptions:** `OrganizationsClient.RequestOptions`
|
|
7587
7761
|
|
|
7588
7762
|
</dd>
|
|
7589
7763
|
</dl>
|
|
@@ -7594,7 +7768,7 @@ await client.organizationTemplates.update("id");
|
|
|
7594
7768
|
</dl>
|
|
7595
7769
|
</details>
|
|
7596
7770
|
|
|
7597
|
-
<details><summary><code>client.
|
|
7771
|
+
<details><summary><code>client.organizations.<a href="/src/management/api/resources/organizations/client/Client.ts">get</a>(id) -> Management.GetOrganizationResponseContent</code></summary>
|
|
7598
7772
|
<dl>
|
|
7599
7773
|
<dd>
|
|
7600
7774
|
|
|
@@ -7606,7 +7780,7 @@ await client.organizationTemplates.update("id");
|
|
|
7606
7780
|
<dl>
|
|
7607
7781
|
<dd>
|
|
7608
7782
|
|
|
7609
|
-
Retrieve
|
|
7783
|
+
Retrieve details about a single Organization specified by ID.
|
|
7610
7784
|
|
|
7611
7785
|
</dd>
|
|
7612
7786
|
</dl>
|
|
@@ -7622,25 +7796,7 @@ Retrieve a list of organizations assigned to an Organization Template. This endp
|
|
|
7622
7796
|
<dd>
|
|
7623
7797
|
|
|
7624
7798
|
```typescript
|
|
7625
|
-
|
|
7626
|
-
from: "from",
|
|
7627
|
-
take: 1,
|
|
7628
|
-
});
|
|
7629
|
-
for await (const item of pageableResponse) {
|
|
7630
|
-
console.log(item);
|
|
7631
|
-
}
|
|
7632
|
-
|
|
7633
|
-
// Or you can manually iterate page-by-page
|
|
7634
|
-
let page = await client.organizationTemplates.listOrganizations("id", {
|
|
7635
|
-
from: "from",
|
|
7636
|
-
take: 1,
|
|
7637
|
-
});
|
|
7638
|
-
while (page.hasNextPage()) {
|
|
7639
|
-
page = page.getNextPage();
|
|
7640
|
-
}
|
|
7641
|
-
|
|
7642
|
-
// You can also access the underlying response
|
|
7643
|
-
const response = page.response;
|
|
7799
|
+
await client.organizations.get("id");
|
|
7644
7800
|
```
|
|
7645
7801
|
|
|
7646
7802
|
</dd>
|
|
@@ -7656,15 +7812,7 @@ const response = page.response;
|
|
|
7656
7812
|
<dl>
|
|
7657
7813
|
<dd>
|
|
7658
7814
|
|
|
7659
|
-
**id:** `string` —
|
|
7660
|
-
|
|
7661
|
-
</dd>
|
|
7662
|
-
</dl>
|
|
7663
|
-
|
|
7664
|
-
<dl>
|
|
7665
|
-
<dd>
|
|
7666
|
-
|
|
7667
|
-
**request:** `Management.ListTemplateOrganizationsRequestParameters`
|
|
7815
|
+
**id:** `string` — ID of the organization to retrieve.
|
|
7668
7816
|
|
|
7669
7817
|
</dd>
|
|
7670
7818
|
</dl>
|
|
@@ -7672,7 +7820,7 @@ const response = page.response;
|
|
|
7672
7820
|
<dl>
|
|
7673
7821
|
<dd>
|
|
7674
7822
|
|
|
7675
|
-
**requestOptions:** `
|
|
7823
|
+
**requestOptions:** `OrganizationsClient.RequestOptions`
|
|
7676
7824
|
|
|
7677
7825
|
</dd>
|
|
7678
7826
|
</dl>
|
|
@@ -7683,9 +7831,7 @@ const response = page.response;
|
|
|
7683
7831
|
</dl>
|
|
7684
7832
|
</details>
|
|
7685
7833
|
|
|
7686
|
-
|
|
7687
|
-
|
|
7688
|
-
<details><summary><code>client.organizations.<a href="/src/management/api/resources/organizations/client/Client.ts">list</a>({ ...params }) -> core.Page<Management.Organization, Management.ListOrganizationsPaginatedResponseContent></code></summary>
|
|
7834
|
+
<details><summary><code>client.organizations.<a href="/src/management/api/resources/organizations/client/Client.ts">delete</a>(id) -> void</code></summary>
|
|
7689
7835
|
<dl>
|
|
7690
7836
|
<dd>
|
|
7691
7837
|
|
|
@@ -7697,30 +7843,33 @@ const response = page.response;
|
|
|
7697
7843
|
<dl>
|
|
7698
7844
|
<dd>
|
|
7699
7845
|
|
|
7700
|
-
|
|
7701
|
-
|
|
7702
|
-
This endpoint supports two types of pagination:
|
|
7846
|
+
Remove an Organization from your tenant. This action cannot be undone.
|
|
7703
7847
|
|
|
7704
|
-
|
|
7705
|
-
- Checkpoint pagination
|
|
7848
|
+
**Note**: Members are automatically disassociated from an Organization when it is deleted. However, this action does **not** delete these users from your tenant.
|
|
7706
7849
|
|
|
7707
|
-
|
|
7850
|
+
</dd>
|
|
7851
|
+
</dl>
|
|
7852
|
+
</dd>
|
|
7853
|
+
</dl>
|
|
7708
7854
|
|
|
7709
|
-
|
|
7855
|
+
#### 🔌 Usage
|
|
7710
7856
|
|
|
7711
|
-
|
|
7857
|
+
<dl>
|
|
7858
|
+
<dd>
|
|
7712
7859
|
|
|
7713
|
-
|
|
7714
|
-
|
|
7860
|
+
<dl>
|
|
7861
|
+
<dd>
|
|
7715
7862
|
|
|
7716
|
-
|
|
7863
|
+
```typescript
|
|
7864
|
+
await client.organizations.delete("id");
|
|
7865
|
+
```
|
|
7717
7866
|
|
|
7718
7867
|
</dd>
|
|
7719
7868
|
</dl>
|
|
7720
7869
|
</dd>
|
|
7721
7870
|
</dl>
|
|
7722
7871
|
|
|
7723
|
-
####
|
|
7872
|
+
#### ⚙️ Parameters
|
|
7724
7873
|
|
|
7725
7874
|
<dl>
|
|
7726
7875
|
<dd>
|
|
@@ -7728,304 +7877,7 @@ To search by checkpoint, use the following parameters:
|
|
|
7728
7877
|
<dl>
|
|
7729
7878
|
<dd>
|
|
7730
7879
|
|
|
7731
|
-
|
|
7732
|
-
const pageableResponse = await client.organizations.list({
|
|
7733
|
-
include_totals: true,
|
|
7734
|
-
from: "from",
|
|
7735
|
-
take: 1,
|
|
7736
|
-
sort: "sort",
|
|
7737
|
-
include_client_association_for: "include_client_association_for",
|
|
7738
|
-
});
|
|
7739
|
-
for await (const item of pageableResponse) {
|
|
7740
|
-
console.log(item);
|
|
7741
|
-
}
|
|
7742
|
-
|
|
7743
|
-
// Or you can manually iterate page-by-page
|
|
7744
|
-
let page = await client.organizations.list({
|
|
7745
|
-
include_totals: true,
|
|
7746
|
-
from: "from",
|
|
7747
|
-
take: 1,
|
|
7748
|
-
sort: "sort",
|
|
7749
|
-
include_client_association_for: "include_client_association_for",
|
|
7750
|
-
});
|
|
7751
|
-
while (page.hasNextPage()) {
|
|
7752
|
-
page = page.getNextPage();
|
|
7753
|
-
}
|
|
7754
|
-
|
|
7755
|
-
// You can also access the underlying response
|
|
7756
|
-
const response = page.response;
|
|
7757
|
-
```
|
|
7758
|
-
|
|
7759
|
-
</dd>
|
|
7760
|
-
</dl>
|
|
7761
|
-
</dd>
|
|
7762
|
-
</dl>
|
|
7763
|
-
|
|
7764
|
-
#### ⚙️ Parameters
|
|
7765
|
-
|
|
7766
|
-
<dl>
|
|
7767
|
-
<dd>
|
|
7768
|
-
|
|
7769
|
-
<dl>
|
|
7770
|
-
<dd>
|
|
7771
|
-
|
|
7772
|
-
**request:** `Management.ListOrganizationsRequestParameters`
|
|
7773
|
-
|
|
7774
|
-
</dd>
|
|
7775
|
-
</dl>
|
|
7776
|
-
|
|
7777
|
-
<dl>
|
|
7778
|
-
<dd>
|
|
7779
|
-
|
|
7780
|
-
**requestOptions:** `OrganizationsClient.RequestOptions`
|
|
7781
|
-
|
|
7782
|
-
</dd>
|
|
7783
|
-
</dl>
|
|
7784
|
-
</dd>
|
|
7785
|
-
</dl>
|
|
7786
|
-
|
|
7787
|
-
</dd>
|
|
7788
|
-
</dl>
|
|
7789
|
-
</details>
|
|
7790
|
-
|
|
7791
|
-
<details><summary><code>client.organizations.<a href="/src/management/api/resources/organizations/client/Client.ts">create</a>({ ...params }) -> Management.CreateOrganizationResponseContent</code></summary>
|
|
7792
|
-
<dl>
|
|
7793
|
-
<dd>
|
|
7794
|
-
|
|
7795
|
-
#### 📝 Description
|
|
7796
|
-
|
|
7797
|
-
<dl>
|
|
7798
|
-
<dd>
|
|
7799
|
-
|
|
7800
|
-
<dl>
|
|
7801
|
-
<dd>
|
|
7802
|
-
|
|
7803
|
-
Create a new Organization within your tenant. To learn more about Organization settings, behavior, and configuration options, review [Create Your First Organization](https://auth0.com/docs/manage-users/organizations/create-first-organization).
|
|
7804
|
-
|
|
7805
|
-
</dd>
|
|
7806
|
-
</dl>
|
|
7807
|
-
</dd>
|
|
7808
|
-
</dl>
|
|
7809
|
-
|
|
7810
|
-
#### 🔌 Usage
|
|
7811
|
-
|
|
7812
|
-
<dl>
|
|
7813
|
-
<dd>
|
|
7814
|
-
|
|
7815
|
-
<dl>
|
|
7816
|
-
<dd>
|
|
7817
|
-
|
|
7818
|
-
```typescript
|
|
7819
|
-
await client.organizations.create({
|
|
7820
|
-
name: "name",
|
|
7821
|
-
});
|
|
7822
|
-
```
|
|
7823
|
-
|
|
7824
|
-
</dd>
|
|
7825
|
-
</dl>
|
|
7826
|
-
</dd>
|
|
7827
|
-
</dl>
|
|
7828
|
-
|
|
7829
|
-
#### ⚙️ Parameters
|
|
7830
|
-
|
|
7831
|
-
<dl>
|
|
7832
|
-
<dd>
|
|
7833
|
-
|
|
7834
|
-
<dl>
|
|
7835
|
-
<dd>
|
|
7836
|
-
|
|
7837
|
-
**request:** `Management.CreateOrganizationRequestContent`
|
|
7838
|
-
|
|
7839
|
-
</dd>
|
|
7840
|
-
</dl>
|
|
7841
|
-
|
|
7842
|
-
<dl>
|
|
7843
|
-
<dd>
|
|
7844
|
-
|
|
7845
|
-
**requestOptions:** `OrganizationsClient.RequestOptions`
|
|
7846
|
-
|
|
7847
|
-
</dd>
|
|
7848
|
-
</dl>
|
|
7849
|
-
</dd>
|
|
7850
|
-
</dl>
|
|
7851
|
-
|
|
7852
|
-
</dd>
|
|
7853
|
-
</dl>
|
|
7854
|
-
</details>
|
|
7855
|
-
|
|
7856
|
-
<details><summary><code>client.organizations.<a href="/src/management/api/resources/organizations/client/Client.ts">getByName</a>(name) -> Management.GetOrganizationByNameResponseContent</code></summary>
|
|
7857
|
-
<dl>
|
|
7858
|
-
<dd>
|
|
7859
|
-
|
|
7860
|
-
#### 📝 Description
|
|
7861
|
-
|
|
7862
|
-
<dl>
|
|
7863
|
-
<dd>
|
|
7864
|
-
|
|
7865
|
-
<dl>
|
|
7866
|
-
<dd>
|
|
7867
|
-
|
|
7868
|
-
Retrieve details about a single Organization specified by name.
|
|
7869
|
-
|
|
7870
|
-
</dd>
|
|
7871
|
-
</dl>
|
|
7872
|
-
</dd>
|
|
7873
|
-
</dl>
|
|
7874
|
-
|
|
7875
|
-
#### 🔌 Usage
|
|
7876
|
-
|
|
7877
|
-
<dl>
|
|
7878
|
-
<dd>
|
|
7879
|
-
|
|
7880
|
-
<dl>
|
|
7881
|
-
<dd>
|
|
7882
|
-
|
|
7883
|
-
```typescript
|
|
7884
|
-
await client.organizations.getByName("name");
|
|
7885
|
-
```
|
|
7886
|
-
|
|
7887
|
-
</dd>
|
|
7888
|
-
</dl>
|
|
7889
|
-
</dd>
|
|
7890
|
-
</dl>
|
|
7891
|
-
|
|
7892
|
-
#### ⚙️ Parameters
|
|
7893
|
-
|
|
7894
|
-
<dl>
|
|
7895
|
-
<dd>
|
|
7896
|
-
|
|
7897
|
-
<dl>
|
|
7898
|
-
<dd>
|
|
7899
|
-
|
|
7900
|
-
**name:** `string` — name of the organization to retrieve.
|
|
7901
|
-
|
|
7902
|
-
</dd>
|
|
7903
|
-
</dl>
|
|
7904
|
-
|
|
7905
|
-
<dl>
|
|
7906
|
-
<dd>
|
|
7907
|
-
|
|
7908
|
-
**requestOptions:** `OrganizationsClient.RequestOptions`
|
|
7909
|
-
|
|
7910
|
-
</dd>
|
|
7911
|
-
</dl>
|
|
7912
|
-
</dd>
|
|
7913
|
-
</dl>
|
|
7914
|
-
|
|
7915
|
-
</dd>
|
|
7916
|
-
</dl>
|
|
7917
|
-
</details>
|
|
7918
|
-
|
|
7919
|
-
<details><summary><code>client.organizations.<a href="/src/management/api/resources/organizations/client/Client.ts">get</a>(id) -> Management.GetOrganizationResponseContent</code></summary>
|
|
7920
|
-
<dl>
|
|
7921
|
-
<dd>
|
|
7922
|
-
|
|
7923
|
-
#### 📝 Description
|
|
7924
|
-
|
|
7925
|
-
<dl>
|
|
7926
|
-
<dd>
|
|
7927
|
-
|
|
7928
|
-
<dl>
|
|
7929
|
-
<dd>
|
|
7930
|
-
|
|
7931
|
-
Retrieve details about a single Organization specified by ID.
|
|
7932
|
-
|
|
7933
|
-
</dd>
|
|
7934
|
-
</dl>
|
|
7935
|
-
</dd>
|
|
7936
|
-
</dl>
|
|
7937
|
-
|
|
7938
|
-
#### 🔌 Usage
|
|
7939
|
-
|
|
7940
|
-
<dl>
|
|
7941
|
-
<dd>
|
|
7942
|
-
|
|
7943
|
-
<dl>
|
|
7944
|
-
<dd>
|
|
7945
|
-
|
|
7946
|
-
```typescript
|
|
7947
|
-
await client.organizations.get("id");
|
|
7948
|
-
```
|
|
7949
|
-
|
|
7950
|
-
</dd>
|
|
7951
|
-
</dl>
|
|
7952
|
-
</dd>
|
|
7953
|
-
</dl>
|
|
7954
|
-
|
|
7955
|
-
#### ⚙️ Parameters
|
|
7956
|
-
|
|
7957
|
-
<dl>
|
|
7958
|
-
<dd>
|
|
7959
|
-
|
|
7960
|
-
<dl>
|
|
7961
|
-
<dd>
|
|
7962
|
-
|
|
7963
|
-
**id:** `string` — ID of the organization to retrieve.
|
|
7964
|
-
|
|
7965
|
-
</dd>
|
|
7966
|
-
</dl>
|
|
7967
|
-
|
|
7968
|
-
<dl>
|
|
7969
|
-
<dd>
|
|
7970
|
-
|
|
7971
|
-
**requestOptions:** `OrganizationsClient.RequestOptions`
|
|
7972
|
-
|
|
7973
|
-
</dd>
|
|
7974
|
-
</dl>
|
|
7975
|
-
</dd>
|
|
7976
|
-
</dl>
|
|
7977
|
-
|
|
7978
|
-
</dd>
|
|
7979
|
-
</dl>
|
|
7980
|
-
</details>
|
|
7981
|
-
|
|
7982
|
-
<details><summary><code>client.organizations.<a href="/src/management/api/resources/organizations/client/Client.ts">delete</a>(id) -> void</code></summary>
|
|
7983
|
-
<dl>
|
|
7984
|
-
<dd>
|
|
7985
|
-
|
|
7986
|
-
#### 📝 Description
|
|
7987
|
-
|
|
7988
|
-
<dl>
|
|
7989
|
-
<dd>
|
|
7990
|
-
|
|
7991
|
-
<dl>
|
|
7992
|
-
<dd>
|
|
7993
|
-
|
|
7994
|
-
Remove an Organization from your tenant. This action cannot be undone.
|
|
7995
|
-
|
|
7996
|
-
**Note**: Members are automatically disassociated from an Organization when it is deleted. However, this action does **not** delete these users from your tenant.
|
|
7997
|
-
|
|
7998
|
-
</dd>
|
|
7999
|
-
</dl>
|
|
8000
|
-
</dd>
|
|
8001
|
-
</dl>
|
|
8002
|
-
|
|
8003
|
-
#### 🔌 Usage
|
|
8004
|
-
|
|
8005
|
-
<dl>
|
|
8006
|
-
<dd>
|
|
8007
|
-
|
|
8008
|
-
<dl>
|
|
8009
|
-
<dd>
|
|
8010
|
-
|
|
8011
|
-
```typescript
|
|
8012
|
-
await client.organizations.delete("id");
|
|
8013
|
-
```
|
|
8014
|
-
|
|
8015
|
-
</dd>
|
|
8016
|
-
</dl>
|
|
8017
|
-
</dd>
|
|
8018
|
-
</dl>
|
|
8019
|
-
|
|
8020
|
-
#### ⚙️ Parameters
|
|
8021
|
-
|
|
8022
|
-
<dl>
|
|
8023
|
-
<dd>
|
|
8024
|
-
|
|
8025
|
-
<dl>
|
|
8026
|
-
<dd>
|
|
8027
|
-
|
|
8028
|
-
**id:** `string` — Organization identifier.
|
|
7880
|
+
**id:** `string` — Organization identifier.
|
|
8029
7881
|
|
|
8030
7882
|
</dd>
|
|
8031
7883
|
</dl>
|
|
@@ -9025,6 +8877,100 @@ await client.resourceServers.create({
|
|
|
9025
8877
|
</dl>
|
|
9026
8878
|
</details>
|
|
9027
8879
|
|
|
8880
|
+
<details><summary><code>client.resourceServers.<a href="/src/management/api/resources/resourceServers/client/Client.ts">search</a>({ ...params }) -> core.Page<Management.ResourceServerSearchResponse, Management.SearchResourceServersResponseContent></code></summary>
|
|
8881
|
+
<dl>
|
|
8882
|
+
<dd>
|
|
8883
|
+
|
|
8884
|
+
#### 📝 Description
|
|
8885
|
+
|
|
8886
|
+
<dl>
|
|
8887
|
+
<dd>
|
|
8888
|
+
|
|
8889
|
+
<dl>
|
|
8890
|
+
<dd>
|
|
8891
|
+
|
|
8892
|
+
Search resource servers using SCIM or Lucene filter syntax with low-latency, eventually consistent results. Use the parser parameter to specify "scim" or "lucene" syntax (default: "lucene"). This endpoint provides an alternative to the standard GET /resource-servers endpoint with better performance for complex queries.
|
|
8893
|
+
Results may not reflect recent updates immediately.
|
|
8894
|
+
|
|
8895
|
+
The `signing_secret` field is not supported by this endpoint.
|
|
8896
|
+
|
|
8897
|
+
</dd>
|
|
8898
|
+
</dl>
|
|
8899
|
+
</dd>
|
|
8900
|
+
</dl>
|
|
8901
|
+
|
|
8902
|
+
#### 🔌 Usage
|
|
8903
|
+
|
|
8904
|
+
<dl>
|
|
8905
|
+
<dd>
|
|
8906
|
+
|
|
8907
|
+
<dl>
|
|
8908
|
+
<dd>
|
|
8909
|
+
|
|
8910
|
+
```typescript
|
|
8911
|
+
const pageableResponse = await client.resourceServers.search({
|
|
8912
|
+
q: "q",
|
|
8913
|
+
parser: "scim",
|
|
8914
|
+
fields: "fields",
|
|
8915
|
+
include_fields: true,
|
|
8916
|
+
take: 1,
|
|
8917
|
+
from: "from",
|
|
8918
|
+
sort: "identifier",
|
|
8919
|
+
});
|
|
8920
|
+
for await (const item of pageableResponse) {
|
|
8921
|
+
console.log(item);
|
|
8922
|
+
}
|
|
8923
|
+
|
|
8924
|
+
// Or you can manually iterate page-by-page
|
|
8925
|
+
let page = await client.resourceServers.search({
|
|
8926
|
+
q: "q",
|
|
8927
|
+
parser: "scim",
|
|
8928
|
+
fields: "fields",
|
|
8929
|
+
include_fields: true,
|
|
8930
|
+
take: 1,
|
|
8931
|
+
from: "from",
|
|
8932
|
+
sort: "identifier",
|
|
8933
|
+
});
|
|
8934
|
+
while (page.hasNextPage()) {
|
|
8935
|
+
page = page.getNextPage();
|
|
8936
|
+
}
|
|
8937
|
+
|
|
8938
|
+
// You can also access the underlying response
|
|
8939
|
+
const response = page.response;
|
|
8940
|
+
```
|
|
8941
|
+
|
|
8942
|
+
</dd>
|
|
8943
|
+
</dl>
|
|
8944
|
+
</dd>
|
|
8945
|
+
</dl>
|
|
8946
|
+
|
|
8947
|
+
#### ⚙️ Parameters
|
|
8948
|
+
|
|
8949
|
+
<dl>
|
|
8950
|
+
<dd>
|
|
8951
|
+
|
|
8952
|
+
<dl>
|
|
8953
|
+
<dd>
|
|
8954
|
+
|
|
8955
|
+
**request:** `Management.SearchResourceServersRequestParameters`
|
|
8956
|
+
|
|
8957
|
+
</dd>
|
|
8958
|
+
</dl>
|
|
8959
|
+
|
|
8960
|
+
<dl>
|
|
8961
|
+
<dd>
|
|
8962
|
+
|
|
8963
|
+
**requestOptions:** `ResourceServersClient.RequestOptions`
|
|
8964
|
+
|
|
8965
|
+
</dd>
|
|
8966
|
+
</dl>
|
|
8967
|
+
</dd>
|
|
8968
|
+
</dl>
|
|
8969
|
+
|
|
8970
|
+
</dd>
|
|
8971
|
+
</dl>
|
|
8972
|
+
</details>
|
|
8973
|
+
|
|
9028
8974
|
<details><summary><code>client.resourceServers.<a href="/src/management/api/resources/resourceServers/client/Client.ts">get</a>(id, { ...params }) -> Management.GetResourceServerResponseContent</code></summary>
|
|
9029
8975
|
<dl>
|
|
9030
8976
|
<dd>
|
|
@@ -19299,7 +19245,65 @@ await client.eventStreams.deliveries.getHistory("id", "event_id");
|
|
|
19299
19245
|
<dl>
|
|
19300
19246
|
<dd>
|
|
19301
19247
|
|
|
19302
|
-
**event_id:** `string` — Unique identifier for the event
|
|
19248
|
+
**event_id:** `string` — Unique identifier for the event
|
|
19249
|
+
|
|
19250
|
+
</dd>
|
|
19251
|
+
</dl>
|
|
19252
|
+
|
|
19253
|
+
<dl>
|
|
19254
|
+
<dd>
|
|
19255
|
+
|
|
19256
|
+
**requestOptions:** `DeliveriesClient.RequestOptions`
|
|
19257
|
+
|
|
19258
|
+
</dd>
|
|
19259
|
+
</dl>
|
|
19260
|
+
</dd>
|
|
19261
|
+
</dl>
|
|
19262
|
+
|
|
19263
|
+
</dd>
|
|
19264
|
+
</dl>
|
|
19265
|
+
</details>
|
|
19266
|
+
|
|
19267
|
+
## EventStreams Redeliveries
|
|
19268
|
+
|
|
19269
|
+
<details><summary><code>client.eventStreams.redeliveries.<a href="/src/management/api/resources/eventStreams/resources/redeliveries/client/Client.ts">create</a>(id, { ...params }) -> Management.CreateEventStreamRedeliveryResponseContent</code></summary>
|
|
19270
|
+
<dl>
|
|
19271
|
+
<dd>
|
|
19272
|
+
|
|
19273
|
+
#### 🔌 Usage
|
|
19274
|
+
|
|
19275
|
+
<dl>
|
|
19276
|
+
<dd>
|
|
19277
|
+
|
|
19278
|
+
<dl>
|
|
19279
|
+
<dd>
|
|
19280
|
+
|
|
19281
|
+
```typescript
|
|
19282
|
+
await client.eventStreams.redeliveries.create("id");
|
|
19283
|
+
```
|
|
19284
|
+
|
|
19285
|
+
</dd>
|
|
19286
|
+
</dl>
|
|
19287
|
+
</dd>
|
|
19288
|
+
</dl>
|
|
19289
|
+
|
|
19290
|
+
#### ⚙️ Parameters
|
|
19291
|
+
|
|
19292
|
+
<dl>
|
|
19293
|
+
<dd>
|
|
19294
|
+
|
|
19295
|
+
<dl>
|
|
19296
|
+
<dd>
|
|
19297
|
+
|
|
19298
|
+
**id:** `string` — Unique identifier for the event stream.
|
|
19299
|
+
|
|
19300
|
+
</dd>
|
|
19301
|
+
</dl>
|
|
19302
|
+
|
|
19303
|
+
<dl>
|
|
19304
|
+
<dd>
|
|
19305
|
+
|
|
19306
|
+
**request:** `Management.CreateEventStreamRedeliveryRequestContent`
|
|
19303
19307
|
|
|
19304
19308
|
</dd>
|
|
19305
19309
|
</dl>
|
|
@@ -19307,7 +19311,7 @@ await client.eventStreams.deliveries.getHistory("id", "event_id");
|
|
|
19307
19311
|
<dl>
|
|
19308
19312
|
<dd>
|
|
19309
19313
|
|
|
19310
|
-
**requestOptions:** `
|
|
19314
|
+
**requestOptions:** `RedeliveriesClient.RequestOptions`
|
|
19311
19315
|
|
|
19312
19316
|
</dd>
|
|
19313
19317
|
</dl>
|
|
@@ -19318,9 +19322,7 @@ await client.eventStreams.deliveries.getHistory("id", "event_id");
|
|
|
19318
19322
|
</dl>
|
|
19319
19323
|
</details>
|
|
19320
19324
|
|
|
19321
|
-
|
|
19322
|
-
|
|
19323
|
-
<details><summary><code>client.eventStreams.redeliveries.<a href="/src/management/api/resources/eventStreams/resources/redeliveries/client/Client.ts">create</a>(id, { ...params }) -> Management.CreateEventStreamRedeliveryResponseContent</code></summary>
|
|
19325
|
+
<details><summary><code>client.eventStreams.redeliveries.<a href="/src/management/api/resources/eventStreams/resources/redeliveries/client/Client.ts">createById</a>(id, event_id) -> void</code></summary>
|
|
19324
19326
|
<dl>
|
|
19325
19327
|
<dd>
|
|
19326
19328
|
|
|
@@ -19333,7 +19335,7 @@ await client.eventStreams.deliveries.getHistory("id", "event_id");
|
|
|
19333
19335
|
<dd>
|
|
19334
19336
|
|
|
19335
19337
|
```typescript
|
|
19336
|
-
await client.eventStreams.redeliveries.
|
|
19338
|
+
await client.eventStreams.redeliveries.createById("id", "event_id");
|
|
19337
19339
|
```
|
|
19338
19340
|
|
|
19339
19341
|
</dd>
|
|
@@ -19357,7 +19359,7 @@ await client.eventStreams.redeliveries.create("id");
|
|
|
19357
19359
|
<dl>
|
|
19358
19360
|
<dd>
|
|
19359
19361
|
|
|
19360
|
-
**
|
|
19362
|
+
**event_id:** `string` — Unique identifier for the event
|
|
19361
19363
|
|
|
19362
19364
|
</dd>
|
|
19363
19365
|
</dl>
|
|
@@ -19376,10 +19378,27 @@ await client.eventStreams.redeliveries.create("id");
|
|
|
19376
19378
|
</dl>
|
|
19377
19379
|
</details>
|
|
19378
19380
|
|
|
19379
|
-
|
|
19381
|
+
## Experimentation Experiments
|
|
19382
|
+
|
|
19383
|
+
<details><summary><code>client.experimentation.experiments.<a href="/src/management/api/resources/experimentation/resources/experiments/client/Client.ts">advanceRamp</a>(id, { ...params }) -> Management.AdvanceRampResponseContent</code></summary>
|
|
19384
|
+
<dl>
|
|
19385
|
+
<dd>
|
|
19386
|
+
|
|
19387
|
+
#### 📝 Description
|
|
19388
|
+
|
|
19389
|
+
<dl>
|
|
19390
|
+
<dd>
|
|
19391
|
+
|
|
19380
19392
|
<dl>
|
|
19381
19393
|
<dd>
|
|
19382
19394
|
|
|
19395
|
+
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.
|
|
19396
|
+
|
|
19397
|
+
</dd>
|
|
19398
|
+
</dl>
|
|
19399
|
+
</dd>
|
|
19400
|
+
</dl>
|
|
19401
|
+
|
|
19383
19402
|
#### 🔌 Usage
|
|
19384
19403
|
|
|
19385
19404
|
<dl>
|
|
@@ -19389,7 +19408,9 @@ await client.eventStreams.redeliveries.create("id");
|
|
|
19389
19408
|
<dd>
|
|
19390
19409
|
|
|
19391
19410
|
```typescript
|
|
19392
|
-
await client.
|
|
19411
|
+
await client.experimentation.experiments.advanceRamp("id", {
|
|
19412
|
+
target_level: 1,
|
|
19413
|
+
});
|
|
19393
19414
|
```
|
|
19394
19415
|
|
|
19395
19416
|
</dd>
|
|
@@ -19405,7 +19426,7 @@ await client.eventStreams.redeliveries.createById("id", "event_id");
|
|
|
19405
19426
|
<dl>
|
|
19406
19427
|
<dd>
|
|
19407
19428
|
|
|
19408
|
-
**id:** `string` —
|
|
19429
|
+
**id:** `string` — The ID of the experiment to advance.
|
|
19409
19430
|
|
|
19410
19431
|
</dd>
|
|
19411
19432
|
</dl>
|
|
@@ -19413,7 +19434,7 @@ await client.eventStreams.redeliveries.createById("id", "event_id");
|
|
|
19413
19434
|
<dl>
|
|
19414
19435
|
<dd>
|
|
19415
19436
|
|
|
19416
|
-
**
|
|
19437
|
+
**request:** `Management.AdvanceRampRequestContent`
|
|
19417
19438
|
|
|
19418
19439
|
</dd>
|
|
19419
19440
|
</dl>
|
|
@@ -19421,7 +19442,7 @@ await client.eventStreams.redeliveries.createById("id", "event_id");
|
|
|
19421
19442
|
<dl>
|
|
19422
19443
|
<dd>
|
|
19423
19444
|
|
|
19424
|
-
**requestOptions:** `
|
|
19445
|
+
**requestOptions:** `ExperimentsClient.RequestOptions`
|
|
19425
19446
|
|
|
19426
19447
|
</dd>
|
|
19427
19448
|
</dl>
|
|
@@ -20699,6 +20720,129 @@ await client.guardian.policies.set(["all-applications"]);
|
|
|
20699
20720
|
</dl>
|
|
20700
20721
|
</details>
|
|
20701
20722
|
|
|
20723
|
+
## Guardian Factors Email
|
|
20724
|
+
|
|
20725
|
+
<details><summary><code>client.guardian.factors.email.<a href="/src/management/api/resources/guardian/resources/factors/resources/email/client/Client.ts">get</a>() -> Management.GetEmailFactorSettingsResponseContent</code></summary>
|
|
20726
|
+
<dl>
|
|
20727
|
+
<dd>
|
|
20728
|
+
|
|
20729
|
+
#### 📝 Description
|
|
20730
|
+
|
|
20731
|
+
<dl>
|
|
20732
|
+
<dd>
|
|
20733
|
+
|
|
20734
|
+
<dl>
|
|
20735
|
+
<dd>
|
|
20736
|
+
|
|
20737
|
+
TODO: Link this endpoint to relevant documentation when available.
|
|
20738
|
+
|
|
20739
|
+
</dd>
|
|
20740
|
+
</dl>
|
|
20741
|
+
</dd>
|
|
20742
|
+
</dl>
|
|
20743
|
+
|
|
20744
|
+
#### 🔌 Usage
|
|
20745
|
+
|
|
20746
|
+
<dl>
|
|
20747
|
+
<dd>
|
|
20748
|
+
|
|
20749
|
+
<dl>
|
|
20750
|
+
<dd>
|
|
20751
|
+
|
|
20752
|
+
```typescript
|
|
20753
|
+
await client.guardian.factors.email.get();
|
|
20754
|
+
```
|
|
20755
|
+
|
|
20756
|
+
</dd>
|
|
20757
|
+
</dl>
|
|
20758
|
+
</dd>
|
|
20759
|
+
</dl>
|
|
20760
|
+
|
|
20761
|
+
#### ⚙️ Parameters
|
|
20762
|
+
|
|
20763
|
+
<dl>
|
|
20764
|
+
<dd>
|
|
20765
|
+
|
|
20766
|
+
<dl>
|
|
20767
|
+
<dd>
|
|
20768
|
+
|
|
20769
|
+
**requestOptions:** `EmailClient.RequestOptions`
|
|
20770
|
+
|
|
20771
|
+
</dd>
|
|
20772
|
+
</dl>
|
|
20773
|
+
</dd>
|
|
20774
|
+
</dl>
|
|
20775
|
+
|
|
20776
|
+
</dd>
|
|
20777
|
+
</dl>
|
|
20778
|
+
</details>
|
|
20779
|
+
|
|
20780
|
+
<details><summary><code>client.guardian.factors.email.<a href="/src/management/api/resources/guardian/resources/factors/resources/email/client/Client.ts">set</a>({ ...params }) -> Management.SetEmailFactorSettingsResponseContent</code></summary>
|
|
20781
|
+
<dl>
|
|
20782
|
+
<dd>
|
|
20783
|
+
|
|
20784
|
+
#### 📝 Description
|
|
20785
|
+
|
|
20786
|
+
<dl>
|
|
20787
|
+
<dd>
|
|
20788
|
+
|
|
20789
|
+
<dl>
|
|
20790
|
+
<dd>
|
|
20791
|
+
|
|
20792
|
+
TODO: Link this endpoint to relevant documentation when available.
|
|
20793
|
+
|
|
20794
|
+
</dd>
|
|
20795
|
+
</dl>
|
|
20796
|
+
</dd>
|
|
20797
|
+
</dl>
|
|
20798
|
+
|
|
20799
|
+
#### 🔌 Usage
|
|
20800
|
+
|
|
20801
|
+
<dl>
|
|
20802
|
+
<dd>
|
|
20803
|
+
|
|
20804
|
+
<dl>
|
|
20805
|
+
<dd>
|
|
20806
|
+
|
|
20807
|
+
```typescript
|
|
20808
|
+
await client.guardian.factors.email.set({
|
|
20809
|
+
otp_length: 1,
|
|
20810
|
+
otp_expiration_time: 1,
|
|
20811
|
+
});
|
|
20812
|
+
```
|
|
20813
|
+
|
|
20814
|
+
</dd>
|
|
20815
|
+
</dl>
|
|
20816
|
+
</dd>
|
|
20817
|
+
</dl>
|
|
20818
|
+
|
|
20819
|
+
#### ⚙️ Parameters
|
|
20820
|
+
|
|
20821
|
+
<dl>
|
|
20822
|
+
<dd>
|
|
20823
|
+
|
|
20824
|
+
<dl>
|
|
20825
|
+
<dd>
|
|
20826
|
+
|
|
20827
|
+
**request:** `Management.SetEmailFactorSettingsRequestContent`
|
|
20828
|
+
|
|
20829
|
+
</dd>
|
|
20830
|
+
</dl>
|
|
20831
|
+
|
|
20832
|
+
<dl>
|
|
20833
|
+
<dd>
|
|
20834
|
+
|
|
20835
|
+
**requestOptions:** `EmailClient.RequestOptions`
|
|
20836
|
+
|
|
20837
|
+
</dd>
|
|
20838
|
+
</dl>
|
|
20839
|
+
</dd>
|
|
20840
|
+
</dl>
|
|
20841
|
+
|
|
20842
|
+
</dd>
|
|
20843
|
+
</dl>
|
|
20844
|
+
</details>
|
|
20845
|
+
|
|
20702
20846
|
## Guardian Factors Phone
|
|
20703
20847
|
|
|
20704
20848
|
<details><summary><code>client.guardian.factors.phone.<a href="/src/management/api/resources/guardian/resources/factors/resources/phone/client/Client.ts">getMessageTypes</a>() -> Management.GetGuardianFactorPhoneMessageTypesResponseContent</code></summary>
|
|
@@ -21044,6 +21188,127 @@ await client.guardian.factors.phone.setProvider({
|
|
|
21044
21188
|
</dl>
|
|
21045
21189
|
</details>
|
|
21046
21190
|
|
|
21191
|
+
<details><summary><code>client.guardian.factors.phone.<a href="/src/management/api/resources/guardian/resources/factors/resources/phone/client/Client.ts">get</a>() -> Management.GetPhoneFactorSettingsResponseContent</code></summary>
|
|
21192
|
+
<dl>
|
|
21193
|
+
<dd>
|
|
21194
|
+
|
|
21195
|
+
#### 📝 Description
|
|
21196
|
+
|
|
21197
|
+
<dl>
|
|
21198
|
+
<dd>
|
|
21199
|
+
|
|
21200
|
+
<dl>
|
|
21201
|
+
<dd>
|
|
21202
|
+
|
|
21203
|
+
TODO: Link this endpoint to relevant documentation when available.
|
|
21204
|
+
|
|
21205
|
+
</dd>
|
|
21206
|
+
</dl>
|
|
21207
|
+
</dd>
|
|
21208
|
+
</dl>
|
|
21209
|
+
|
|
21210
|
+
#### 🔌 Usage
|
|
21211
|
+
|
|
21212
|
+
<dl>
|
|
21213
|
+
<dd>
|
|
21214
|
+
|
|
21215
|
+
<dl>
|
|
21216
|
+
<dd>
|
|
21217
|
+
|
|
21218
|
+
```typescript
|
|
21219
|
+
await client.guardian.factors.phone.get();
|
|
21220
|
+
```
|
|
21221
|
+
|
|
21222
|
+
</dd>
|
|
21223
|
+
</dl>
|
|
21224
|
+
</dd>
|
|
21225
|
+
</dl>
|
|
21226
|
+
|
|
21227
|
+
#### ⚙️ Parameters
|
|
21228
|
+
|
|
21229
|
+
<dl>
|
|
21230
|
+
<dd>
|
|
21231
|
+
|
|
21232
|
+
<dl>
|
|
21233
|
+
<dd>
|
|
21234
|
+
|
|
21235
|
+
**requestOptions:** `PhoneClient.RequestOptions`
|
|
21236
|
+
|
|
21237
|
+
</dd>
|
|
21238
|
+
</dl>
|
|
21239
|
+
</dd>
|
|
21240
|
+
</dl>
|
|
21241
|
+
|
|
21242
|
+
</dd>
|
|
21243
|
+
</dl>
|
|
21244
|
+
</details>
|
|
21245
|
+
|
|
21246
|
+
<details><summary><code>client.guardian.factors.phone.<a href="/src/management/api/resources/guardian/resources/factors/resources/phone/client/Client.ts">set</a>({ ...params }) -> Management.SetPhoneFactorSettingsResponseContent</code></summary>
|
|
21247
|
+
<dl>
|
|
21248
|
+
<dd>
|
|
21249
|
+
|
|
21250
|
+
#### 📝 Description
|
|
21251
|
+
|
|
21252
|
+
<dl>
|
|
21253
|
+
<dd>
|
|
21254
|
+
|
|
21255
|
+
<dl>
|
|
21256
|
+
<dd>
|
|
21257
|
+
|
|
21258
|
+
TODO: Link this endpoint to relevant documentation when available.
|
|
21259
|
+
|
|
21260
|
+
</dd>
|
|
21261
|
+
</dl>
|
|
21262
|
+
</dd>
|
|
21263
|
+
</dl>
|
|
21264
|
+
|
|
21265
|
+
#### 🔌 Usage
|
|
21266
|
+
|
|
21267
|
+
<dl>
|
|
21268
|
+
<dd>
|
|
21269
|
+
|
|
21270
|
+
<dl>
|
|
21271
|
+
<dd>
|
|
21272
|
+
|
|
21273
|
+
```typescript
|
|
21274
|
+
await client.guardian.factors.phone.set({
|
|
21275
|
+
otp_length: 1,
|
|
21276
|
+
otp_expiration_time: 1,
|
|
21277
|
+
});
|
|
21278
|
+
```
|
|
21279
|
+
|
|
21280
|
+
</dd>
|
|
21281
|
+
</dl>
|
|
21282
|
+
</dd>
|
|
21283
|
+
</dl>
|
|
21284
|
+
|
|
21285
|
+
#### ⚙️ Parameters
|
|
21286
|
+
|
|
21287
|
+
<dl>
|
|
21288
|
+
<dd>
|
|
21289
|
+
|
|
21290
|
+
<dl>
|
|
21291
|
+
<dd>
|
|
21292
|
+
|
|
21293
|
+
**request:** `Management.SetPhoneFactorSettingsRequestContent`
|
|
21294
|
+
|
|
21295
|
+
</dd>
|
|
21296
|
+
</dl>
|
|
21297
|
+
|
|
21298
|
+
<dl>
|
|
21299
|
+
<dd>
|
|
21300
|
+
|
|
21301
|
+
**requestOptions:** `PhoneClient.RequestOptions`
|
|
21302
|
+
|
|
21303
|
+
</dd>
|
|
21304
|
+
</dl>
|
|
21305
|
+
</dd>
|
|
21306
|
+
</dl>
|
|
21307
|
+
|
|
21308
|
+
</dd>
|
|
21309
|
+
</dl>
|
|
21310
|
+
</details>
|
|
21311
|
+
|
|
21047
21312
|
<details><summary><code>client.guardian.factors.phone.<a href="/src/management/api/resources/guardian/resources/factors/resources/phone/client/Client.ts">getTemplates</a>() -> Management.GetGuardianFactorPhoneTemplatesResponseContent</code></summary>
|
|
21048
21313
|
<dl>
|
|
21049
21314
|
<dd>
|