auth0 6.3.0 → 7.0.0

package/reference.md

@@ -7309,6 +7309,380 @@ await client.networkAcls.update("id");
 </dl>
 </details>
 
+## OrganizationTemplates
+
+<details><summary><code>client.organizationTemplates.<a href="/src/management/api/resources/organizationTemplates/client/Client.ts">list</a>({ ...params }) -> core.Page&lt;Management.OrganizationTemplate, Management.ListOrganizationTemplatesPaginatedResponseContent&gt;</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+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.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+const pageableResponse = await client.organizationTemplates.list({
+    from: "from",
+    take: 1,
+});
+for await (const item of pageableResponse) {
+    console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.organizationTemplates.list({
+    from: "from",
+    take: 1,
+});
+while (page.hasNextPage()) {
+    page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Management.ListOrganizationTemplatesRequestParameters`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `OrganizationTemplatesClient.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.organizationTemplates.<a href="/src/management/api/resources/organizationTemplates/client/Client.ts">create</a>({ ...params }) -> Management.OrganizationTemplate</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Create an Organization Template.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.organizationTemplates.create({
+    name: "name",
+    organization_deletion_behavior: "allow",
+    enforce_permission_ceiling: true,
+    enforce_self_assignment_restriction: true,
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Management.CreateOrganizationTemplateRequestContent`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `OrganizationTemplatesClient.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.organizationTemplates.<a href="/src/management/api/resources/organizationTemplates/client/Client.ts">get</a>(id) -> Management.OrganizationTemplate</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Retrieve details about a single Organization Template specified by ID.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.organizationTemplates.get("id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**id:** `string` — Organization Template identifier.
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `OrganizationTemplatesClient.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.organizationTemplates.<a href="/src/management/api/resources/organizationTemplates/client/Client.ts">update</a>(id, { ...params }) -> Management.OrganizationTemplate</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Update the details of a specific Organization Template.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.organizationTemplates.update("id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**id:** `string` — Organization Template identifier.
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `Management.UpdateOrganizationTemplateRequestContent`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `OrganizationTemplatesClient.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.organizationTemplates.<a href="/src/management/api/resources/organizationTemplates/client/Client.ts">listOrganizations</a>(id, { ...params }) -> core.Page&lt;Management.OrganizationTemplateAssignedOrganization, Management.ListTemplateOrganizationsPaginatedResponseContent&gt;</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+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.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+const pageableResponse = await client.organizationTemplates.listOrganizations("id", {
+    from: "from",
+    take: 1,
+});
+for await (const item of pageableResponse) {
+    console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.organizationTemplates.listOrganizations("id", {
+    from: "from",
+    take: 1,
+});
+while (page.hasNextPage()) {
+    page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**id:** `string` — The ID of the organization template.
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `Management.ListTemplateOrganizationsRequestParameters`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `OrganizationTemplatesClient.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## Organizations
 
 <details><summary><code>client.organizations.<a href="/src/management/api/resources/organizations/client/Client.ts">list</a>({ ...params }) -> core.Page&lt;Management.Organization, Management.ListOrganizationsPaginatedResponseContent&gt;</code></summary>
@@ -23214,7 +23588,72 @@ await client.keys.encryption.delete("kid");
 <dl>
 <dd>
 
-Create the public wrapping key to wrap your own encryption key material.
+Create the public wrapping key to wrap your own encryption key material.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.keys.encryption.createPublicWrappingKey("kid");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**kid:** `string` — Encryption key ID
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `EncryptionClient.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+## Keys NetworkAcls
+
+<details><summary><code>client.keys.networkAcls.<a href="/src/management/api/resources/keys/resources/networkAcls/client/Client.ts">list</a>() -> Management.GetAllKeysNetworkAclsResponseContent</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Retrieve all keys used to verify HTTP Message Signatures on Network ACL rules, ordered by creation time descending.
 
 </dd>
 </dl>
@@ -23230,7 +23669,7 @@ Create the public wrapping key to wrap your own encryption key material.
 <dd>
 
 ```typescript
-await client.keys.encryption.createPublicWrappingKey("kid");
+await client.keys.networkAcls.list();
 ```
 
 </dd>
@@ -23246,15 +23685,7 @@ await client.keys.encryption.createPublicWrappingKey("kid");
 <dl>
 <dd>
 
-**kid:** `string` — Encryption key ID
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `EncryptionClient.RequestOptions`
+**requestOptions:** `NetworkAclsClient.RequestOptions`
 
 </dd>
 </dl>
@@ -23265,9 +23696,7 @@ await client.keys.encryption.createPublicWrappingKey("kid");
 </dl>
 </details>
 
-## Keys NetworkAcls
-
-<details><summary><code>client.keys.networkAcls.<a href="/src/management/api/resources/keys/resources/networkAcls/client/Client.ts">list</a>() -> Management.GetAllKeysNetworkAclsResponseContent</code></summary>
+<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>
 <dl>
 <dd>
 
@@ -23279,7 +23708,7 @@ await client.keys.encryption.createPublicWrappingKey("kid");
 <dl>
 <dd>
 
-Retrieve all keys used to verify HTTP Message Signatures on Network ACL rules, ordered by creation time descending.
+Create a new key used to verify HTTP Message Signatures on Network ACL rules.
 
 </dd>
 </dl>
@@ -23295,7 +23724,11 @@ Retrieve all keys used to verify HTTP Message Signatures on Network ACL rules, o
 <dd>
 
 ```typescript
-await client.keys.networkAcls.list();
+await client.keys.networkAcls.create({
+    name: "name",
+    alg: "hmac-sha256",
+    value: "value",
+});
 ```
 
 </dd>
@@ -23311,6 +23744,14 @@ await client.keys.networkAcls.list();
 <dl>
 <dd>
 
+**request:** `Management.CreateKeysNetworkAclsRequestContent`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **requestOptions:** `NetworkAclsClient.RequestOptions`
 
 </dd>
@@ -23322,7 +23763,7 @@ await client.keys.networkAcls.list();
 </dl>
 </details>
 
-<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>
+<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>
 <dl>
 <dd>
 
@@ -23334,7 +23775,7 @@ await client.keys.networkAcls.list();
 <dl>
 <dd>
 
-Create a new key used to verify HTTP Message Signatures on Network ACL rules.
+Retrieve a specific key used to verify HTTP Message Signatures on Network ACL rules.
 
 </dd>
 </dl>
@@ -23350,11 +23791,7 @@ Create a new key used to verify HTTP Message Signatures on Network ACL rules.
 <dd>
 
 ```typescript
-await client.keys.networkAcls.create({
-    name: "name",
-    alg: "hmac-sha256",
-    value: "value",
-});
+await client.keys.networkAcls.get("id");
 ```
 
 </dd>
@@ -23370,7 +23807,7 @@ await client.keys.networkAcls.create({
 <dl>
 <dd>
 
-**request:** `Management.CreateKeysNetworkAclsRequestContent`
+**id:** `string` — ID of the Network ACL Key to retrieve.
 
 </dd>
 </dl>
@@ -23389,7 +23826,7 @@ await client.keys.networkAcls.create({
 </dl>
 </details>
 
-<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>
+<details><summary><code>client.keys.networkAcls.<a href="/src/management/api/resources/keys/resources/networkAcls/client/Client.ts">delete</a>(id) -> void</code></summary>
 <dl>
 <dd>
 
@@ -23401,7 +23838,7 @@ await client.keys.networkAcls.create({
 <dl>
 <dd>
 
-Retrieve a specific key used to verify HTTP Message Signatures on Network ACL rules.
+Delete a key used to verify HTTP Message Signatures on Network ACL rules
 
 </dd>
 </dl>
@@ -23417,7 +23854,7 @@ Retrieve a specific key used to verify HTTP Message Signatures on Network ACL ru
 <dd>
 
 ```typescript
-await client.keys.networkAcls.get("id");
+await client.keys.networkAcls.delete("id");
 ```
 
 </dd>
@@ -23433,7 +23870,7 @@ await client.keys.networkAcls.get("id");
 <dl>
 <dd>
 
-**id:** `string` — ID of the Network ACL Key to retrieve.
+**id:** `string` — ID of the Network ACL Key to delete.
 
 </dd>
 </dl>
@@ -25995,6 +26432,213 @@ await client.organizations.members.delete("id", {
 </dl>
 </details>
 
+## Organizations OrganizationTemplate
+
+<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>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+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.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.organizations.organizationTemplate.get("id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**id:** `string` — ID of the organization.
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `OrganizationTemplateClient.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<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>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Assign an Organization Template to an organization.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.organizations.organizationTemplate.assignOrganizationTemplate("id", "template_id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**id:** `string` — The ID of the organization.
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**template_id:** `string` — The ID of the organization template to assign.
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `OrganizationTemplateClient.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<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>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Remove an Organization Template assignment from an organization.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.organizations.organizationTemplate.unassignOrganizationTemplate("id", "template_id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**id:** `string` — The ID of the organization.
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**template_id:** `string` — The ID of the organization template to unassign.
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `OrganizationTemplateClient.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## Organizations Groups
 
 <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&lt;Management.Group, Management.ListOrganizationGroupsResponseContent&gt;</code></summary>
@@ -30442,6 +31086,22 @@ await client.users.multifactor.deleteProvider("id", "duo");
 
 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).
 
+This endpoint supports two types of pagination:
+
+- Offset pagination
+- Checkpoint pagination
+
+Checkpoint pagination must be used if you need to retrieve more than 1000 organizations.
+
+**Checkpoint Pagination**
+
+To search by checkpoint, use the following parameters:
+
+- `from`: Optional id from which to start selection.
+- `take`: The total number of entries to retrieve when using the `from` parameter. Defaults to 50.
+
+**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.
+
 </dd>
 </dl>
 </dd>