auth0 6.2.0 → 6.4.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 +3 -0
- package/dist/cjs/management/Client.js +45 -40
- package/dist/cjs/management/api/errors/UnprocessableEntityError.d.ts +5 -0
- package/dist/cjs/management/api/errors/UnprocessableEntityError.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 +119 -11
- package/dist/cjs/management/api/resources/clients/client/Client.d.ts +2 -2
- package/dist/cjs/management/api/resources/clients/client/Client.js +2 -2
- package/dist/cjs/management/api/resources/connections/client/Client.d.ts +3 -1
- package/dist/cjs/management/api/resources/connections/client/Client.js +7 -1
- package/dist/cjs/management/api/resources/connections/resources/scimConfiguration/client/Client.d.ts +1 -0
- package/dist/cjs/management/api/resources/connections/resources/scimConfiguration/client/Client.js +3 -0
- package/dist/cjs/management/api/resources/flows/client/Client.d.ts +2 -0
- package/dist/cjs/management/api/resources/flows/client/Client.js +6 -0
- package/dist/cjs/management/api/resources/flows/resources/executions/client/Client.d.ts +2 -0
- package/dist/cjs/management/api/resources/flows/resources/executions/client/Client.js +6 -0
- package/dist/cjs/management/api/resources/forms/client/Client.d.ts +2 -0
- package/dist/cjs/management/api/resources/forms/client/Client.js +6 -0
- package/dist/cjs/management/api/resources/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/index.js +2 -1
- package/dist/cjs/management/api/resources/keys/client/Client.d.ts +3 -0
- package/dist/cjs/management/api/resources/keys/client/Client.js +7 -2
- package/dist/cjs/management/api/resources/keys/resources/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/keys/resources/index.js +2 -1
- package/dist/cjs/management/api/resources/keys/resources/networkAcls/client/Client.d.ts +84 -0
- package/dist/cjs/management/api/resources/keys/resources/networkAcls/client/Client.js +311 -0
- package/dist/cjs/management/api/resources/keys/resources/networkAcls/client/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/keys/resources/networkAcls/client/index.js +2 -0
- package/dist/cjs/management/api/resources/keys/resources/networkAcls/exports.d.ts +2 -0
- package/dist/cjs/management/api/resources/keys/resources/networkAcls/exports.js +21 -0
- package/dist/cjs/management/api/resources/keys/resources/networkAcls/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/keys/resources/networkAcls/index.js +17 -0
- package/dist/cjs/management/api/resources/organizationTemplates/client/Client.d.ts +106 -0
- package/dist/cjs/management/api/resources/organizationTemplates/client/Client.js +411 -0
- package/dist/cjs/management/api/resources/organizationTemplates/client/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/organizationTemplates/client/index.js +2 -0
- package/dist/cjs/management/api/resources/organizationTemplates/exports.d.ts +2 -0
- package/dist/cjs/management/api/resources/organizationTemplates/exports.js +21 -0
- package/dist/cjs/management/api/resources/organizationTemplates/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/organizationTemplates/index.js +17 -0
- package/dist/cjs/management/api/resources/organizations/client/Client.d.ts +3 -0
- package/dist/cjs/management/api/resources/organizations/client/Client.js +7 -2
- package/dist/cjs/management/api/resources/organizations/resources/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/organizations/resources/index.js +2 -1
- package/dist/cjs/management/api/resources/organizations/resources/organizationTemplate/client/Client.d.ts +63 -0
- package/dist/cjs/management/api/resources/organizations/resources/organizationTemplate/client/Client.js +232 -0
- package/dist/cjs/management/api/resources/organizations/resources/organizationTemplate/client/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/organizations/resources/organizationTemplate/client/index.js +2 -0
- package/dist/cjs/management/api/resources/organizations/resources/organizationTemplate/exports.d.ts +2 -0
- package/dist/cjs/management/api/resources/organizations/resources/organizationTemplate/exports.js +21 -0
- package/dist/cjs/management/api/resources/organizations/resources/organizationTemplate/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/organizations/resources/organizationTemplate/index.js +17 -0
- package/dist/cjs/management/api/resources/users/resources/organizations/client/Client.d.ts +17 -0
- package/dist/cjs/management/api/resources/users/resources/organizations/client/Client.js +19 -0
- package/dist/cjs/management/api/types/types.d.ts +9066 -2089
- package/dist/cjs/management/api/types/types.js +1478 -160
- package/dist/cjs/management/version.d.ts +1 -1
- package/dist/cjs/management/version.js +1 -1
- package/dist/cjs/management/wrapper/token-provider.js +1 -1
- package/dist/esm/management/Client.d.mts +3 -0
- package/dist/esm/management/Client.mjs +5 -0
- package/dist/esm/management/api/errors/UnprocessableEntityError.d.mts +5 -0
- package/dist/esm/management/api/errors/UnprocessableEntityError.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 +119 -11
- package/dist/esm/management/api/resources/clients/client/Client.d.mts +2 -2
- package/dist/esm/management/api/resources/clients/client/Client.mjs +2 -2
- package/dist/esm/management/api/resources/connections/client/Client.d.mts +3 -1
- package/dist/esm/management/api/resources/connections/client/Client.mjs +7 -1
- package/dist/esm/management/api/resources/connections/resources/scimConfiguration/client/Client.d.mts +1 -0
- package/dist/esm/management/api/resources/connections/resources/scimConfiguration/client/Client.mjs +3 -0
- package/dist/esm/management/api/resources/flows/client/Client.d.mts +2 -0
- package/dist/esm/management/api/resources/flows/client/Client.mjs +6 -0
- package/dist/esm/management/api/resources/flows/resources/executions/client/Client.d.mts +2 -0
- package/dist/esm/management/api/resources/flows/resources/executions/client/Client.mjs +6 -0
- package/dist/esm/management/api/resources/forms/client/Client.d.mts +2 -0
- package/dist/esm/management/api/resources/forms/client/Client.mjs +6 -0
- package/dist/esm/management/api/resources/index.d.mts +1 -0
- package/dist/esm/management/api/resources/index.mjs +1 -0
- package/dist/esm/management/api/resources/keys/client/Client.d.mts +3 -0
- package/dist/esm/management/api/resources/keys/client/Client.mjs +5 -0
- package/dist/esm/management/api/resources/keys/resources/index.d.mts +1 -0
- package/dist/esm/management/api/resources/keys/resources/index.mjs +1 -0
- package/dist/esm/management/api/resources/keys/resources/networkAcls/client/Client.d.mts +84 -0
- package/dist/esm/management/api/resources/keys/resources/networkAcls/client/Client.mjs +274 -0
- package/dist/esm/management/api/resources/keys/resources/networkAcls/client/index.d.mts +1 -0
- package/dist/esm/management/api/resources/keys/resources/networkAcls/client/index.mjs +1 -0
- package/dist/esm/management/api/resources/keys/resources/networkAcls/exports.d.mts +2 -0
- package/dist/esm/management/api/resources/keys/resources/networkAcls/exports.mjs +3 -0
- package/dist/esm/management/api/resources/keys/resources/networkAcls/index.d.mts +1 -0
- package/dist/esm/management/api/resources/keys/resources/networkAcls/index.mjs +1 -0
- package/dist/esm/management/api/resources/organizationTemplates/client/Client.d.mts +106 -0
- package/dist/esm/management/api/resources/organizationTemplates/client/Client.mjs +374 -0
- package/dist/esm/management/api/resources/organizationTemplates/client/index.d.mts +1 -0
- package/dist/esm/management/api/resources/organizationTemplates/client/index.mjs +1 -0
- package/dist/esm/management/api/resources/organizationTemplates/exports.d.mts +2 -0
- package/dist/esm/management/api/resources/organizationTemplates/exports.mjs +3 -0
- package/dist/esm/management/api/resources/organizationTemplates/index.d.mts +1 -0
- package/dist/esm/management/api/resources/organizationTemplates/index.mjs +1 -0
- package/dist/esm/management/api/resources/organizations/client/Client.d.mts +3 -0
- package/dist/esm/management/api/resources/organizations/client/Client.mjs +5 -0
- package/dist/esm/management/api/resources/organizations/resources/index.d.mts +1 -0
- package/dist/esm/management/api/resources/organizations/resources/index.mjs +1 -0
- package/dist/esm/management/api/resources/organizations/resources/organizationTemplate/client/Client.d.mts +63 -0
- package/dist/esm/management/api/resources/organizations/resources/organizationTemplate/client/Client.mjs +195 -0
- package/dist/esm/management/api/resources/organizations/resources/organizationTemplate/client/index.d.mts +1 -0
- package/dist/esm/management/api/resources/organizations/resources/organizationTemplate/client/index.mjs +1 -0
- package/dist/esm/management/api/resources/organizations/resources/organizationTemplate/exports.d.mts +2 -0
- package/dist/esm/management/api/resources/organizations/resources/organizationTemplate/exports.mjs +3 -0
- package/dist/esm/management/api/resources/organizations/resources/organizationTemplate/index.d.mts +1 -0
- package/dist/esm/management/api/resources/organizations/resources/organizationTemplate/index.mjs +1 -0
- package/dist/esm/management/api/resources/users/resources/organizations/client/Client.d.mts +17 -0
- package/dist/esm/management/api/resources/users/resources/organizations/client/Client.mjs +19 -0
- package/dist/esm/management/api/types/types.d.mts +9066 -2089
- package/dist/esm/management/api/types/types.mjs +1457 -144
- package/dist/esm/management/version.d.mts +1 -1
- package/dist/esm/management/version.mjs +1 -1
- package/dist/esm/management/wrapper/token-provider.mjs +1 -1
- package/package.json +34 -1
- package/reference.md +886 -39
package/reference.md
CHANGED
|
@@ -1356,7 +1356,7 @@ For more information, read [Applications in Auth0](https://www.auth0.com/docs/ge
|
|
|
1356
1356
|
`jwt_configuration.lifetime_in_seconds`, `jwt_configuration.secret_encoded`,
|
|
1357
1357
|
`jwt_configuration.scopes`, `jwt_configuration.alg`, `api_type`,
|
|
1358
1358
|
`logo_uri`, `allowed_clients`, `owners`, `custom_login_page`,
|
|
1359
|
-
`
|
|
1359
|
+
`custom_login_page_on`, `sso`, `addons`, `form_template`,
|
|
1360
1360
|
`custom_login_page_codeview`, `resource_servers`, `client_metadata`,
|
|
1361
1361
|
`mobile`, `mobile.android`, `mobile.ios`, `allowed_logout_urls`,
|
|
1362
1362
|
`token_endpoint_auth_method`, `is_first_party`, `oidc_conformant`,
|
|
@@ -1697,7 +1697,7 @@ For more information, read [Applications in Auth0](https://www.auth0.com/docs/ge
|
|
|
1697
1697
|
`jwt_configuration.lifetime_in_seconds`, `jwt_configuration.secret_encoded`,
|
|
1698
1698
|
`jwt_configuration.scopes`, `jwt_configuration.alg`, `api_type`,
|
|
1699
1699
|
`logo_uri`, `allowed_clients`, `owners`, `custom_login_page`,
|
|
1700
|
-
`
|
|
1700
|
+
`custom_login_page_on`, `sso`, `addons`, `form_template`,
|
|
1701
1701
|
`custom_login_page_codeview`, `resource_servers`, `client_metadata`,
|
|
1702
1702
|
`mobile`, `mobile.android`, `mobile.ios`, `allowed_logout_urls`,
|
|
1703
1703
|
`token_endpoint_auth_method`, `is_first_party`, `oidc_conformant`,
|
|
@@ -2770,7 +2770,7 @@ await client.connections.delete("id");
|
|
|
2770
2770
|
|
|
2771
2771
|
Update details for a specific [connection](https://auth0.com/docs/authenticate/identity-providers), including option properties for identity provider configuration.
|
|
2772
2772
|
|
|
2773
|
-
**Note**: If you use the `options` parameter, the entire `options` object is overridden. To avoid partial data or other issues, ensure all parameters are present when using this option.
|
|
2773
|
+
**Note**: If you use the `options` parameter, the entire `options` object is overridden. To avoid partial data or other issues, ensure all parameters are present when using this option. If any options are unspecified, the default will be used, even if it differs from the existing value.
|
|
2774
2774
|
|
|
2775
2775
|
</dd>
|
|
2776
2776
|
</dl>
|
|
@@ -7309,6 +7309,380 @@ await client.networkAcls.update("id");
|
|
|
7309
7309
|
</dl>
|
|
7310
7310
|
</details>
|
|
7311
7311
|
|
|
7312
|
+
## OrganizationTemplates
|
|
7313
|
+
|
|
7314
|
+
<details><summary><code>client.organizationTemplates.<a href="/src/management/api/resources/organizationTemplates/client/Client.ts">list</a>({ ...params }) -> core.Page<Management.OrganizationTemplate, Management.ListOrganizationTemplatesPaginatedResponseContent></code></summary>
|
|
7315
|
+
<dl>
|
|
7316
|
+
<dd>
|
|
7317
|
+
|
|
7318
|
+
#### 📝 Description
|
|
7319
|
+
|
|
7320
|
+
<dl>
|
|
7321
|
+
<dd>
|
|
7322
|
+
|
|
7323
|
+
<dl>
|
|
7324
|
+
<dd>
|
|
7325
|
+
|
|
7326
|
+
Retrieve a list of Organization Templates. This endpoint supports Checkpoint pagination. Results are returned in a stable order, sorted by their identifier (`id`) in ascending order.
|
|
7327
|
+
|
|
7328
|
+
</dd>
|
|
7329
|
+
</dl>
|
|
7330
|
+
</dd>
|
|
7331
|
+
</dl>
|
|
7332
|
+
|
|
7333
|
+
#### 🔌 Usage
|
|
7334
|
+
|
|
7335
|
+
<dl>
|
|
7336
|
+
<dd>
|
|
7337
|
+
|
|
7338
|
+
<dl>
|
|
7339
|
+
<dd>
|
|
7340
|
+
|
|
7341
|
+
```typescript
|
|
7342
|
+
const pageableResponse = await client.organizationTemplates.list({
|
|
7343
|
+
from: "from",
|
|
7344
|
+
take: 1,
|
|
7345
|
+
});
|
|
7346
|
+
for await (const item of pageableResponse) {
|
|
7347
|
+
console.log(item);
|
|
7348
|
+
}
|
|
7349
|
+
|
|
7350
|
+
// Or you can manually iterate page-by-page
|
|
7351
|
+
let page = await client.organizationTemplates.list({
|
|
7352
|
+
from: "from",
|
|
7353
|
+
take: 1,
|
|
7354
|
+
});
|
|
7355
|
+
while (page.hasNextPage()) {
|
|
7356
|
+
page = page.getNextPage();
|
|
7357
|
+
}
|
|
7358
|
+
|
|
7359
|
+
// You can also access the underlying response
|
|
7360
|
+
const response = page.response;
|
|
7361
|
+
```
|
|
7362
|
+
|
|
7363
|
+
</dd>
|
|
7364
|
+
</dl>
|
|
7365
|
+
</dd>
|
|
7366
|
+
</dl>
|
|
7367
|
+
|
|
7368
|
+
#### ⚙️ Parameters
|
|
7369
|
+
|
|
7370
|
+
<dl>
|
|
7371
|
+
<dd>
|
|
7372
|
+
|
|
7373
|
+
<dl>
|
|
7374
|
+
<dd>
|
|
7375
|
+
|
|
7376
|
+
**request:** `Management.ListOrganizationTemplatesRequestParameters`
|
|
7377
|
+
|
|
7378
|
+
</dd>
|
|
7379
|
+
</dl>
|
|
7380
|
+
|
|
7381
|
+
<dl>
|
|
7382
|
+
<dd>
|
|
7383
|
+
|
|
7384
|
+
**requestOptions:** `OrganizationTemplatesClient.RequestOptions`
|
|
7385
|
+
|
|
7386
|
+
</dd>
|
|
7387
|
+
</dl>
|
|
7388
|
+
</dd>
|
|
7389
|
+
</dl>
|
|
7390
|
+
|
|
7391
|
+
</dd>
|
|
7392
|
+
</dl>
|
|
7393
|
+
</details>
|
|
7394
|
+
|
|
7395
|
+
<details><summary><code>client.organizationTemplates.<a href="/src/management/api/resources/organizationTemplates/client/Client.ts">create</a>({ ...params }) -> Management.OrganizationTemplate</code></summary>
|
|
7396
|
+
<dl>
|
|
7397
|
+
<dd>
|
|
7398
|
+
|
|
7399
|
+
#### 📝 Description
|
|
7400
|
+
|
|
7401
|
+
<dl>
|
|
7402
|
+
<dd>
|
|
7403
|
+
|
|
7404
|
+
<dl>
|
|
7405
|
+
<dd>
|
|
7406
|
+
|
|
7407
|
+
Create an Organization Template.
|
|
7408
|
+
|
|
7409
|
+
</dd>
|
|
7410
|
+
</dl>
|
|
7411
|
+
</dd>
|
|
7412
|
+
</dl>
|
|
7413
|
+
|
|
7414
|
+
#### 🔌 Usage
|
|
7415
|
+
|
|
7416
|
+
<dl>
|
|
7417
|
+
<dd>
|
|
7418
|
+
|
|
7419
|
+
<dl>
|
|
7420
|
+
<dd>
|
|
7421
|
+
|
|
7422
|
+
```typescript
|
|
7423
|
+
await client.organizationTemplates.create({
|
|
7424
|
+
name: "name",
|
|
7425
|
+
organization_deletion_behavior: "allow",
|
|
7426
|
+
enforce_permission_ceiling: true,
|
|
7427
|
+
enforce_self_assignment_restriction: true,
|
|
7428
|
+
});
|
|
7429
|
+
```
|
|
7430
|
+
|
|
7431
|
+
</dd>
|
|
7432
|
+
</dl>
|
|
7433
|
+
</dd>
|
|
7434
|
+
</dl>
|
|
7435
|
+
|
|
7436
|
+
#### ⚙️ Parameters
|
|
7437
|
+
|
|
7438
|
+
<dl>
|
|
7439
|
+
<dd>
|
|
7440
|
+
|
|
7441
|
+
<dl>
|
|
7442
|
+
<dd>
|
|
7443
|
+
|
|
7444
|
+
**request:** `Management.CreateOrganizationTemplateRequestContent`
|
|
7445
|
+
|
|
7446
|
+
</dd>
|
|
7447
|
+
</dl>
|
|
7448
|
+
|
|
7449
|
+
<dl>
|
|
7450
|
+
<dd>
|
|
7451
|
+
|
|
7452
|
+
**requestOptions:** `OrganizationTemplatesClient.RequestOptions`
|
|
7453
|
+
|
|
7454
|
+
</dd>
|
|
7455
|
+
</dl>
|
|
7456
|
+
</dd>
|
|
7457
|
+
</dl>
|
|
7458
|
+
|
|
7459
|
+
</dd>
|
|
7460
|
+
</dl>
|
|
7461
|
+
</details>
|
|
7462
|
+
|
|
7463
|
+
<details><summary><code>client.organizationTemplates.<a href="/src/management/api/resources/organizationTemplates/client/Client.ts">get</a>(id) -> Management.OrganizationTemplate</code></summary>
|
|
7464
|
+
<dl>
|
|
7465
|
+
<dd>
|
|
7466
|
+
|
|
7467
|
+
#### 📝 Description
|
|
7468
|
+
|
|
7469
|
+
<dl>
|
|
7470
|
+
<dd>
|
|
7471
|
+
|
|
7472
|
+
<dl>
|
|
7473
|
+
<dd>
|
|
7474
|
+
|
|
7475
|
+
Retrieve details about a single Organization Template specified by ID.
|
|
7476
|
+
|
|
7477
|
+
</dd>
|
|
7478
|
+
</dl>
|
|
7479
|
+
</dd>
|
|
7480
|
+
</dl>
|
|
7481
|
+
|
|
7482
|
+
#### 🔌 Usage
|
|
7483
|
+
|
|
7484
|
+
<dl>
|
|
7485
|
+
<dd>
|
|
7486
|
+
|
|
7487
|
+
<dl>
|
|
7488
|
+
<dd>
|
|
7489
|
+
|
|
7490
|
+
```typescript
|
|
7491
|
+
await client.organizationTemplates.get("id");
|
|
7492
|
+
```
|
|
7493
|
+
|
|
7494
|
+
</dd>
|
|
7495
|
+
</dl>
|
|
7496
|
+
</dd>
|
|
7497
|
+
</dl>
|
|
7498
|
+
|
|
7499
|
+
#### ⚙️ Parameters
|
|
7500
|
+
|
|
7501
|
+
<dl>
|
|
7502
|
+
<dd>
|
|
7503
|
+
|
|
7504
|
+
<dl>
|
|
7505
|
+
<dd>
|
|
7506
|
+
|
|
7507
|
+
**id:** `string` — Organization Template identifier.
|
|
7508
|
+
|
|
7509
|
+
</dd>
|
|
7510
|
+
</dl>
|
|
7511
|
+
|
|
7512
|
+
<dl>
|
|
7513
|
+
<dd>
|
|
7514
|
+
|
|
7515
|
+
**requestOptions:** `OrganizationTemplatesClient.RequestOptions`
|
|
7516
|
+
|
|
7517
|
+
</dd>
|
|
7518
|
+
</dl>
|
|
7519
|
+
</dd>
|
|
7520
|
+
</dl>
|
|
7521
|
+
|
|
7522
|
+
</dd>
|
|
7523
|
+
</dl>
|
|
7524
|
+
</details>
|
|
7525
|
+
|
|
7526
|
+
<details><summary><code>client.organizationTemplates.<a href="/src/management/api/resources/organizationTemplates/client/Client.ts">update</a>(id, { ...params }) -> Management.OrganizationTemplate</code></summary>
|
|
7527
|
+
<dl>
|
|
7528
|
+
<dd>
|
|
7529
|
+
|
|
7530
|
+
#### 📝 Description
|
|
7531
|
+
|
|
7532
|
+
<dl>
|
|
7533
|
+
<dd>
|
|
7534
|
+
|
|
7535
|
+
<dl>
|
|
7536
|
+
<dd>
|
|
7537
|
+
|
|
7538
|
+
Update the details of a specific Organization Template.
|
|
7539
|
+
|
|
7540
|
+
</dd>
|
|
7541
|
+
</dl>
|
|
7542
|
+
</dd>
|
|
7543
|
+
</dl>
|
|
7544
|
+
|
|
7545
|
+
#### 🔌 Usage
|
|
7546
|
+
|
|
7547
|
+
<dl>
|
|
7548
|
+
<dd>
|
|
7549
|
+
|
|
7550
|
+
<dl>
|
|
7551
|
+
<dd>
|
|
7552
|
+
|
|
7553
|
+
```typescript
|
|
7554
|
+
await client.organizationTemplates.update("id");
|
|
7555
|
+
```
|
|
7556
|
+
|
|
7557
|
+
</dd>
|
|
7558
|
+
</dl>
|
|
7559
|
+
</dd>
|
|
7560
|
+
</dl>
|
|
7561
|
+
|
|
7562
|
+
#### ⚙️ Parameters
|
|
7563
|
+
|
|
7564
|
+
<dl>
|
|
7565
|
+
<dd>
|
|
7566
|
+
|
|
7567
|
+
<dl>
|
|
7568
|
+
<dd>
|
|
7569
|
+
|
|
7570
|
+
**id:** `string` — Organization Template identifier.
|
|
7571
|
+
|
|
7572
|
+
</dd>
|
|
7573
|
+
</dl>
|
|
7574
|
+
|
|
7575
|
+
<dl>
|
|
7576
|
+
<dd>
|
|
7577
|
+
|
|
7578
|
+
**request:** `Management.UpdateOrganizationTemplateRequestContent`
|
|
7579
|
+
|
|
7580
|
+
</dd>
|
|
7581
|
+
</dl>
|
|
7582
|
+
|
|
7583
|
+
<dl>
|
|
7584
|
+
<dd>
|
|
7585
|
+
|
|
7586
|
+
**requestOptions:** `OrganizationTemplatesClient.RequestOptions`
|
|
7587
|
+
|
|
7588
|
+
</dd>
|
|
7589
|
+
</dl>
|
|
7590
|
+
</dd>
|
|
7591
|
+
</dl>
|
|
7592
|
+
|
|
7593
|
+
</dd>
|
|
7594
|
+
</dl>
|
|
7595
|
+
</details>
|
|
7596
|
+
|
|
7597
|
+
<details><summary><code>client.organizationTemplates.<a href="/src/management/api/resources/organizationTemplates/client/Client.ts">listOrganizations</a>(id, { ...params }) -> core.Page<Management.OrganizationTemplateAssignedOrganization, Management.ListTemplateOrganizationsPaginatedResponseContent></code></summary>
|
|
7598
|
+
<dl>
|
|
7599
|
+
<dd>
|
|
7600
|
+
|
|
7601
|
+
#### 📝 Description
|
|
7602
|
+
|
|
7603
|
+
<dl>
|
|
7604
|
+
<dd>
|
|
7605
|
+
|
|
7606
|
+
<dl>
|
|
7607
|
+
<dd>
|
|
7608
|
+
|
|
7609
|
+
Retrieve a list of organizations assigned to an Organization Template. This endpoint supports Checkpoint pagination. Results are returned in a stable order, sorted by their identifier (`id`) in ascending order.
|
|
7610
|
+
|
|
7611
|
+
</dd>
|
|
7612
|
+
</dl>
|
|
7613
|
+
</dd>
|
|
7614
|
+
</dl>
|
|
7615
|
+
|
|
7616
|
+
#### 🔌 Usage
|
|
7617
|
+
|
|
7618
|
+
<dl>
|
|
7619
|
+
<dd>
|
|
7620
|
+
|
|
7621
|
+
<dl>
|
|
7622
|
+
<dd>
|
|
7623
|
+
|
|
7624
|
+
```typescript
|
|
7625
|
+
const pageableResponse = await client.organizationTemplates.listOrganizations("id", {
|
|
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;
|
|
7644
|
+
```
|
|
7645
|
+
|
|
7646
|
+
</dd>
|
|
7647
|
+
</dl>
|
|
7648
|
+
</dd>
|
|
7649
|
+
</dl>
|
|
7650
|
+
|
|
7651
|
+
#### ⚙️ Parameters
|
|
7652
|
+
|
|
7653
|
+
<dl>
|
|
7654
|
+
<dd>
|
|
7655
|
+
|
|
7656
|
+
<dl>
|
|
7657
|
+
<dd>
|
|
7658
|
+
|
|
7659
|
+
**id:** `string` — The ID of the organization template.
|
|
7660
|
+
|
|
7661
|
+
</dd>
|
|
7662
|
+
</dl>
|
|
7663
|
+
|
|
7664
|
+
<dl>
|
|
7665
|
+
<dd>
|
|
7666
|
+
|
|
7667
|
+
**request:** `Management.ListTemplateOrganizationsRequestParameters`
|
|
7668
|
+
|
|
7669
|
+
</dd>
|
|
7670
|
+
</dl>
|
|
7671
|
+
|
|
7672
|
+
<dl>
|
|
7673
|
+
<dd>
|
|
7674
|
+
|
|
7675
|
+
**requestOptions:** `OrganizationTemplatesClient.RequestOptions`
|
|
7676
|
+
|
|
7677
|
+
</dd>
|
|
7678
|
+
</dl>
|
|
7679
|
+
</dd>
|
|
7680
|
+
</dl>
|
|
7681
|
+
|
|
7682
|
+
</dd>
|
|
7683
|
+
</dl>
|
|
7684
|
+
</details>
|
|
7685
|
+
|
|
7312
7686
|
## Organizations
|
|
7313
7687
|
|
|
7314
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>
|
|
@@ -23003,7 +23377,271 @@ await client.keys.encryption.rekey();
|
|
|
23003
23377
|
</dl>
|
|
23004
23378
|
</details>
|
|
23005
23379
|
|
|
23006
|
-
<details><summary><code>client.keys.encryption.<a href="/src/management/api/resources/keys/resources/encryption/client/Client.ts">get</a>(kid) -> Management.GetEncryptionKeyResponseContent</code></summary>
|
|
23380
|
+
<details><summary><code>client.keys.encryption.<a href="/src/management/api/resources/keys/resources/encryption/client/Client.ts">get</a>(kid) -> Management.GetEncryptionKeyResponseContent</code></summary>
|
|
23381
|
+
<dl>
|
|
23382
|
+
<dd>
|
|
23383
|
+
|
|
23384
|
+
#### 📝 Description
|
|
23385
|
+
|
|
23386
|
+
<dl>
|
|
23387
|
+
<dd>
|
|
23388
|
+
|
|
23389
|
+
<dl>
|
|
23390
|
+
<dd>
|
|
23391
|
+
|
|
23392
|
+
Retrieve details of the encryption key with the given ID.
|
|
23393
|
+
|
|
23394
|
+
</dd>
|
|
23395
|
+
</dl>
|
|
23396
|
+
</dd>
|
|
23397
|
+
</dl>
|
|
23398
|
+
|
|
23399
|
+
#### 🔌 Usage
|
|
23400
|
+
|
|
23401
|
+
<dl>
|
|
23402
|
+
<dd>
|
|
23403
|
+
|
|
23404
|
+
<dl>
|
|
23405
|
+
<dd>
|
|
23406
|
+
|
|
23407
|
+
```typescript
|
|
23408
|
+
await client.keys.encryption.get("kid");
|
|
23409
|
+
```
|
|
23410
|
+
|
|
23411
|
+
</dd>
|
|
23412
|
+
</dl>
|
|
23413
|
+
</dd>
|
|
23414
|
+
</dl>
|
|
23415
|
+
|
|
23416
|
+
#### ⚙️ Parameters
|
|
23417
|
+
|
|
23418
|
+
<dl>
|
|
23419
|
+
<dd>
|
|
23420
|
+
|
|
23421
|
+
<dl>
|
|
23422
|
+
<dd>
|
|
23423
|
+
|
|
23424
|
+
**kid:** `string` — Encryption key ID
|
|
23425
|
+
|
|
23426
|
+
</dd>
|
|
23427
|
+
</dl>
|
|
23428
|
+
|
|
23429
|
+
<dl>
|
|
23430
|
+
<dd>
|
|
23431
|
+
|
|
23432
|
+
**requestOptions:** `EncryptionClient.RequestOptions`
|
|
23433
|
+
|
|
23434
|
+
</dd>
|
|
23435
|
+
</dl>
|
|
23436
|
+
</dd>
|
|
23437
|
+
</dl>
|
|
23438
|
+
|
|
23439
|
+
</dd>
|
|
23440
|
+
</dl>
|
|
23441
|
+
</details>
|
|
23442
|
+
|
|
23443
|
+
<details><summary><code>client.keys.encryption.<a href="/src/management/api/resources/keys/resources/encryption/client/Client.ts">import</a>(kid, { ...params }) -> Management.ImportEncryptionKeyResponseContent</code></summary>
|
|
23444
|
+
<dl>
|
|
23445
|
+
<dd>
|
|
23446
|
+
|
|
23447
|
+
#### 📝 Description
|
|
23448
|
+
|
|
23449
|
+
<dl>
|
|
23450
|
+
<dd>
|
|
23451
|
+
|
|
23452
|
+
<dl>
|
|
23453
|
+
<dd>
|
|
23454
|
+
|
|
23455
|
+
Import wrapped key material and activate encryption key.
|
|
23456
|
+
|
|
23457
|
+
</dd>
|
|
23458
|
+
</dl>
|
|
23459
|
+
</dd>
|
|
23460
|
+
</dl>
|
|
23461
|
+
|
|
23462
|
+
#### 🔌 Usage
|
|
23463
|
+
|
|
23464
|
+
<dl>
|
|
23465
|
+
<dd>
|
|
23466
|
+
|
|
23467
|
+
<dl>
|
|
23468
|
+
<dd>
|
|
23469
|
+
|
|
23470
|
+
```typescript
|
|
23471
|
+
await client.keys.encryption.import("kid", {
|
|
23472
|
+
wrapped_key: "wrapped_key",
|
|
23473
|
+
});
|
|
23474
|
+
```
|
|
23475
|
+
|
|
23476
|
+
</dd>
|
|
23477
|
+
</dl>
|
|
23478
|
+
</dd>
|
|
23479
|
+
</dl>
|
|
23480
|
+
|
|
23481
|
+
#### ⚙️ Parameters
|
|
23482
|
+
|
|
23483
|
+
<dl>
|
|
23484
|
+
<dd>
|
|
23485
|
+
|
|
23486
|
+
<dl>
|
|
23487
|
+
<dd>
|
|
23488
|
+
|
|
23489
|
+
**kid:** `string` — Encryption key ID
|
|
23490
|
+
|
|
23491
|
+
</dd>
|
|
23492
|
+
</dl>
|
|
23493
|
+
|
|
23494
|
+
<dl>
|
|
23495
|
+
<dd>
|
|
23496
|
+
|
|
23497
|
+
**request:** `Management.ImportEncryptionKeyRequestContent`
|
|
23498
|
+
|
|
23499
|
+
</dd>
|
|
23500
|
+
</dl>
|
|
23501
|
+
|
|
23502
|
+
<dl>
|
|
23503
|
+
<dd>
|
|
23504
|
+
|
|
23505
|
+
**requestOptions:** `EncryptionClient.RequestOptions`
|
|
23506
|
+
|
|
23507
|
+
</dd>
|
|
23508
|
+
</dl>
|
|
23509
|
+
</dd>
|
|
23510
|
+
</dl>
|
|
23511
|
+
|
|
23512
|
+
</dd>
|
|
23513
|
+
</dl>
|
|
23514
|
+
</details>
|
|
23515
|
+
|
|
23516
|
+
<details><summary><code>client.keys.encryption.<a href="/src/management/api/resources/keys/resources/encryption/client/Client.ts">delete</a>(kid) -> void</code></summary>
|
|
23517
|
+
<dl>
|
|
23518
|
+
<dd>
|
|
23519
|
+
|
|
23520
|
+
#### 📝 Description
|
|
23521
|
+
|
|
23522
|
+
<dl>
|
|
23523
|
+
<dd>
|
|
23524
|
+
|
|
23525
|
+
<dl>
|
|
23526
|
+
<dd>
|
|
23527
|
+
|
|
23528
|
+
Delete the custom provided encryption key with the given ID and move back to using native encryption key.
|
|
23529
|
+
|
|
23530
|
+
</dd>
|
|
23531
|
+
</dl>
|
|
23532
|
+
</dd>
|
|
23533
|
+
</dl>
|
|
23534
|
+
|
|
23535
|
+
#### 🔌 Usage
|
|
23536
|
+
|
|
23537
|
+
<dl>
|
|
23538
|
+
<dd>
|
|
23539
|
+
|
|
23540
|
+
<dl>
|
|
23541
|
+
<dd>
|
|
23542
|
+
|
|
23543
|
+
```typescript
|
|
23544
|
+
await client.keys.encryption.delete("kid");
|
|
23545
|
+
```
|
|
23546
|
+
|
|
23547
|
+
</dd>
|
|
23548
|
+
</dl>
|
|
23549
|
+
</dd>
|
|
23550
|
+
</dl>
|
|
23551
|
+
|
|
23552
|
+
#### ⚙️ Parameters
|
|
23553
|
+
|
|
23554
|
+
<dl>
|
|
23555
|
+
<dd>
|
|
23556
|
+
|
|
23557
|
+
<dl>
|
|
23558
|
+
<dd>
|
|
23559
|
+
|
|
23560
|
+
**kid:** `string` — Encryption key ID
|
|
23561
|
+
|
|
23562
|
+
</dd>
|
|
23563
|
+
</dl>
|
|
23564
|
+
|
|
23565
|
+
<dl>
|
|
23566
|
+
<dd>
|
|
23567
|
+
|
|
23568
|
+
**requestOptions:** `EncryptionClient.RequestOptions`
|
|
23569
|
+
|
|
23570
|
+
</dd>
|
|
23571
|
+
</dl>
|
|
23572
|
+
</dd>
|
|
23573
|
+
</dl>
|
|
23574
|
+
|
|
23575
|
+
</dd>
|
|
23576
|
+
</dl>
|
|
23577
|
+
</details>
|
|
23578
|
+
|
|
23579
|
+
<details><summary><code>client.keys.encryption.<a href="/src/management/api/resources/keys/resources/encryption/client/Client.ts">createPublicWrappingKey</a>(kid) -> Management.CreateEncryptionKeyPublicWrappingResponseContent</code></summary>
|
|
23580
|
+
<dl>
|
|
23581
|
+
<dd>
|
|
23582
|
+
|
|
23583
|
+
#### 📝 Description
|
|
23584
|
+
|
|
23585
|
+
<dl>
|
|
23586
|
+
<dd>
|
|
23587
|
+
|
|
23588
|
+
<dl>
|
|
23589
|
+
<dd>
|
|
23590
|
+
|
|
23591
|
+
Create the public wrapping key to wrap your own encryption key material.
|
|
23592
|
+
|
|
23593
|
+
</dd>
|
|
23594
|
+
</dl>
|
|
23595
|
+
</dd>
|
|
23596
|
+
</dl>
|
|
23597
|
+
|
|
23598
|
+
#### 🔌 Usage
|
|
23599
|
+
|
|
23600
|
+
<dl>
|
|
23601
|
+
<dd>
|
|
23602
|
+
|
|
23603
|
+
<dl>
|
|
23604
|
+
<dd>
|
|
23605
|
+
|
|
23606
|
+
```typescript
|
|
23607
|
+
await client.keys.encryption.createPublicWrappingKey("kid");
|
|
23608
|
+
```
|
|
23609
|
+
|
|
23610
|
+
</dd>
|
|
23611
|
+
</dl>
|
|
23612
|
+
</dd>
|
|
23613
|
+
</dl>
|
|
23614
|
+
|
|
23615
|
+
#### ⚙️ Parameters
|
|
23616
|
+
|
|
23617
|
+
<dl>
|
|
23618
|
+
<dd>
|
|
23619
|
+
|
|
23620
|
+
<dl>
|
|
23621
|
+
<dd>
|
|
23622
|
+
|
|
23623
|
+
**kid:** `string` — Encryption key ID
|
|
23624
|
+
|
|
23625
|
+
</dd>
|
|
23626
|
+
</dl>
|
|
23627
|
+
|
|
23628
|
+
<dl>
|
|
23629
|
+
<dd>
|
|
23630
|
+
|
|
23631
|
+
**requestOptions:** `EncryptionClient.RequestOptions`
|
|
23632
|
+
|
|
23633
|
+
</dd>
|
|
23634
|
+
</dl>
|
|
23635
|
+
</dd>
|
|
23636
|
+
</dl>
|
|
23637
|
+
|
|
23638
|
+
</dd>
|
|
23639
|
+
</dl>
|
|
23640
|
+
</details>
|
|
23641
|
+
|
|
23642
|
+
## Keys NetworkAcls
|
|
23643
|
+
|
|
23644
|
+
<details><summary><code>client.keys.networkAcls.<a href="/src/management/api/resources/keys/resources/networkAcls/client/Client.ts">list</a>() -> Management.GetAllKeysNetworkAclsResponseContent</code></summary>
|
|
23007
23645
|
<dl>
|
|
23008
23646
|
<dd>
|
|
23009
23647
|
|
|
@@ -23015,7 +23653,7 @@ await client.keys.encryption.rekey();
|
|
|
23015
23653
|
<dl>
|
|
23016
23654
|
<dd>
|
|
23017
23655
|
|
|
23018
|
-
Retrieve
|
|
23656
|
+
Retrieve all keys used to verify HTTP Message Signatures on Network ACL rules, ordered by creation time descending.
|
|
23019
23657
|
|
|
23020
23658
|
</dd>
|
|
23021
23659
|
</dl>
|
|
@@ -23031,7 +23669,7 @@ Retrieve details of the encryption key with the given ID.
|
|
|
23031
23669
|
<dd>
|
|
23032
23670
|
|
|
23033
23671
|
```typescript
|
|
23034
|
-
await client.keys.
|
|
23672
|
+
await client.keys.networkAcls.list();
|
|
23035
23673
|
```
|
|
23036
23674
|
|
|
23037
23675
|
</dd>
|
|
@@ -23047,15 +23685,7 @@ await client.keys.encryption.get("kid");
|
|
|
23047
23685
|
<dl>
|
|
23048
23686
|
<dd>
|
|
23049
23687
|
|
|
23050
|
-
**
|
|
23051
|
-
|
|
23052
|
-
</dd>
|
|
23053
|
-
</dl>
|
|
23054
|
-
|
|
23055
|
-
<dl>
|
|
23056
|
-
<dd>
|
|
23057
|
-
|
|
23058
|
-
**requestOptions:** `EncryptionClient.RequestOptions`
|
|
23688
|
+
**requestOptions:** `NetworkAclsClient.RequestOptions`
|
|
23059
23689
|
|
|
23060
23690
|
</dd>
|
|
23061
23691
|
</dl>
|
|
@@ -23066,7 +23696,7 @@ await client.keys.encryption.get("kid");
|
|
|
23066
23696
|
</dl>
|
|
23067
23697
|
</details>
|
|
23068
23698
|
|
|
23069
|
-
<details><summary><code>client.keys.
|
|
23699
|
+
<details><summary><code>client.keys.networkAcls.<a href="/src/management/api/resources/keys/resources/networkAcls/client/Client.ts">create</a>({ ...params }) -> Management.CreateKeysNetworkAclsResponseContent</code></summary>
|
|
23070
23700
|
<dl>
|
|
23071
23701
|
<dd>
|
|
23072
23702
|
|
|
@@ -23078,7 +23708,7 @@ await client.keys.encryption.get("kid");
|
|
|
23078
23708
|
<dl>
|
|
23079
23709
|
<dd>
|
|
23080
23710
|
|
|
23081
|
-
|
|
23711
|
+
Create a new key used to verify HTTP Message Signatures on Network ACL rules.
|
|
23082
23712
|
|
|
23083
23713
|
</dd>
|
|
23084
23714
|
</dl>
|
|
@@ -23094,8 +23724,10 @@ Import wrapped key material and activate encryption key.
|
|
|
23094
23724
|
<dd>
|
|
23095
23725
|
|
|
23096
23726
|
```typescript
|
|
23097
|
-
await client.keys.
|
|
23098
|
-
|
|
23727
|
+
await client.keys.networkAcls.create({
|
|
23728
|
+
name: "name",
|
|
23729
|
+
alg: "hmac-sha256",
|
|
23730
|
+
value: "value",
|
|
23099
23731
|
});
|
|
23100
23732
|
```
|
|
23101
23733
|
|
|
@@ -23112,15 +23744,7 @@ await client.keys.encryption.import("kid", {
|
|
|
23112
23744
|
<dl>
|
|
23113
23745
|
<dd>
|
|
23114
23746
|
|
|
23115
|
-
**
|
|
23116
|
-
|
|
23117
|
-
</dd>
|
|
23118
|
-
</dl>
|
|
23119
|
-
|
|
23120
|
-
<dl>
|
|
23121
|
-
<dd>
|
|
23122
|
-
|
|
23123
|
-
**request:** `Management.ImportEncryptionKeyRequestContent`
|
|
23747
|
+
**request:** `Management.CreateKeysNetworkAclsRequestContent`
|
|
23124
23748
|
|
|
23125
23749
|
</dd>
|
|
23126
23750
|
</dl>
|
|
@@ -23128,7 +23752,7 @@ await client.keys.encryption.import("kid", {
|
|
|
23128
23752
|
<dl>
|
|
23129
23753
|
<dd>
|
|
23130
23754
|
|
|
23131
|
-
**requestOptions:** `
|
|
23755
|
+
**requestOptions:** `NetworkAclsClient.RequestOptions`
|
|
23132
23756
|
|
|
23133
23757
|
</dd>
|
|
23134
23758
|
</dl>
|
|
@@ -23139,7 +23763,7 @@ await client.keys.encryption.import("kid", {
|
|
|
23139
23763
|
</dl>
|
|
23140
23764
|
</details>
|
|
23141
23765
|
|
|
23142
|
-
<details><summary><code>client.keys.
|
|
23766
|
+
<details><summary><code>client.keys.networkAcls.<a href="/src/management/api/resources/keys/resources/networkAcls/client/Client.ts">get</a>(id) -> Management.NetworkAclKey</code></summary>
|
|
23143
23767
|
<dl>
|
|
23144
23768
|
<dd>
|
|
23145
23769
|
|
|
@@ -23151,7 +23775,7 @@ await client.keys.encryption.import("kid", {
|
|
|
23151
23775
|
<dl>
|
|
23152
23776
|
<dd>
|
|
23153
23777
|
|
|
23154
|
-
|
|
23778
|
+
Retrieve a specific key used to verify HTTP Message Signatures on Network ACL rules.
|
|
23155
23779
|
|
|
23156
23780
|
</dd>
|
|
23157
23781
|
</dl>
|
|
@@ -23167,7 +23791,7 @@ Delete the custom provided encryption key with the given ID and move back to usi
|
|
|
23167
23791
|
<dd>
|
|
23168
23792
|
|
|
23169
23793
|
```typescript
|
|
23170
|
-
await client.keys.
|
|
23794
|
+
await client.keys.networkAcls.get("id");
|
|
23171
23795
|
```
|
|
23172
23796
|
|
|
23173
23797
|
</dd>
|
|
@@ -23183,7 +23807,7 @@ await client.keys.encryption.delete("kid");
|
|
|
23183
23807
|
<dl>
|
|
23184
23808
|
<dd>
|
|
23185
23809
|
|
|
23186
|
-
**
|
|
23810
|
+
**id:** `string` — ID of the Network ACL Key to retrieve.
|
|
23187
23811
|
|
|
23188
23812
|
</dd>
|
|
23189
23813
|
</dl>
|
|
@@ -23191,7 +23815,7 @@ await client.keys.encryption.delete("kid");
|
|
|
23191
23815
|
<dl>
|
|
23192
23816
|
<dd>
|
|
23193
23817
|
|
|
23194
|
-
**requestOptions:** `
|
|
23818
|
+
**requestOptions:** `NetworkAclsClient.RequestOptions`
|
|
23195
23819
|
|
|
23196
23820
|
</dd>
|
|
23197
23821
|
</dl>
|
|
@@ -23202,7 +23826,7 @@ await client.keys.encryption.delete("kid");
|
|
|
23202
23826
|
</dl>
|
|
23203
23827
|
</details>
|
|
23204
23828
|
|
|
23205
|
-
<details><summary><code>client.keys.
|
|
23829
|
+
<details><summary><code>client.keys.networkAcls.<a href="/src/management/api/resources/keys/resources/networkAcls/client/Client.ts">delete</a>(id) -> void</code></summary>
|
|
23206
23830
|
<dl>
|
|
23207
23831
|
<dd>
|
|
23208
23832
|
|
|
@@ -23214,7 +23838,7 @@ await client.keys.encryption.delete("kid");
|
|
|
23214
23838
|
<dl>
|
|
23215
23839
|
<dd>
|
|
23216
23840
|
|
|
23217
|
-
|
|
23841
|
+
Delete a key used to verify HTTP Message Signatures on Network ACL rules
|
|
23218
23842
|
|
|
23219
23843
|
</dd>
|
|
23220
23844
|
</dl>
|
|
@@ -23230,7 +23854,7 @@ Create the public wrapping key to wrap your own encryption key material.
|
|
|
23230
23854
|
<dd>
|
|
23231
23855
|
|
|
23232
23856
|
```typescript
|
|
23233
|
-
await client.keys.
|
|
23857
|
+
await client.keys.networkAcls.delete("id");
|
|
23234
23858
|
```
|
|
23235
23859
|
|
|
23236
23860
|
</dd>
|
|
@@ -23246,7 +23870,7 @@ await client.keys.encryption.createPublicWrappingKey("kid");
|
|
|
23246
23870
|
<dl>
|
|
23247
23871
|
<dd>
|
|
23248
23872
|
|
|
23249
|
-
**
|
|
23873
|
+
**id:** `string` — ID of the Network ACL Key to delete.
|
|
23250
23874
|
|
|
23251
23875
|
</dd>
|
|
23252
23876
|
</dl>
|
|
@@ -23254,7 +23878,7 @@ await client.keys.encryption.createPublicWrappingKey("kid");
|
|
|
23254
23878
|
<dl>
|
|
23255
23879
|
<dd>
|
|
23256
23880
|
|
|
23257
|
-
**requestOptions:** `
|
|
23881
|
+
**requestOptions:** `NetworkAclsClient.RequestOptions`
|
|
23258
23882
|
|
|
23259
23883
|
</dd>
|
|
23260
23884
|
</dl>
|
|
@@ -25808,6 +26432,213 @@ await client.organizations.members.delete("id", {
|
|
|
25808
26432
|
</dl>
|
|
25809
26433
|
</details>
|
|
25810
26434
|
|
|
26435
|
+
## Organizations OrganizationTemplate
|
|
26436
|
+
|
|
26437
|
+
<details><summary><code>client.organizations.organizationTemplate.<a href="/src/management/api/resources/organizations/resources/organizationTemplate/client/Client.ts">get</a>(id) -> Management.OrganizationTemplate</code></summary>
|
|
26438
|
+
<dl>
|
|
26439
|
+
<dd>
|
|
26440
|
+
|
|
26441
|
+
#### 📝 Description
|
|
26442
|
+
|
|
26443
|
+
<dl>
|
|
26444
|
+
<dd>
|
|
26445
|
+
|
|
26446
|
+
<dl>
|
|
26447
|
+
<dd>
|
|
26448
|
+
|
|
26449
|
+
Retrieve the organization template assigned to a specific organization. Returns the template object if one is explicitly assigned, or a 404 if no template is assigned.
|
|
26450
|
+
|
|
26451
|
+
</dd>
|
|
26452
|
+
</dl>
|
|
26453
|
+
</dd>
|
|
26454
|
+
</dl>
|
|
26455
|
+
|
|
26456
|
+
#### 🔌 Usage
|
|
26457
|
+
|
|
26458
|
+
<dl>
|
|
26459
|
+
<dd>
|
|
26460
|
+
|
|
26461
|
+
<dl>
|
|
26462
|
+
<dd>
|
|
26463
|
+
|
|
26464
|
+
```typescript
|
|
26465
|
+
await client.organizations.organizationTemplate.get("id");
|
|
26466
|
+
```
|
|
26467
|
+
|
|
26468
|
+
</dd>
|
|
26469
|
+
</dl>
|
|
26470
|
+
</dd>
|
|
26471
|
+
</dl>
|
|
26472
|
+
|
|
26473
|
+
#### ⚙️ Parameters
|
|
26474
|
+
|
|
26475
|
+
<dl>
|
|
26476
|
+
<dd>
|
|
26477
|
+
|
|
26478
|
+
<dl>
|
|
26479
|
+
<dd>
|
|
26480
|
+
|
|
26481
|
+
**id:** `string` — ID of the organization.
|
|
26482
|
+
|
|
26483
|
+
</dd>
|
|
26484
|
+
</dl>
|
|
26485
|
+
|
|
26486
|
+
<dl>
|
|
26487
|
+
<dd>
|
|
26488
|
+
|
|
26489
|
+
**requestOptions:** `OrganizationTemplateClient.RequestOptions`
|
|
26490
|
+
|
|
26491
|
+
</dd>
|
|
26492
|
+
</dl>
|
|
26493
|
+
</dd>
|
|
26494
|
+
</dl>
|
|
26495
|
+
|
|
26496
|
+
</dd>
|
|
26497
|
+
</dl>
|
|
26498
|
+
</details>
|
|
26499
|
+
|
|
26500
|
+
<details><summary><code>client.organizations.organizationTemplate.<a href="/src/management/api/resources/organizations/resources/organizationTemplate/client/Client.ts">assignOrganizationTemplate</a>(id, template_id) -> void</code></summary>
|
|
26501
|
+
<dl>
|
|
26502
|
+
<dd>
|
|
26503
|
+
|
|
26504
|
+
#### 📝 Description
|
|
26505
|
+
|
|
26506
|
+
<dl>
|
|
26507
|
+
<dd>
|
|
26508
|
+
|
|
26509
|
+
<dl>
|
|
26510
|
+
<dd>
|
|
26511
|
+
|
|
26512
|
+
Assign an Organization Template to an organization.
|
|
26513
|
+
|
|
26514
|
+
</dd>
|
|
26515
|
+
</dl>
|
|
26516
|
+
</dd>
|
|
26517
|
+
</dl>
|
|
26518
|
+
|
|
26519
|
+
#### 🔌 Usage
|
|
26520
|
+
|
|
26521
|
+
<dl>
|
|
26522
|
+
<dd>
|
|
26523
|
+
|
|
26524
|
+
<dl>
|
|
26525
|
+
<dd>
|
|
26526
|
+
|
|
26527
|
+
```typescript
|
|
26528
|
+
await client.organizations.organizationTemplate.assignOrganizationTemplate("id", "template_id");
|
|
26529
|
+
```
|
|
26530
|
+
|
|
26531
|
+
</dd>
|
|
26532
|
+
</dl>
|
|
26533
|
+
</dd>
|
|
26534
|
+
</dl>
|
|
26535
|
+
|
|
26536
|
+
#### ⚙️ Parameters
|
|
26537
|
+
|
|
26538
|
+
<dl>
|
|
26539
|
+
<dd>
|
|
26540
|
+
|
|
26541
|
+
<dl>
|
|
26542
|
+
<dd>
|
|
26543
|
+
|
|
26544
|
+
**id:** `string` — The ID of the organization.
|
|
26545
|
+
|
|
26546
|
+
</dd>
|
|
26547
|
+
</dl>
|
|
26548
|
+
|
|
26549
|
+
<dl>
|
|
26550
|
+
<dd>
|
|
26551
|
+
|
|
26552
|
+
**template_id:** `string` — The ID of the organization template to assign.
|
|
26553
|
+
|
|
26554
|
+
</dd>
|
|
26555
|
+
</dl>
|
|
26556
|
+
|
|
26557
|
+
<dl>
|
|
26558
|
+
<dd>
|
|
26559
|
+
|
|
26560
|
+
**requestOptions:** `OrganizationTemplateClient.RequestOptions`
|
|
26561
|
+
|
|
26562
|
+
</dd>
|
|
26563
|
+
</dl>
|
|
26564
|
+
</dd>
|
|
26565
|
+
</dl>
|
|
26566
|
+
|
|
26567
|
+
</dd>
|
|
26568
|
+
</dl>
|
|
26569
|
+
</details>
|
|
26570
|
+
|
|
26571
|
+
<details><summary><code>client.organizations.organizationTemplate.<a href="/src/management/api/resources/organizations/resources/organizationTemplate/client/Client.ts">unassignOrganizationTemplate</a>(id, template_id) -> void</code></summary>
|
|
26572
|
+
<dl>
|
|
26573
|
+
<dd>
|
|
26574
|
+
|
|
26575
|
+
#### 📝 Description
|
|
26576
|
+
|
|
26577
|
+
<dl>
|
|
26578
|
+
<dd>
|
|
26579
|
+
|
|
26580
|
+
<dl>
|
|
26581
|
+
<dd>
|
|
26582
|
+
|
|
26583
|
+
Remove an Organization Template assignment from an organization.
|
|
26584
|
+
|
|
26585
|
+
</dd>
|
|
26586
|
+
</dl>
|
|
26587
|
+
</dd>
|
|
26588
|
+
</dl>
|
|
26589
|
+
|
|
26590
|
+
#### 🔌 Usage
|
|
26591
|
+
|
|
26592
|
+
<dl>
|
|
26593
|
+
<dd>
|
|
26594
|
+
|
|
26595
|
+
<dl>
|
|
26596
|
+
<dd>
|
|
26597
|
+
|
|
26598
|
+
```typescript
|
|
26599
|
+
await client.organizations.organizationTemplate.unassignOrganizationTemplate("id", "template_id");
|
|
26600
|
+
```
|
|
26601
|
+
|
|
26602
|
+
</dd>
|
|
26603
|
+
</dl>
|
|
26604
|
+
</dd>
|
|
26605
|
+
</dl>
|
|
26606
|
+
|
|
26607
|
+
#### ⚙️ Parameters
|
|
26608
|
+
|
|
26609
|
+
<dl>
|
|
26610
|
+
<dd>
|
|
26611
|
+
|
|
26612
|
+
<dl>
|
|
26613
|
+
<dd>
|
|
26614
|
+
|
|
26615
|
+
**id:** `string` — The ID of the organization.
|
|
26616
|
+
|
|
26617
|
+
</dd>
|
|
26618
|
+
</dl>
|
|
26619
|
+
|
|
26620
|
+
<dl>
|
|
26621
|
+
<dd>
|
|
26622
|
+
|
|
26623
|
+
**template_id:** `string` — The ID of the organization template to unassign.
|
|
26624
|
+
|
|
26625
|
+
</dd>
|
|
26626
|
+
</dl>
|
|
26627
|
+
|
|
26628
|
+
<dl>
|
|
26629
|
+
<dd>
|
|
26630
|
+
|
|
26631
|
+
**requestOptions:** `OrganizationTemplateClient.RequestOptions`
|
|
26632
|
+
|
|
26633
|
+
</dd>
|
|
26634
|
+
</dl>
|
|
26635
|
+
</dd>
|
|
26636
|
+
</dl>
|
|
26637
|
+
|
|
26638
|
+
</dd>
|
|
26639
|
+
</dl>
|
|
26640
|
+
</details>
|
|
26641
|
+
|
|
25811
26642
|
## Organizations Groups
|
|
25812
26643
|
|
|
25813
26644
|
<details><summary><code>client.organizations.groups.<a href="/src/management/api/resources/organizations/resources/groups/client/Client.ts">list</a>(organization_id, { ...params }) -> core.Page<Management.Group, Management.ListOrganizationGroupsResponseContent></code></summary>
|
|
@@ -30255,6 +31086,22 @@ await client.users.multifactor.deleteProvider("id", "duo");
|
|
|
30255
31086
|
|
|
30256
31087
|
Retrieve list of the specified user's current Organization memberships. User must be specified by user ID. For more information, review [Auth0 Organizations](https://auth0.com/docs/manage-users/organizations).
|
|
30257
31088
|
|
|
31089
|
+
This endpoint supports two types of pagination:
|
|
31090
|
+
|
|
31091
|
+
- Offset pagination
|
|
31092
|
+
- Checkpoint pagination
|
|
31093
|
+
|
|
31094
|
+
Checkpoint pagination must be used if you need to retrieve more than 1000 organizations.
|
|
31095
|
+
|
|
31096
|
+
**Checkpoint Pagination**
|
|
31097
|
+
|
|
31098
|
+
To search by checkpoint, use the following parameters:
|
|
31099
|
+
|
|
31100
|
+
- `from`: Optional id from which to start selection.
|
|
31101
|
+
- `take`: The total number of entries to retrieve when using the `from` parameter. Defaults to 50.
|
|
31102
|
+
|
|
31103
|
+
**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.
|
|
31104
|
+
|
|
30258
31105
|
</dd>
|
|
30259
31106
|
</dl>
|
|
30260
31107
|
</dd>
|