client.actions.list({ ...params }) -> core.Pageclient.branding.get() -> Management.GetBrandingResponseContentclient.clientGrants.list({ ...params }) -> core.Pageclient.clients.list({ ...params }) -> core.Pageclient_authentication_methods and token_endpoint_auth_method properties are mutually exclusive. Use
- client_authentication_methods to configure the client with Private Key JWT authentication method. Otherwise, use token_endpoint_auth_method
- to configure the client with client secret (basic or post) or with no authentication method (none).
-- When using client_authentication_methods to configure the client with Private Key JWT authentication method, specify fully defined credentials.
- These credentials will be automatically enabled for Private Key JWT authentication on the client.
+- The client_authentication_methods and token_endpoint_auth_method properties are mutually exclusive. Use
+client_authentication_methods to configure the client with Private Key JWT authentication method. Otherwise, use token_endpoint_auth_method
+to configure the client with client secret (basic or post) or with no authentication method (none).
+- When using client_authentication_methods to configure the client with Private Key JWT authentication method, specify fully defined credentials.
+These credentials will be automatically enabled for Private Key JWT authentication on the client.
- To configure client_authentication_methods, the create:client_credentials scope is required.
- To configure client_authentication_methods, the property jwt_configuration.alg must be set to RS256.
@@ -1087,10 +1079,10 @@ Notes:
```typescript
await client.clients.create({
- name: "name",
+ name: "name"
});
-```
+```
client_authentication_methods and token_endpoint_auth_method properties are mutually exclusive. Use client_authentication_methods to configure the client with Private Key JWT authentication method. Otherwise, use token_endpoint_auth_method to configure the client with client secret (basic or post) or with no authentication method (none).
- When using client_authentication_methods to configure the client with Private Key JWT authentication method, only specify the credential IDs that were generated when creating the credentials on the client.
- To configure client_authentication_methods, the update:client_credentials scope is required.
- To configure client_authentication_methods, the property jwt_configuration.alg must be set to RS256.
- To change a client's is_first_party property to false, the organization_usage and organization_require_behavior properties must be unset.
-
-
-
-
+
+
+
+
#### 🔌 Usage
@@ -1327,8 +1319,8 @@ Notes:
```typescript
await client.clients.update("id");
-```
+```
@@ -1343,28 +1335,29 @@ await client.clients.update("id");
client.connections.list({ ...params }) -> core.Pagefrom: Optional id from which to start selection.take: The total amount of entries to retrieve when using the from parameter. Defaults to 50.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.
-
body.body
@@ -1592,21 +1581,22 @@ await client.connections.create({
-
-**request:** `Management.CreateConnectionRequestContent`
-
+**request:** `Management.CreateConnectionRequestContent`
+
-
-**requestOptions:** `Connections.RequestOptions`
-
+**requestOptions:** `ConnectionsClient.RequestOptions`
+
+
@@ -1624,7 +1614,6 @@ await client.connections.create({
Retrieve details for a specified connection along with options that can be used for identity provider configuration.
-
@@ -1641,10 +1630,10 @@ Retrieve details for a specified
@@ -1659,28 +1648,29 @@ await client.connections.get("id", {
**id:** `string` — The id of the connection to retrieve
-
+
-
-**request:** `Management.GetConnectionRequestParameters`
-
+**request:** `Management.GetConnectionRequestParameters`
+
-
-**requestOptions:** `Connections.RequestOptions`
-
+**requestOptions:** `ConnectionsClient.RequestOptions`
+
+
@@ -1698,7 +1688,6 @@ await client.connections.get("id", {
Removes a specific connection from your tenant. This action cannot be undone. Once removed, users can no longer use this connection to authenticate.
-
@@ -1714,8 +1703,8 @@ Removes a specific
@@ -1730,20 +1719,21 @@ await client.connections.delete("id");
**id:** `string` — The id of the connection to delete
-
+
-
-**requestOptions:** `Connections.RequestOptions`
-
+**requestOptions:** `ConnectionsClient.RequestOptions`
+
+
@@ -1763,7 +1753,6 @@ await client.connections.delete("id");
Update details for a specific connection, including option properties for identity provider configuration.
Note: If you use the options parameter, the entire options object is overriden. To avoid partial data or other issues, ensure all parameters are present when using this option.
-
@@ -1779,8 +1768,8 @@ Update details for a specific
@@ -1795,28 +1784,29 @@ await client.connections.update("id");
**id:** `string` — The id of the connection to update
-
+
-
-**request:** `Management.UpdateConnectionRequestContent`
-
+**request:** `Management.UpdateConnectionRequestContent`
+
-
-**requestOptions:** `Connections.RequestOptions`
-
+**requestOptions:** `ConnectionsClient.RequestOptions`
+
+
@@ -1833,8 +1823,7 @@ await client.connections.update("id");
-
-Retrieves the status of an ad/ldap connection referenced by its
ID. 200 OK http status code response is returned when the connection is online, otherwise a 404 status code is returned along with an error message
-
+Retrieves the status of an ad/ldap connection referenced by its ID. 200 OK http status code response is returned when the connection is online, otherwise a 404 status code is returned along with an error message
@@ -1850,8 +1839,8 @@ Retrieves the status of an ad/ldap connection referenced by its ID.
```typescript
await client.connections.checkStatus("id");
-```
+```
@@ -1866,26 +1855,26 @@ await client.connections.checkStatus("id");
**id:** `string` — ID of the connection to check
-
+
-
-**requestOptions:** `Connections.RequestOptions`
-
+**requestOptions:** `ConnectionsClient.RequestOptions`
+
+
## CustomDomains
-
client.customDomains.list() -> Management.ListCustomDomainsResponseContent
-
@@ -1899,7 +1888,6 @@ await client.connections.checkStatus("id");
-
Retrieve details on custom domains.
-
@@ -1915,8 +1903,8 @@ Retrieve details on custom domai
```typescript
await client.customDomains.list();
-```
+```
@@ -1930,13 +1918,14 @@ await client.customDomains.list();
-
-**requestOptions:** `CustomDomains.RequestOptions`
-
+**requestOptions:** `CustomDomainsClient.RequestOptions`
+
+
@@ -1963,13 +1952,14 @@ Optional attributes that can be updated:
- custom_client_ip_header
- tls_policy
+
TLS Policies:
- recommended - for modern usage this includes TLS 1.2 only
-
-
-
-
+
+
+
+
#### 🔌 Usage
@@ -1982,10 +1972,10 @@ TLS Policies:
```typescript
await client.customDomains.create({
domain: "domain",
- type: "auth0_managed_certs",
+ type: "auth0_managed_certs"
});
-```
+```
@@ -1999,21 +1989,22 @@ await client.customDomains.create({
-
-**request:** `Management.CreateCustomDomainRequestContent`
-
+**request:** `Management.CreateCustomDomainRequestContent`
+
-
-**requestOptions:** `CustomDomains.RequestOptions`
-
+**requestOptions:** `CustomDomainsClient.RequestOptions`
+
+
@@ -2031,7 +2022,6 @@ await client.customDomains.create({
Retrieve a custom domain configuration and status.
-
@@ -2047,8 +2037,8 @@ Retrieve a custom domain configuration and status.
```typescript
await client.customDomains.get("id");
-```
+```
@@ -2063,20 +2053,21 @@ await client.customDomains.get("id");
**id:** `string` — ID of the custom domain to retrieve.
-
+
-
-**requestOptions:** `CustomDomains.RequestOptions`
-
+**requestOptions:** `CustomDomainsClient.RequestOptions`
+
+
@@ -2094,7 +2085,6 @@ await client.customDomains.get("id");
Delete a custom domain and stop serving requests for it.
-
@@ -2110,8 +2100,8 @@ Delete a custom domain and stop serving requests for it.
```typescript
await client.customDomains.delete("id");
-```
+```
@@ -2126,20 +2116,21 @@ await client.customDomains.delete("id");
**id:** `string` — ID of the custom domain to delete.
-
+
-
-**requestOptions:** `CustomDomains.RequestOptions`
-
+**requestOptions:** `CustomDomainsClient.RequestOptions`
+
+
@@ -2170,18 +2161,20 @@ send should be:
Updating TLS_POLICY for a custom domain
To update the tls_policy for a domain, the body to send should be:
{ "tls_policy": "recommended" }
+
TLS Policies:
- recommended - for modern usage this includes TLS 1.2 only
+
Some considerations:
- The TLS ciphers and protocols available in each TLS policy follow industry recommendations, and may be updated occasionally.
- The compatible TLS policy is no longer supported.
-
-
-
-
+
+
+
+
#### 🔌 Usage
@@ -2193,8 +2186,8 @@ Some considerations:
```typescript
await client.customDomains.update("id");
-```
+```
@@ -2209,28 +2202,29 @@ await client.customDomains.update("id");
**id:** `string` — The id of the custom domain to update
-
+
-
-**request:** `Management.UpdateCustomDomainRequestContent`
-
+**request:** `Management.UpdateCustomDomainRequestContent`
+
-
-**requestOptions:** `CustomDomains.RequestOptions`
-
+**requestOptions:** `CustomDomainsClient.RequestOptions`
+
+
@@ -2248,7 +2242,6 @@ await client.customDomains.update("id");
Run the test process on a custom domain.
-
@@ -2264,8 +2257,8 @@ Run the test process on a custom domain.
```typescript
await client.customDomains.test("id");
-```
+```
@@ -2280,20 +2273,21 @@ await client.customDomains.test("id");
**id:** `string` — ID of the custom domain to test.
-
+
-
-**requestOptions:** `CustomDomains.RequestOptions`
-
+**requestOptions:** `CustomDomainsClient.RequestOptions`
+
+
@@ -2318,7 +2312,6 @@ For self_managed_certs, when the custom domain is verified for the
Learn more about verifying custom domains that use Auth0 Managed certificates.
Learn more about verifying custom domains that use Self Managed certificates.
-
@@ -2334,8 +2327,8 @@ For self_managed_certs, when the custom domain is verified for the
```typescript
await client.customDomains.verify("id");
-```
+```
@@ -2350,26 +2343,26 @@ await client.customDomains.verify("id");
**id:** `string` — ID of the custom domain to verify.
-
+
-
-**requestOptions:** `CustomDomains.RequestOptions`
-
+**requestOptions:** `CustomDomainsClient.RequestOptions`
+
+
## DeviceCredentials
-
client.deviceCredentials.list({ ...params }) -> core.Page
-
@@ -2383,7 +2376,6 @@ await client.customDomains.verify("id");
-
Retrieve device credential information (
public_key, refresh_token, or rotating_refresh_token) associated with a specific user.
-
@@ -2406,7 +2398,7 @@ const pageableResponse = await client.deviceCredentials.list({
include_fields: true,
user_id: "user_id",
client_id: "client_id",
- type: "public_key",
+ type: "public_key"
});
for await (const item of pageableResponse) {
console.log(item);
@@ -2421,7 +2413,7 @@ let page = await client.deviceCredentials.list({
include_fields: true,
user_id: "user_id",
client_id: "client_id",
- type: "public_key",
+ type: "public_key"
});
while (page.hasNextPage()) {
page = page.getNextPage();
@@ -2429,8 +2421,8 @@ while (page.hasNextPage()) {
// You can also access the underlying response
const response = page.response;
-```
+```
@@ -2444,21 +2436,22 @@ const response = page.response;
-
-**request:** `Management.ListDeviceCredentialsRequestParameters`
-
+**request:** `Management.ListDeviceCredentialsRequestParameters`
+
-
-**requestOptions:** `DeviceCredentials.RequestOptions`
-
+**requestOptions:** `DeviceCredentialsClient.RequestOptions`
+
+
@@ -2478,7 +2471,6 @@ const response = page.response;
Create a device credential public key to manage refresh token rotation for a given user_id. Device Credentials APIs are designed for ad-hoc administrative use only and paging is by default enabled for GET requests.
When refresh token rotation is enabled, the endpoint becomes consistent. For more information, read Signing Keys.
-
@@ -2496,10 +2488,10 @@ When refresh token rotation is enabled, the endpoint becomes consistent. For mor
await client.deviceCredentials.createPublicKey({
device_name: "device_name",
value: "value",
- device_id: "device_id",
+ device_id: "device_id"
});
-```
+```
@@ -2513,21 +2505,22 @@ await client.deviceCredentials.createPublicKey({
-
-**request:** `Management.CreatePublicKeyDeviceCredentialRequestContent`
-
+**request:** `Management.CreatePublicKeyDeviceCredentialRequestContent`
+
-
-**requestOptions:** `DeviceCredentials.RequestOptions`
-
+**requestOptions:** `DeviceCredentialsClient.RequestOptions`
+
+
@@ -2545,7 +2538,6 @@ await client.deviceCredentials.createPublicKey({
Permanently delete a device credential (such as a refresh token or public key) with the given ID.
-
@@ -2561,8 +2553,8 @@ Permanently delete a device credential (such as a refresh token or public key) w
```typescript
await client.deviceCredentials.delete("id");
-```
+```
@@ -2577,26 +2569,26 @@ await client.deviceCredentials.delete("id");
**id:** `string` — ID of the credential to delete.
-
+
-
-**requestOptions:** `DeviceCredentials.RequestOptions`
-
+**requestOptions:** `DeviceCredentialsClient.RequestOptions`
+
+
## EmailTemplates
-
client.emailTemplates.create({ ...params }) -> Management.CreateEmailTemplateResponseContent
-
@@ -2610,7 +2602,6 @@ await client.deviceCredentials.delete("id");
-
Create an email template.
-
@@ -2626,10 +2617,10 @@ Create an email template.
```typescript
await client.emailTemplates.create({
- template: "verify_email",
+ template: "verify_email"
});
-```
+```
@@ -2643,21 +2634,22 @@ await client.emailTemplates.create({
-
-**request:** `Management.CreateEmailTemplateRequestContent`
-
+**request:** `Management.CreateEmailTemplateRequestContent`
+
-
-**requestOptions:** `EmailTemplates.RequestOptions`
-
+**requestOptions:** `EmailTemplatesClient.RequestOptions`
+
+
@@ -2675,7 +2667,6 @@ await client.emailTemplates.create({
Retrieve an email template by pre-defined name. These names are `verify_email`, `verify_email_by_code`, `reset_email`, `reset_email_by_code`, `welcome_email`, `blocked_account`, `stolen_credentials`, `enrollment_email`, `mfa_oob_code`, `user_invitation`, and `async_approval`. The names `change_password`, and `password_reset` are also supported for legacy scenarios.
-
@@ -2691,8 +2682,8 @@ Retrieve an email template by pre-defined name. These names are `verify_email`,
```typescript
await client.emailTemplates.get("verify_email");
-```
+```
@@ -2707,20 +2698,21 @@ await client.emailTemplates.get("verify_email");
**templateName:** `Management.EmailTemplateNameEnum` — Template name. Can be `verify_email`, `verify_email_by_code`, `reset_email`, `reset_email_by_code`, `welcome_email`, `blocked_account`, `stolen_credentials`, `enrollment_email`, `mfa_oob_code`, `user_invitation`, `async_approval`, `change_password` (legacy), or `password_reset` (legacy).
-
+
-
-**requestOptions:** `EmailTemplates.RequestOptions`
-
+**requestOptions:** `EmailTemplatesClient.RequestOptions`
+
+
@@ -2738,7 +2730,6 @@ await client.emailTemplates.get("verify_email");
Update an email template.
-
@@ -2754,10 +2745,10 @@ Update an email template.
```typescript
await client.emailTemplates.set("verify_email", {
- template: "verify_email",
+ template: "verify_email"
});
-```
+```
@@ -2772,28 +2763,29 @@ await client.emailTemplates.set("verify_email", {
**templateName:** `Management.EmailTemplateNameEnum` — Template name. Can be `verify_email`, `verify_email_by_code`, `reset_email`, `reset_email_by_code`, `welcome_email`, `blocked_account`, `stolen_credentials`, `enrollment_email`, `mfa_oob_code`, `user_invitation`, `async_approval`, `change_password` (legacy), or `password_reset` (legacy).
-
+
-
-**request:** `Management.SetEmailTemplateRequestContent`
-
+**request:** `Management.SetEmailTemplateRequestContent`
+
-
-**requestOptions:** `EmailTemplates.RequestOptions`
-
+**requestOptions:** `EmailTemplatesClient.RequestOptions`
+
+
@@ -2811,7 +2803,6 @@ await client.emailTemplates.set("verify_email", {
Modify an email template.
-
@@ -2827,8 +2818,8 @@ Modify an email template.
```typescript
await client.emailTemplates.update("verify_email");
-```
+```
@@ -2843,34 +2834,34 @@ await client.emailTemplates.update("verify_email");
**templateName:** `Management.EmailTemplateNameEnum` — Template name. Can be `verify_email`, `verify_email_by_code`, `reset_email`, `reset_email_by_code`, `welcome_email`, `blocked_account`, `stolen_credentials`, `enrollment_email`, `mfa_oob_code`, `user_invitation`, `async_approval`, `change_password` (legacy), or `password_reset` (legacy).
-
+
-
-**request:** `Management.UpdateEmailTemplateRequestContent`
-
+**request:** `Management.UpdateEmailTemplateRequestContent`
+
-
-**requestOptions:** `EmailTemplates.RequestOptions`
-
+**requestOptions:** `EmailTemplatesClient.RequestOptions`
+
+
## EventStreams
-
client.eventStreams.list({ ...params }) -> Management.EventStreamResponseContent[]
-
@@ -2886,10 +2877,10 @@ await client.emailTemplates.update("verify_email");
```typescript
await client.eventStreams.list({
from: "from",
- take: 1,
+ take: 1
});
-```
+```
@@ -2903,21 +2894,22 @@ await client.eventStreams.list({
-
-**request:** `Management.ListEventStreamsRequestParameters`
-
+**request:** `Management.ListEventStreamsRequestParameters`
+
-
-**requestOptions:** `EventStreams.RequestOptions`
-
+**requestOptions:** `EventStreamsClient.RequestOptions`
+
+
@@ -2942,13 +2934,13 @@ await client.eventStreams.create({
webhook_endpoint: "webhook_endpoint",
webhook_authorization: {
method: "basic",
- username: "username",
- },
- },
- },
+ username: "username"
+ }
+ }
+ }
});
-```
+```
@@ -2962,21 +2954,22 @@ await client.eventStreams.create({
-
-**request:** `Management.EventStreamsCreateRequest`
-
+**request:** `Management.EventStreamsCreateRequest`
+
-
-**requestOptions:** `EventStreams.RequestOptions`
-
+**requestOptions:** `EventStreamsClient.RequestOptions`
+
+
@@ -2995,8 +2988,8 @@ await client.eventStreams.create({
```typescript
await client.eventStreams.get("id");
-```
+```
@@ -3011,20 +3004,21 @@ await client.eventStreams.get("id");
**id:** `string` — Unique identifier for the event stream.
-
+
-
-**requestOptions:** `EventStreams.RequestOptions`
-
+**requestOptions:** `EventStreamsClient.RequestOptions`
+
+
@@ -3043,8 +3037,8 @@ await client.eventStreams.get("id");
```typescript
await client.eventStreams.delete("id");
-```
+```
@@ -3059,20 +3053,21 @@ await client.eventStreams.delete("id");
**id:** `string` — Unique identifier for the event stream.
-
+
-
-**requestOptions:** `EventStreams.RequestOptions`
-
+**requestOptions:** `EventStreamsClient.RequestOptions`
+
+
@@ -3091,8 +3086,8 @@ await client.eventStreams.delete("id");
```typescript
await client.eventStreams.update("id");
-```
+```
@@ -3107,28 +3102,89 @@ await client.eventStreams.update("id");
**id:** `string` — Unique identifier for the event stream.
+
+
+
+
+
+-
+
+**request:** `Management.UpdateEventStreamRequestContent`
+
+
+
+
+
+-
+
+**requestOptions:** `EventStreamsClient.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+client.eventStreams.getStats(id, { ...params }) -> Management.GetEventStreamStatsResponseContent
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```typescript
+await client.eventStreams.getStats("id", {
+ date_from: "date_from",
+ date_to: "date_to"
+});
+
+```
+
+
+#### ⚙️ Parameters
+
-
-**request:** `Management.UpdateEventStreamRequestContent`
+
+-
+**id:** `string` — Unique identifier for the event stream.
+
-
-**requestOptions:** `EventStreams.RequestOptions`
+**request:** `Management.EventStreamsGetStatsRequest`
+
+
+
+
+
+-
+**requestOptions:** `EventStreamsClient.RequestOptions`
+
+
@@ -3147,10 +3203,10 @@ await client.eventStreams.update("id");
```typescript
await client.eventStreams.test("id", {
- event_type: "user.created",
+ event_type: "user.created"
});
-```
+```
@@ -3165,34 +3221,34 @@ await client.eventStreams.test("id", {
**id:** `string` — Unique identifier for the event stream.
-
+
-
-**request:** `Management.CreateEventStreamTestEventRequestContent`
-
+**request:** `Management.CreateEventStreamTestEventRequestContent`
+
-
-**requestOptions:** `EventStreams.RequestOptions`
-
+**requestOptions:** `EventStreamsClient.RequestOptions`
+
+
## Flows
-
client.flows.list({ ...params }) -> core.Page
-
@@ -3210,7 +3266,7 @@ const pageableResponse = await client.flows.list({
page: 1,
per_page: 1,
include_totals: true,
- synchronous: true,
+ synchronous: true
});
for await (const item of pageableResponse) {
console.log(item);
@@ -3221,7 +3277,7 @@ let page = await client.flows.list({
page: 1,
per_page: 1,
include_totals: true,
- synchronous: true,
+ synchronous: true
});
while (page.hasNextPage()) {
page = page.getNextPage();
@@ -3229,8 +3285,8 @@ while (page.hasNextPage()) {
// You can also access the underlying response
const response = page.response;
-```
+```
@@ -3244,21 +3300,22 @@ const response = page.response;
-
-**request:** `Management.FlowsListRequest`
-
+**request:** `Management.FlowsListRequest`
+
-
-**requestOptions:** `Flows.RequestOptions`
-
+**requestOptions:** `FlowsClient.RequestOptions`
+
+
@@ -3277,10 +3334,10 @@ const response = page.response;
```typescript
await client.flows.create({
- name: "name",
+ name: "name"
});
-```
+```
@@ -3294,21 +3351,22 @@ await client.flows.create({
-
-**request:** `Management.CreateFlowRequestContent`
-
+**request:** `Management.CreateFlowRequestContent`
+
-
-**requestOptions:** `Flows.RequestOptions`
-
+**requestOptions:** `FlowsClient.RequestOptions`
+
+
@@ -3327,8 +3385,8 @@ await client.flows.create({
```typescript
await client.flows.get("id");
-```
+```
@@ -3343,28 +3401,29 @@ await client.flows.get("id");
**id:** `string` — Flow identifier
-
+
-
-**request:** `Management.GetFlowRequestParameters`
-
+**request:** `Management.GetFlowRequestParameters`
+
-
-**requestOptions:** `Flows.RequestOptions`
-
+**requestOptions:** `FlowsClient.RequestOptions`
+
+
@@ -3383,8 +3442,8 @@ await client.flows.get("id");
```typescript
await client.flows.delete("id");
-```
+```
@@ -3399,20 +3458,21 @@ await client.flows.delete("id");
**id:** `string` — Flow id
-
+
-
-**requestOptions:** `Flows.RequestOptions`
-
+**requestOptions:** `FlowsClient.RequestOptions`
+
+
@@ -3431,8 +3491,8 @@ await client.flows.delete("id");
```typescript
await client.flows.update("id");
-```
+```
@@ -3447,34 +3507,34 @@ await client.flows.update("id");
**id:** `string` — Flow identifier
-
+
-
-**request:** `Management.UpdateFlowRequestContent`
-
+**request:** `Management.UpdateFlowRequestContent`
+
-
-**requestOptions:** `Flows.RequestOptions`
-
+**requestOptions:** `FlowsClient.RequestOptions`
+
+
## Forms
-
client.forms.list({ ...params }) -> core.Page
-
@@ -3491,7 +3551,7 @@ await client.flows.update("id");
const pageableResponse = await client.forms.list({
page: 1,
per_page: 1,
- include_totals: true,
+ include_totals: true
});
for await (const item of pageableResponse) {
console.log(item);
@@ -3501,7 +3561,7 @@ for await (const item of pageableResponse) {
let page = await client.forms.list({
page: 1,
per_page: 1,
- include_totals: true,
+ include_totals: true
});
while (page.hasNextPage()) {
page = page.getNextPage();
@@ -3509,8 +3569,8 @@ while (page.hasNextPage()) {
// You can also access the underlying response
const response = page.response;
-```
+```
@@ -3524,21 +3584,22 @@ const response = page.response;
-
-**request:** `Management.ListFormsRequestParameters`
-
+**request:** `Management.ListFormsRequestParameters`
+
-
-**requestOptions:** `Forms.RequestOptions`
-
+**requestOptions:** `FormsClient.RequestOptions`
+
+
@@ -3557,10 +3618,10 @@ const response = page.response;
```typescript
await client.forms.create({
- name: "name",
+ name: "name"
});
-```
+```
@@ -3574,21 +3635,22 @@ await client.forms.create({
-
-**request:** `Management.CreateFormRequestContent`
-
+**request:** `Management.CreateFormRequestContent`
+
-
-**requestOptions:** `Forms.RequestOptions`
-
+**requestOptions:** `FormsClient.RequestOptions`
+
+
@@ -3607,8 +3669,8 @@ await client.forms.create({
```typescript
await client.forms.get("id");
-```
+```
@@ -3623,28 +3685,29 @@ await client.forms.get("id");
**id:** `string` — The ID of the form to retrieve.
-
+
-
-**request:** `Management.GetFormRequestParameters`
-
+**request:** `Management.GetFormRequestParameters`
+
-
-**requestOptions:** `Forms.RequestOptions`
-
+**requestOptions:** `FormsClient.RequestOptions`
+
+
@@ -3663,8 +3726,8 @@ await client.forms.get("id");
```typescript
await client.forms.delete("id");
-```
+```
@@ -3679,20 +3742,21 @@ await client.forms.delete("id");
**id:** `string` — The ID of the form to delete.
-
+
-
-**requestOptions:** `Forms.RequestOptions`
-
+**requestOptions:** `FormsClient.RequestOptions`
+
+
@@ -3711,8 +3775,8 @@ await client.forms.delete("id");
```typescript
await client.forms.update("id");
-```
+```
@@ -3727,34 +3791,34 @@ await client.forms.update("id");
**id:** `string` — The ID of the form to update.
-
+
-
-**request:** `Management.UpdateFormRequestContent`
-
+**request:** `Management.UpdateFormRequestContent`
+
-
-**requestOptions:** `Forms.RequestOptions`
-
+**requestOptions:** `FormsClient.RequestOptions`
+
+
## UserGrants
-
client.userGrants.list({ ...params }) -> core.Page
-
@@ -3767,8 +3831,7 @@ await client.forms.update("id");
@@ -3789,7 +3852,7 @@ const pageableResponse = await client.userGrants.list({
include_totals: true,
user_id: "user_id",
client_id: "client_id",
- audience: "audience",
+ audience: "audience"
});
for await (const item of pageableResponse) {
console.log(item);
@@ -3802,7 +3865,7 @@ let page = await client.userGrants.list({
include_totals: true,
user_id: "user_id",
client_id: "client_id",
- audience: "audience",
+ audience: "audience"
});
while (page.hasNextPage()) {
page = page.getNextPage();
@@ -3810,8 +3873,8 @@ while (page.hasNextPage()) {
// You can also access the underlying response
const response = page.response;
-```
+```
@@ -3825,21 +3888,22 @@ const response = page.response;
-
-**request:** `Management.ListUserGrantsRequestParameters`
-
+**request:** `Management.ListUserGrantsRequestParameters`
+
-
-**requestOptions:** `UserGrants.RequestOptions`
-
+**requestOptions:** `UserGrantsClient.RequestOptions`
+
+
@@ -3856,8 +3920,7 @@ const response = page.response;
-
-Delete a grant associated with your account.
-
+Delete a grant associated with your account.
@@ -3873,10 +3936,10 @@ Delete a grant associated with your account.
```typescript
await client.userGrants.deleteByUserId({
- user_id: "user_id",
+ user_id: "user_id"
});
-```
+```
@@ -3890,21 +3953,22 @@ await client.userGrants.deleteByUserId({
-
-**request:** `Management.DeleteUserGrantByUserIdRequestParameters`
-
+**request:** `Management.DeleteUserGrantByUserIdRequestParameters`
+
-
-**requestOptions:** `UserGrants.RequestOptions`
-
+**requestOptions:** `UserGrantsClient.RequestOptions`
+
+
@@ -3921,8 +3985,7 @@ await client.userGrants.deleteByUserId({
-
-Delete a grant associated with your account.
-
+Delete a grant associated with your account.
@@ -3938,8 +4001,8 @@ Delete a grant associated with your account.
```typescript
await client.userGrants.delete("id");
-```
+```
@@ -3954,26 +4017,26 @@ await client.userGrants.delete("id");
**id:** `string` — ID of the grant to delete.
-
+
-
-**requestOptions:** `UserGrants.RequestOptions`
-
+**requestOptions:** `UserGrantsClient.RequestOptions`
+
+
## Hooks
-
client.hooks.list({ ...params }) -> core.Page
-
@@ -3987,7 +4050,6 @@ await client.userGrants.delete("id");
-
Retrieve all hooks. Accepts a list of fields to include or exclude in the result.
-
@@ -4008,7 +4070,7 @@ const pageableResponse = await client.hooks.list({
include_totals: true,
enabled: true,
fields: "fields",
- triggerId: "credentials-exchange",
+ triggerId: "credentials-exchange"
});
for await (const item of pageableResponse) {
console.log(item);
@@ -4021,7 +4083,7 @@ let page = await client.hooks.list({
include_totals: true,
enabled: true,
fields: "fields",
- triggerId: "credentials-exchange",
+ triggerId: "credentials-exchange"
});
while (page.hasNextPage()) {
page = page.getNextPage();
@@ -4029,8 +4091,8 @@ while (page.hasNextPage()) {
// You can also access the underlying response
const response = page.response;
-```
+```
@@ -4044,21 +4106,22 @@ const response = page.response;
-
-**request:** `Management.ListHooksRequestParameters`
-
+**request:** `Management.ListHooksRequestParameters`
+
-
-**requestOptions:** `Hooks.RequestOptions`
-
+**requestOptions:** `HooksClient.RequestOptions`
+
+
@@ -4076,7 +4139,6 @@ const response = page.response;
Create a new hook.
-
@@ -4094,10 +4156,10 @@ Create a new hook.
await client.hooks.create({
name: "name",
script: "script",
- triggerId: "credentials-exchange",
+ triggerId: "credentials-exchange"
});
-```
+```
@@ -4111,21 +4173,22 @@ await client.hooks.create({
-
-**request:** `Management.CreateHookRequestContent`
-
+**request:** `Management.CreateHookRequestContent`
+
-
-**requestOptions:** `Hooks.RequestOptions`
-
+**requestOptions:** `HooksClient.RequestOptions`
+
+
@@ -4143,7 +4206,6 @@ await client.hooks.create({
Retrieve a hook by its ID. Accepts a list of fields to include in the result.
-
@@ -4159,10 +4221,10 @@ Retrieve a hook by its ID. Accepts a
```typescript
await client.hooks.get("id", {
- fields: "fields",
+ fields: "fields"
});
-```
+```
@@ -4177,28 +4239,29 @@ await client.hooks.get("id", {
**id:** `string` — ID of the hook to retrieve.
-
+
-
-**request:** `Management.GetHookRequestParameters`
-
+**request:** `Management.GetHookRequestParameters`
+
-
-**requestOptions:** `Hooks.RequestOptions`
-
+**requestOptions:** `HooksClient.RequestOptions`
+
+
@@ -4216,7 +4279,6 @@ await client.hooks.get("id", {
Delete a hook.
-
@@ -4232,8 +4294,8 @@ Delete a hook.
```typescript
await client.hooks.delete("id");
-```
+```
@@ -4248,20 +4310,21 @@ await client.hooks.delete("id");
**id:** `string` — ID of the hook to delete.
-
+
-
-**requestOptions:** `Hooks.RequestOptions`
-
+**requestOptions:** `HooksClient.RequestOptions`
+
+
@@ -4279,7 +4342,6 @@ await client.hooks.delete("id");
Update an existing hook.
-
@@ -4295,8 +4357,8 @@ Update an existing hook.
```typescript
await client.hooks.update("id");
-```
+```
@@ -4311,34 +4373,34 @@ await client.hooks.update("id");
**id:** `string` — ID of the hook to update.
-
+
-
-**request:** `Management.UpdateHookRequestContent`
-
+**request:** `Management.UpdateHookRequestContent`
+
-
-**requestOptions:** `Hooks.RequestOptions`
-
+**requestOptions:** `HooksClient.RequestOptions`
+
+
## Jobs
-
client.jobs.get(id) -> Management.GetJobResponseContent
-
@@ -4352,7 +4414,6 @@ await client.hooks.update("id");
-
Retrieves a job. Useful to check its status.
-
@@ -4368,8 +4429,8 @@ Retrieves a job. Useful to check its status.
```typescript
await client.jobs.get("id");
-```
+```
@@ -4384,26 +4445,26 @@ await client.jobs.get("id");
**id:** `string` — ID of the job.
-
+
-
-**requestOptions:** `Jobs.RequestOptions`
-
+**requestOptions:** `JobsClient.RequestOptions`
+
+
## LogStreams
-
client.logStreams.list() -> Management.LogStreamResponseSchema[]
-
@@ -4417,7 +4478,6 @@ await client.jobs.get("id");
-
Retrieve details on log streams.
-
Sample Response
[{
"id": "string",
"name": "string",
@@ -4498,8 +4558,8 @@ Retrieve details on log streams
@@ -4513,13 +4573,14 @@ await client.logStreams.list();
-
-**requestOptions:** `LogStreams.RequestOptions`
-
+**requestOptions:** `LogStreamsClient.RequestOptions`
+
+
@@ -4537,7 +4598,6 @@ await client.logStreams.list();
Create a log stream.
-
Log Stream Types
The type of log stream being created determines the properties required in the sink payload.
HTTP Stream
For an http Stream, the sink properties are listed in the payload below
Request: {
@@ -4680,11 +4740,11 @@ Response: {
await client.logStreams.create({
type: "http",
sink: {
- httpEndpoint: "httpEndpoint",
- },
+ httpEndpoint: "httpEndpoint"
+ }
});
-```
+```
@@ -4698,21 +4758,22 @@ await client.logStreams.create({
-
-**request:** `Management.CreateLogStreamRequestContent`
-
+**request:** `Management.CreateLogStreamRequestContent`
+
-
-**requestOptions:** `LogStreams.RequestOptions`
-
+**requestOptions:** `LogStreamsClient.RequestOptions`
+
+
@@ -4730,7 +4791,6 @@ await client.logStreams.create({
Retrieve a log stream configuration and status.
-
Sample responses
Amazon EventBridge Log Stream
{
"id": "string",
"name": "string",
@@ -4763,49 +4823,52 @@ Retrieve a log stream configuration and status.
}
}
Mixpanel
-Request: {
-"name": "string",
-"type": "mixpanel",
-"sink": {
-"mixpanelRegion": "string", // "us" | "eu",
-"mixpanelProjectId": "string",
-"mixpanelServiceAccountUsername": "string",
-"mixpanelServiceAccountPassword": "string"
-}
-}
-Response: {
-"id": "string",
-"name": "string",
-"type": "mixpanel",
-"status": "active",
-"sink": {
-"mixpanelRegion": "string", // "us" | "eu",
-"mixpanelProjectId": "string",
-"mixpanelServiceAccountUsername": "string",
-"mixpanelServiceAccountPassword": "string" // the following is redacted on return
-}
-}
-
- Segment
-
- Request: {
- "name": "string",
- "type": "segment",
- "sink": {
- "segmentWriteKey": "string"
- }
- }
-
- Response: {
- "id": "string",
- "name": "string",
- "type": "segment",
- "status": "active",
- "sink": {
- "segmentWriteKey": "string"
- }
- }
-
+
+ Request: {
+ "name": "string",
+ "type": "mixpanel",
+ "sink": {
+ "mixpanelRegion": "string", // "us" | "eu",
+ "mixpanelProjectId": "string",
+ "mixpanelServiceAccountUsername": "string",
+ "mixpanelServiceAccountPassword": "string"
+ }
+ }
+
+
+ Response: {
+ "id": "string",
+ "name": "string",
+ "type": "mixpanel",
+ "status": "active",
+ "sink": {
+ "mixpanelRegion": "string", // "us" | "eu",
+ "mixpanelProjectId": "string",
+ "mixpanelServiceAccountUsername": "string",
+ "mixpanelServiceAccountPassword": "string" // the following is redacted on return
+ }
+ }
+
+ Segment
+
+ Request: {
+ "name": "string",
+ "type": "segment",
+ "sink": {
+ "segmentWriteKey": "string"
+ }
+ }
+
+ Response: {
+ "id": "string",
+ "name": "string",
+ "type": "segment",
+ "status": "active",
+ "sink": {
+ "segmentWriteKey": "string"
+ }
+ }
+
Splunk Log Stream
{
"id": "string",
"name": "string",
@@ -4844,8 +4907,8 @@ Response: {
```typescript
await client.logStreams.get("id");
-```
+```
@@ -4860,20 +4923,21 @@ await client.logStreams.get("id");
**id:** `string` — The id of the log stream to get
-
+
-
-**requestOptions:** `LogStreams.RequestOptions`
-
+**requestOptions:** `LogStreamsClient.RequestOptions`
+
+
@@ -4891,7 +4955,6 @@ await client.logStreams.get("id");
Delete a log stream.
-
@@ -4907,8 +4970,8 @@ Delete a log stream.
```typescript
await client.logStreams.delete("id");
-```
+```
@@ -4923,20 +4986,21 @@ await client.logStreams.delete("id");
**id:** `string` — The id of the log stream to delete
-
+
-
-**requestOptions:** `LogStreams.RequestOptions`
-
+**requestOptions:** `LogStreamsClient.RequestOptions`
+
+
@@ -4954,7 +5018,6 @@ await client.logStreams.delete("id");
Update a log stream.
-
Examples of how to use the PATCH endpoint.
The following fields may be updated in a PATCH operation: - name
- status
- sink
Note: For log streams of type eventbridge and eventgrid, updating the sink is not permitted.
Update the status of a log stream
{
"status": "active|paused"
@@ -5004,8 +5067,8 @@ Update a log stream.
```typescript
await client.logStreams.update("id");
-```
+```
@@ -5020,34 +5083,34 @@ await client.logStreams.update("id");
**id:** `string` — The id of the log stream to get
-
+
-
-**request:** `Management.UpdateLogStreamRequestContent`
-
+**request:** `Management.UpdateLogStreamRequestContent`
+
-
-**requestOptions:** `LogStreams.RequestOptions`
-
+**requestOptions:** `LogStreamsClient.RequestOptions`
+
+
## Logs
-
client.logs.list({ ...params }) -> core.Page
@@ -5148,21 +5210,22 @@ const response = page.response;
-
-**request:** `Management.ListLogsRequestParameters`
-
+**request:** `Management.ListLogsRequestParameters`
+
-
-**requestOptions:** `Logs.RequestOptions`
-
+**requestOptions:** `LogsClient.RequestOptions`
+
+
@@ -5180,7 +5243,6 @@ const response = page.response;
Retrieve an individual log event.
-
@@ -5196,8 +5258,8 @@ Retrieve an individual log event.
```typescript
await client.logs.get("id");
-```
+```
@@ -5212,26 +5274,26 @@ await client.logs.get("id");
**id:** `string` — log_id of the log to retrieve.
-
+
-
-**requestOptions:** `Logs.RequestOptions`
-
+**requestOptions:** `LogsClient.RequestOptions`
+
+
## NetworkAcls
-
client.networkAcls.list({ ...params }) -> core.Page
-
@@ -5245,7 +5307,6 @@ await client.logs.get("id");
-
Get all access control list entries for your client.
-
@@ -5263,7 +5324,7 @@ Get all access control list entries for your client.
const pageableResponse = await client.networkAcls.list({
page: 1,
per_page: 1,
- include_totals: true,
+ include_totals: true
});
for await (const item of pageableResponse) {
console.log(item);
@@ -5273,7 +5334,7 @@ for await (const item of pageableResponse) {
let page = await client.networkAcls.list({
page: 1,
per_page: 1,
- include_totals: true,
+ include_totals: true
});
while (page.hasNextPage()) {
page = page.getNextPage();
@@ -5281,8 +5342,8 @@ while (page.hasNextPage()) {
// You can also access the underlying response
const response = page.response;
-```
+```
@@ -5296,21 +5357,22 @@ const response = page.response;
-
-**request:** `Management.ListNetworkAclsRequestParameters`
-
+**request:** `Management.ListNetworkAclsRequestParameters`
+
-
-**requestOptions:** `NetworkAcls.RequestOptions`
-
+**requestOptions:** `NetworkAclsClient.RequestOptions`
+
+
@@ -5328,7 +5390,6 @@ const response = page.response;
Create a new access control list for your client.
-
@@ -5349,11 +5410,11 @@ await client.networkAcls.create({
priority: 1.1,
rule: {
action: {},
- scope: "management",
- },
+ scope: "management"
+ }
});
-```
+```
@@ -5367,21 +5428,22 @@ await client.networkAcls.create({
-
-**request:** `Management.CreateNetworkAclRequestContent`
-
+**request:** `Management.CreateNetworkAclRequestContent`
+
-
-**requestOptions:** `NetworkAcls.RequestOptions`
-
+**requestOptions:** `NetworkAclsClient.RequestOptions`
+
+
@@ -5399,7 +5461,6 @@ await client.networkAcls.create({
Get a specific access control list entry for your client.
-
@@ -5415,8 +5476,8 @@ Get a specific access control list entry for your client.
```typescript
await client.networkAcls.get("id");
-```
+```
@@ -5431,20 +5492,21 @@ await client.networkAcls.get("id");
**id:** `string` — The id of the access control list to retrieve.
-
+
-
-**requestOptions:** `NetworkAcls.RequestOptions`
-
+**requestOptions:** `NetworkAclsClient.RequestOptions`
+
+
@@ -5462,7 +5524,6 @@ await client.networkAcls.get("id");
Update existing access control list for your client.
-
@@ -5483,11 +5544,11 @@ await client.networkAcls.set("id", {
priority: 1.1,
rule: {
action: {},
- scope: "management",
- },
+ scope: "management"
+ }
});
-```
+```
@@ -5502,28 +5563,29 @@ await client.networkAcls.set("id", {
**id:** `string` — The id of the ACL to update.
-
+
-
-**request:** `Management.SetNetworkAclRequestContent`
-
+**request:** `Management.SetNetworkAclRequestContent`
+
-
-**requestOptions:** `NetworkAcls.RequestOptions`
-
+**requestOptions:** `NetworkAclsClient.RequestOptions`
+
+
@@ -5541,7 +5603,6 @@ await client.networkAcls.set("id", {
Delete existing access control list for your client.
-
@@ -5557,8 +5618,8 @@ Delete existing access control list for your client.
```typescript
await client.networkAcls.delete("id");
-```
+```
@@ -5573,20 +5634,21 @@ await client.networkAcls.delete("id");
**id:** `string` — The id of the ACL to delete
-
+
-
-**requestOptions:** `NetworkAcls.RequestOptions`
-
+**requestOptions:** `NetworkAclsClient.RequestOptions`
+
+
@@ -5604,7 +5666,6 @@ await client.networkAcls.delete("id");
Update existing access control list for your client.
-
@@ -5620,8 +5681,8 @@ Update existing access control list for your client.
```typescript
await client.networkAcls.update("id");
-```
+```
@@ -5636,34 +5697,34 @@ await client.networkAcls.update("id");
**id:** `string` — The id of the ACL to update.
-
+
-
-**request:** `Management.UpdateNetworkAclRequestContent`
-
+**request:** `Management.UpdateNetworkAclRequestContent`
+
-
-**requestOptions:** `NetworkAcls.RequestOptions`
-
+**requestOptions:** `NetworkAclsClient.RequestOptions`
+
+
## Organizations
-
client.organizations.list({ ...params }) -> core.Page
-
@@ -5679,7 +5740,6 @@ await client.networkAcls.update("id");
Retrieve detailed list of all Organizations available in your tenant. For more information, see Auth0 Organizations.
This endpoint supports two types of pagination:
-
- Offset pagination
- Checkpoint pagination
@@ -5690,14 +5750,12 @@ Checkpoint pagination must be used if you need to retrieve more than 1000 organi
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.
-
@@ -5715,7 +5773,7 @@ To search by checkpoint, use the following parameters:
const pageableResponse = await client.organizations.list({
from: "from",
take: 1,
- sort: "sort",
+ sort: "sort"
});
for await (const item of pageableResponse) {
console.log(item);
@@ -5725,7 +5783,7 @@ for await (const item of pageableResponse) {
let page = await client.organizations.list({
from: "from",
take: 1,
- sort: "sort",
+ sort: "sort"
});
while (page.hasNextPage()) {
page = page.getNextPage();
@@ -5733,8 +5791,8 @@ while (page.hasNextPage()) {
// You can also access the underlying response
const response = page.response;
-```
+```
@@ -5748,21 +5806,22 @@ const response = page.response;
-
-**request:** `Management.ListOrganizationsRequestParameters`
-
+**request:** `Management.ListOrganizationsRequestParameters`
+
-
-**requestOptions:** `Organizations.RequestOptions`
-
+**requestOptions:** `OrganizationsClient.RequestOptions`
+
+
@@ -5779,8 +5838,7 @@ const response = page.response;
-
-Create a new Organization within your tenant. To learn more about Organization settings, behavior, and configuration options, review Create Your First Organization.
-
+Create a new Organization within your tenant. To learn more about Organization settings, behavior, and configuration options, review Create Your First Organization.
@@ -5796,10 +5854,10 @@ Create a new Organization within your tenant. To learn more about Organization s
```typescript
await client.organizations.create({
- name: "name",
+ name: "name"
});
-```
+```
@@ -5813,21 +5871,22 @@ await client.organizations.create({
-
-**request:** `Management.CreateOrganizationRequestContent`
-
+**request:** `Management.CreateOrganizationRequestContent`
+
-
-**requestOptions:** `Organizations.RequestOptions`
-
+**requestOptions:** `OrganizationsClient.RequestOptions`
+
+
@@ -5845,7 +5904,6 @@ await client.organizations.create({
Retrieve details about a single Organization specified by name.
-
@@ -5861,8 +5919,8 @@ Retrieve details about a single Organization specified by name.
```typescript
await client.organizations.getByName("name");
-```
+```
@@ -5877,20 +5935,21 @@ await client.organizations.getByName("name");
**name:** `string` — name of the organization to retrieve.
-
+
-
-**requestOptions:** `Organizations.RequestOptions`
-
+**requestOptions:** `OrganizationsClient.RequestOptions`
+
+
@@ -5907,8 +5966,7 @@ await client.organizations.getByName("name");
-
-Retrieve details about a single Organization specified by ID.
-
+Retrieve details about a single Organization specified by ID.
@@ -5924,8 +5982,8 @@ Retrieve details about a single Organization specified by ID.
```typescript
await client.organizations.get("id");
-```
+```
@@ -5940,20 +5998,21 @@ await client.organizations.get("id");
**id:** `string` — ID of the organization to retrieve.
-
+
-
-**requestOptions:** `Organizations.RequestOptions`
-
+**requestOptions:** `OrganizationsClient.RequestOptions`
+
+
@@ -5970,10 +6029,9 @@ await client.organizations.get("id");
-
-Remove an Organization from your tenant. This action cannot be undone.
+Remove an Organization from your tenant. This action cannot be undone.
Note: Members are automatically disassociated from an Organization when it is deleted. However, this action does not delete these users from your tenant.
-
@@ -5989,8 +6047,8 @@ Remove an Organization from your tenant. This action cannot be undone.
```typescript
await client.organizations.delete("id");
-```
+```
@@ -6005,20 +6063,21 @@ await client.organizations.delete("id");
**id:** `string` — Organization identifier.
-
+
-
-**requestOptions:** `Organizations.RequestOptions`
-
+**requestOptions:** `OrganizationsClient.RequestOptions`
+
+
@@ -6036,7 +6095,6 @@ await client.organizations.delete("id");
Update the details of a specific Organization, such as name and display name, branding options, and metadata.
-
@@ -6052,8 +6110,8 @@ Update the details of a specific
@@ -6068,34 +6126,34 @@ await client.organizations.update("id");
**id:** `string` — ID of the organization to update.
-
+
-
-**request:** `Management.UpdateOrganizationRequestContent`
-
+**request:** `Management.UpdateOrganizationRequestContent`
+
-
-**requestOptions:** `Organizations.RequestOptions`
-
+**requestOptions:** `OrganizationsClient.RequestOptions`
+
+
## Prompts
-
client.prompts.getSettings() -> Management.GetSettingsResponseContent
-
@@ -6109,7 +6167,6 @@ await client.organizations.update("id");
-
Retrieve details of the Universal Login configuration of your tenant. This includes the Identifier First Authentication and WebAuthn with Device Biometrics for MFA features.
-
@@ -6125,8 +6182,8 @@ Retrieve details of the Universal Login configuration of your tenant. This inclu
```typescript
await client.prompts.getSettings();
-```
+```
@@ -6140,13 +6197,14 @@ await client.prompts.getSettings();
-
-**requestOptions:** `Prompts.RequestOptions`
-
+**requestOptions:** `PromptsClient.RequestOptions`
+
+
@@ -6164,7 +6222,6 @@ await client.prompts.getSettings();
Update the Universal Login configuration of your tenant. This includes the Identifier First Authentication and WebAuthn with Device Biometrics for MFA features.
-
@@ -6180,8 +6237,8 @@ Update the Universal Login configuration of your tenant. This includes the
@@ -6195,27 +6252,27 @@ await client.prompts.updateSettings();
-
-**request:** `Management.UpdateSettingsRequestContent`
-
+**request:** `Management.UpdateSettingsRequestContent`
+
-
-**requestOptions:** `Prompts.RequestOptions`
-
+**requestOptions:** `PromptsClient.RequestOptions`
+
+
## RefreshTokens
-
client.refreshTokens.get(id) -> Management.GetRefreshTokenResponseContent
-
@@ -6229,7 +6286,6 @@ await client.prompts.updateSettings();
-
Retrieve refresh token information.
-
@@ -6245,8 +6301,8 @@ Retrieve refresh token information.
```typescript
await client.refreshTokens.get("id");
-```
+```
@@ -6261,20 +6317,21 @@ await client.refreshTokens.get("id");
**id:** `string` — ID refresh token to retrieve
-
+
-
-**requestOptions:** `RefreshTokens.RequestOptions`
-
+**requestOptions:** `RefreshTokensClient.RequestOptions`
+
+
@@ -6292,7 +6349,6 @@ await client.refreshTokens.get("id");
Delete a refresh token by its ID.
-
@@ -6308,8 +6364,8 @@ Delete a refresh token by its ID.
```typescript
await client.refreshTokens.delete("id");
-```
+```
@@ -6324,26 +6380,26 @@ await client.refreshTokens.delete("id");
**id:** `string` — ID of the refresh token to delete.
-
+
-
-**requestOptions:** `RefreshTokens.RequestOptions`
-
+**requestOptions:** `RefreshTokensClient.RequestOptions`
+
+
## ResourceServers
-
client.resourceServers.list({ ...params }) -> core.Page
-
@@ -6357,7 +6413,6 @@ await client.refreshTokens.delete("id");
-
Retrieve details of all APIs associated with your tenant.
-
@@ -6376,7 +6431,7 @@ const pageableResponse = await client.resourceServers.list({
page: 1,
per_page: 1,
include_totals: true,
- include_fields: true,
+ include_fields: true
});
for await (const item of pageableResponse) {
console.log(item);
@@ -6387,7 +6442,7 @@ let page = await client.resourceServers.list({
page: 1,
per_page: 1,
include_totals: true,
- include_fields: true,
+ include_fields: true
});
while (page.hasNextPage()) {
page = page.getNextPage();
@@ -6395,8 +6450,8 @@ while (page.hasNextPage()) {
// You can also access the underlying response
const response = page.response;
-```
+```
@@ -6410,21 +6465,22 @@ const response = page.response;
-
-**request:** `Management.ListResourceServerRequestParameters`
-
+**request:** `Management.ListResourceServerRequestParameters`
+
-
-**requestOptions:** `ResourceServers.RequestOptions`
-
+**requestOptions:** `ResourceServersClient.RequestOptions`
+
+
@@ -6442,7 +6498,6 @@ const response = page.response;
Create a new API associated with your tenant. Note that all new APIs must be registered with Auth0. For more information, read APIs.
-
@@ -6458,10 +6513,10 @@ Create a new API associated with your tenant. Note that all new APIs must be reg
```typescript
await client.resourceServers.create({
- identifier: "identifier",
+ identifier: "identifier"
});
-```
+```
@@ -6475,21 +6530,22 @@ await client.resourceServers.create({
-
-**request:** `Management.CreateResourceServerRequestContent`
-
+**request:** `Management.CreateResourceServerRequestContent`
+
-
-**requestOptions:** `ResourceServers.RequestOptions`
-
+**requestOptions:** `ResourceServersClient.RequestOptions`
+
+
@@ -6507,7 +6563,6 @@ await client.resourceServers.create({
Retrieve API details with the given ID.
-
@@ -6523,10 +6578,10 @@ Retrieve API details with the given ID
```typescript
await client.resourceServers.get("id", {
- include_fields: true,
+ include_fields: true
});
-```
+```
@@ -6541,28 +6596,29 @@ await client.resourceServers.get("id", {
**id:** `string` — ID or audience of the resource server to retrieve.
-
+
-
-**request:** `Management.GetResourceServerRequestParameters`
-
+**request:** `Management.GetResourceServerRequestParameters`
+
-
-**requestOptions:** `ResourceServers.RequestOptions`
-
+**requestOptions:** `ResourceServersClient.RequestOptions`
+
+
@@ -6580,7 +6636,6 @@ await client.resourceServers.get("id", {
Delete an existing API by ID. For more information, read API Settings.
-
@@ -6596,8 +6651,8 @@ Delete an existing API by ID. For more information, read
@@ -6612,20 +6667,21 @@ await client.resourceServers.delete("id");
**id:** `string` — ID or the audience of the resource server to delete.
-
+
-
-**requestOptions:** `ResourceServers.RequestOptions`
-
+**requestOptions:** `ResourceServersClient.RequestOptions`
+
+
@@ -6643,7 +6699,6 @@ await client.resourceServers.delete("id");
Change an existing API setting by resource server ID. For more information, read API Settings.
-
@@ -6659,8 +6714,8 @@ Change an existing API setting by resource server ID. For more information, read
```typescript
await client.resourceServers.update("id");
-```
+```
@@ -6675,34 +6730,34 @@ await client.resourceServers.update("id");
**id:** `string` — ID or audience of the resource server to update.
-
+
-
-**request:** `Management.UpdateResourceServerRequestContent`
-
+**request:** `Management.UpdateResourceServerRequestContent`
+
-
-**requestOptions:** `ResourceServers.RequestOptions`
-
+**requestOptions:** `ResourceServersClient.RequestOptions`
+
+
## Roles
-
client.roles.list({ ...params }) -> core.Page
-
@@ -6718,7 +6773,6 @@ await client.resourceServers.update("id");
Retrieve detailed list of user roles created in your tenant.
Note: The returned list does not include standard roles available for tenant members, such as Admin or Support Access.
-
@@ -6737,7 +6791,7 @@ const pageableResponse = await client.roles.list({
per_page: 1,
page: 1,
include_totals: true,
- name_filter: "name_filter",
+ name_filter: "name_filter"
});
for await (const item of pageableResponse) {
console.log(item);
@@ -6748,7 +6802,7 @@ let page = await client.roles.list({
per_page: 1,
page: 1,
include_totals: true,
- name_filter: "name_filter",
+ name_filter: "name_filter"
});
while (page.hasNextPage()) {
page = page.getNextPage();
@@ -6756,8 +6810,8 @@ while (page.hasNextPage()) {
// You can also access the underlying response
const response = page.response;
-```
+```
@@ -6771,21 +6825,22 @@ const response = page.response;
-
-**request:** `Management.ListRolesRequestParameters`
-
+**request:** `Management.ListRolesRequestParameters`
+
-
-**requestOptions:** `Roles.RequestOptions`
-
+**requestOptions:** `RolesClient.RequestOptions`
+
+
@@ -6805,7 +6860,6 @@ const response = page.response;
Create a user role for Role-Based Access Control.
Note: New roles are not associated with any permissions by default. To assign existing permissions to your role, review Associate Permissions with a Role. To create new permissions, review Add API Permissions.
-
@@ -6821,10 +6875,10 @@ Create a user role for
@@ -6838,21 +6892,22 @@ await client.roles.create({
-
-**request:** `Management.CreateRoleRequestContent`
-
+**request:** `Management.CreateRoleRequestContent`
+
-
-**requestOptions:** `Roles.RequestOptions`
-
+**requestOptions:** `RolesClient.RequestOptions`
+
+
@@ -6870,7 +6925,6 @@ await client.roles.create({
Retrieve details about a specific user role specified by ID.
-
@@ -6886,8 +6940,8 @@ Retrieve details about a specific
@@ -6902,20 +6956,21 @@ await client.roles.get("id");
**id:** `string` — ID of the role to retrieve.
-
+
-
-**requestOptions:** `Roles.RequestOptions`
-
+**requestOptions:** `RolesClient.RequestOptions`
+
+
@@ -6933,7 +6988,6 @@ await client.roles.get("id");
Delete a specific user role from your tenant. Once deleted, it is removed from any user who was previously assigned that role. This action cannot be undone.
-
@@ -6949,8 +7003,8 @@ Delete a specific
@@ -6965,20 +7019,21 @@ await client.roles.delete("id");
**id:** `string` — ID of the role to delete.
-
+
-
-**requestOptions:** `Roles.RequestOptions`
-
+**requestOptions:** `RolesClient.RequestOptions`
+
+
@@ -6996,7 +7051,6 @@ await client.roles.delete("id");
Modify the details of a specific user role specified by ID.
-
@@ -7012,8 +7066,8 @@ Modify the details of a specific
@@ -7028,34 +7082,34 @@ await client.roles.update("id");
**id:** `string` — ID of the role to update.
-
+
-
-**request:** `Management.UpdateRoleRequestContent`
-
+**request:** `Management.UpdateRoleRequestContent`
+
-
-**requestOptions:** `Roles.RequestOptions`
-
+**requestOptions:** `RolesClient.RequestOptions`
+
+
## Rules
-
client.rules.list({ ...params }) -> core.Page
-
@@ -7069,7 +7123,6 @@ await client.roles.update("id");
-
Retrieve a filtered list of rules. Accepts a list of fields to include or exclude.
-
@@ -7090,7 +7143,7 @@ const pageableResponse = await client.rules.list({
include_totals: true,
enabled: true,
fields: "fields",
- include_fields: true,
+ include_fields: true
});
for await (const item of pageableResponse) {
console.log(item);
@@ -7103,7 +7156,7 @@ let page = await client.rules.list({
include_totals: true,
enabled: true,
fields: "fields",
- include_fields: true,
+ include_fields: true
});
while (page.hasNextPage()) {
page = page.getNextPage();
@@ -7111,8 +7164,8 @@ while (page.hasNextPage()) {
// You can also access the underlying response
const response = page.response;
-```
+```
@@ -7126,21 +7179,22 @@ const response = page.response;
-
-**request:** `Management.ListRulesRequestParameters`
-
+**request:** `Management.ListRulesRequestParameters`
+
-
-**requestOptions:** `Rules.RequestOptions`
-
+**requestOptions:** `RulesClient.RequestOptions`
+
+
@@ -7160,7 +7214,6 @@ const response = page.response;
Create a new rule.
Note: Changing a rule's stage of execution from the default login_success can change the rule's function signature to have user omitted.
-
@@ -7177,10 +7230,10 @@ Note: Changing a rule's stage of execution from the default login_success<
```typescript
await client.rules.create({
name: "name",
- script: "script",
+ script: "script"
});
-```
+```
@@ -7194,21 +7247,22 @@ await client.rules.create({
-
-**request:** `Management.CreateRuleRequestContent`
-
+**request:** `Management.CreateRuleRequestContent`
+
-
-**requestOptions:** `Rules.RequestOptions`
-
+**requestOptions:** `RulesClient.RequestOptions`
+
+
@@ -7226,7 +7280,6 @@ await client.rules.create({
Retrieve rule details. Accepts a list of fields to include or exclude in the result.
-
@@ -7243,10 +7296,10 @@ Retrieve rule details. Accepts a list
```typescript
await client.rules.get("id", {
fields: "fields",
- include_fields: true,
+ include_fields: true
});
-```
+```
@@ -7261,28 +7314,29 @@ await client.rules.get("id", {
**id:** `string` — ID of the rule to retrieve.
-
+
-
-**request:** `Management.GetRuleRequestParameters`
-
+**request:** `Management.GetRuleRequestParameters`
+
-
-**requestOptions:** `Rules.RequestOptions`
-
+**requestOptions:** `RulesClient.RequestOptions`
+
+
@@ -7300,7 +7354,6 @@ await client.rules.get("id", {
Delete a rule.
-
@@ -7316,8 +7369,8 @@ Delete a rule.
```typescript
await client.rules.delete("id");
-```
+```
@@ -7332,20 +7385,21 @@ await client.rules.delete("id");
**id:** `string` — ID of the rule to delete.
-
+
-
-**requestOptions:** `Rules.RequestOptions`
-
+**requestOptions:** `RulesClient.RequestOptions`
+
+
@@ -7363,7 +7417,6 @@ await client.rules.delete("id");
Update an existing rule.
-
@@ -7379,8 +7432,8 @@ Update an existing rule.
```typescript
await client.rules.update("id");
-```
+```
@@ -7395,34 +7448,34 @@ await client.rules.update("id");
**id:** `string` — ID of the rule to retrieve.
-
+
-
-**request:** `Management.UpdateRuleRequestContent`
-
+**request:** `Management.UpdateRuleRequestContent`
+
-
-**requestOptions:** `Rules.RequestOptions`
-
+**requestOptions:** `RulesClient.RequestOptions`
+
+
## RulesConfigs
-
client.rulesConfigs.list() -> Management.RulesConfig[]
-
@@ -7438,7 +7491,6 @@ await client.rules.update("id");
Retrieve rules config variable keys.
Note: For security, config variable values cannot be retrieved outside rule execution.
-
@@ -7454,8 +7506,8 @@ Retrieve rules config variable keys.
```typescript
await client.rulesConfigs.list();
-```
+```
@@ -7469,13 +7521,14 @@ await client.rulesConfigs.list();
-
-**requestOptions:** `RulesConfigs.RequestOptions`
-
+**requestOptions:** `RulesConfigsClient.RequestOptions`
+
+
@@ -7493,7 +7546,6 @@ await client.rulesConfigs.list();
Sets a rules config variable.
-
@@ -7509,10 +7561,10 @@ Sets a rules config variable.
```typescript
await client.rulesConfigs.set("key", {
- value: "value",
+ value: "value"
});
-```
+```
@@ -7527,28 +7579,29 @@ await client.rulesConfigs.set("key", {
**key:** `string` — Key of the rules config variable to set (max length: 127 characters).
-
+
-
-**request:** `Management.SetRulesConfigRequestContent`
-
+**request:** `Management.SetRulesConfigRequestContent`
+
-
-**requestOptions:** `RulesConfigs.RequestOptions`
-
+**requestOptions:** `RulesConfigsClient.RequestOptions`
+
+
@@ -7566,7 +7619,6 @@ await client.rulesConfigs.set("key", {
Delete a rules config variable identified by its key.
-
@@ -7582,8 +7634,8 @@ Delete a rules config variable identified by its key.
```typescript
await client.rulesConfigs.delete("key");
-```
+```
@@ -7598,26 +7650,26 @@ await client.rulesConfigs.delete("key");
**key:** `string` — Key of the rules config variable to delete.
-
+
-
-**requestOptions:** `RulesConfigs.RequestOptions`
-
+**requestOptions:** `RulesConfigsClient.RequestOptions`
+
+
## SelfServiceProfiles
-
client.selfServiceProfiles.list({ ...params }) -> core.Page
-
@@ -7631,7 +7683,6 @@ await client.rulesConfigs.delete("key");
-
Retrieves self-service profiles.
-
@@ -7649,7 +7700,7 @@ Retrieves self-service profiles.
const pageableResponse = await client.selfServiceProfiles.list({
page: 1,
per_page: 1,
- include_totals: true,
+ include_totals: true
});
for await (const item of pageableResponse) {
console.log(item);
@@ -7659,7 +7710,7 @@ for await (const item of pageableResponse) {
let page = await client.selfServiceProfiles.list({
page: 1,
per_page: 1,
- include_totals: true,
+ include_totals: true
});
while (page.hasNextPage()) {
page = page.getNextPage();
@@ -7667,8 +7718,8 @@ while (page.hasNextPage()) {
// You can also access the underlying response
const response = page.response;
-```
+```
@@ -7682,21 +7733,22 @@ const response = page.response;
-
-**request:** `Management.ListSelfServiceProfilesRequestParameters`
-
+**request:** `Management.ListSelfServiceProfilesRequestParameters`
+
-
-**requestOptions:** `SelfServiceProfiles.RequestOptions`
-
+**requestOptions:** `SelfServiceProfilesClient.RequestOptions`
+
+
@@ -7714,7 +7766,6 @@ const response = page.response;
Creates a self-service profile.
-
@@ -7730,10 +7781,10 @@ Creates a self-service profile.
```typescript
await client.selfServiceProfiles.create({
- name: "name",
+ name: "name"
});
-```
+```
@@ -7747,21 +7798,22 @@ await client.selfServiceProfiles.create({
-
-**request:** `Management.CreateSelfServiceProfileRequestContent`
-
+**request:** `Management.CreateSelfServiceProfileRequestContent`
+
-
-**requestOptions:** `SelfServiceProfiles.RequestOptions`
-
+**requestOptions:** `SelfServiceProfilesClient.RequestOptions`
+
+
@@ -7779,7 +7831,6 @@ await client.selfServiceProfiles.create({
Retrieves a self-service profile by Id.
-
@@ -7795,8 +7846,8 @@ Retrieves a self-service profile by Id.
```typescript
await client.selfServiceProfiles.get("id");
-```
+```
@@ -7811,20 +7862,21 @@ await client.selfServiceProfiles.get("id");
**id:** `string` — The id of the self-service profile to retrieve
-
+
-
-**requestOptions:** `SelfServiceProfiles.RequestOptions`
-
+**requestOptions:** `SelfServiceProfilesClient.RequestOptions`
+
+
@@ -7842,7 +7894,6 @@ await client.selfServiceProfiles.get("id");
Deletes a self-service profile by Id.
-
@@ -7858,8 +7909,8 @@ Deletes a self-service profile by Id.
```typescript
await client.selfServiceProfiles.delete("id");
-```
+```
@@ -7874,20 +7925,21 @@ await client.selfServiceProfiles.delete("id");
**id:** `string` — The id of the self-service profile to delete
-
+
-
-**requestOptions:** `SelfServiceProfiles.RequestOptions`
-
+**requestOptions:** `SelfServiceProfilesClient.RequestOptions`
+
+
@@ -7905,7 +7957,6 @@ await client.selfServiceProfiles.delete("id");
Updates a self-service profile.
-
@@ -7921,8 +7972,8 @@ Updates a self-service profile.
```typescript
await client.selfServiceProfiles.update("id");
-```
+```
@@ -7937,34 +7988,34 @@ await client.selfServiceProfiles.update("id");
**id:** `string` — The id of the self-service profile to update
-
+
-
-**request:** `Management.UpdateSelfServiceProfileRequestContent`
-
+**request:** `Management.UpdateSelfServiceProfileRequestContent`
+
-
-**requestOptions:** `SelfServiceProfiles.RequestOptions`
-
+**requestOptions:** `SelfServiceProfilesClient.RequestOptions`
+
+
## Sessions
-
client.sessions.get(id) -> Management.GetSessionResponseContent
-
@@ -7978,7 +8029,6 @@ await client.selfServiceProfiles.update("id");
-
Retrieve session information.
-
@@ -7994,8 +8044,8 @@ Retrieve session information.
```typescript
await client.sessions.get("id");
-```
+```
@@ -8010,20 +8060,21 @@ await client.sessions.get("id");
**id:** `string` — ID of session to retrieve
-
+
-
-**requestOptions:** `Sessions.RequestOptions`
-
+**requestOptions:** `SessionsClient.RequestOptions`
+
+
@@ -8041,7 +8092,6 @@ await client.sessions.get("id");
Delete a session by ID.
-
@@ -8057,8 +8107,8 @@ Delete a session by ID.
```typescript
await client.sessions.delete("id");
-```
+```
@@ -8073,90 +8123,20 @@ await client.sessions.delete("id");
**id:** `string` — ID of the session to delete.
-
-
-
-
-
--
-
-**requestOptions:** `Sessions.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.sessions.update(id, { ...params }) -> Management.UpdateSessionResponseContent
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Update session information.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.sessions.update("id");
-```
-
+
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-**id:** `string` — ID of the session to update.
-
+**requestOptions:** `SessionsClient.RequestOptions`
+
-
-
--
-
-**request:** `Management.UpdateSessionRequestContent`
-
-
--
-
-**requestOptions:** `Sessions.RequestOptions`
-
-
-
-
-
@@ -8175,7 +8155,6 @@ await client.sessions.update("id");
Revokes a session by ID and all associated refresh tokens.
-
@@ -8191,8 +8170,8 @@ Revokes a session by ID and all associated refresh tokens.
```typescript
await client.sessions.revoke("id");
-```
+```
@@ -8207,26 +8186,26 @@ await client.sessions.revoke("id");
**id:** `string` — ID of the session to revoke.
-
+
-
-**requestOptions:** `Sessions.RequestOptions`
-
+**requestOptions:** `SessionsClient.RequestOptions`
+
+
## Stats
-
client.stats.getActiveUsersCount() -> Management.GetActiveUsersCountStatsResponseContent
-
@@ -8240,7 +8219,6 @@ await client.sessions.revoke("id");
-
Retrieve the number of active users that logged in during the last 30 days.
-
@@ -8256,8 +8234,8 @@ Retrieve the number of active users that logged in during the last 30 days.
```typescript
await client.stats.getActiveUsersCount();
-```
+```
@@ -8271,13 +8249,14 @@ await client.stats.getActiveUsersCount();
-
-**requestOptions:** `Stats.RequestOptions`
-
+**requestOptions:** `StatsClient.RequestOptions`
+
+
@@ -8295,7 +8274,6 @@ await client.stats.getActiveUsersCount();
Retrieve the number of logins, signups and breached-password detections (subscription required) that occurred each day within a specified date range.
-
@@ -8312,10 +8290,10 @@ Retrieve the number of logins, signups and breached-password detections (subscri
```typescript
await client.stats.getDaily({
from: "from",
- to: "to",
+ to: "to"
});
-```
+```
@@ -8329,27 +8307,27 @@ await client.stats.getDaily({
-
-**request:** `Management.GetDailyStatsRequestParameters`
-
+**request:** `Management.GetDailyStatsRequestParameters`
+
-
-**requestOptions:** `Stats.RequestOptions`
-
+**requestOptions:** `StatsClient.RequestOptions`
+
+
## SupplementalSignals
-
client.supplementalSignals.get() -> Management.GetSupplementalSignalsResponseContent
-
@@ -8363,7 +8341,6 @@ await client.stats.getDaily({
-
Get the supplemental signals configuration for a tenant.
-
@@ -8379,8 +8356,8 @@ Get the supplemental signals configuration for a tenant.
```typescript
await client.supplementalSignals.get();
-```
+```
@@ -8394,13 +8371,14 @@ await client.supplementalSignals.get();
-
-**requestOptions:** `SupplementalSignals.RequestOptions`
-
+**requestOptions:** `SupplementalSignalsClient.RequestOptions`
+
+
@@ -8418,7 +8396,6 @@ await client.supplementalSignals.get();
Update the supplemental signals configuration for a tenant.
-
@@ -8434,10 +8411,10 @@ Update the supplemental signals configuration for a tenant.
```typescript
await client.supplementalSignals.patch({
- akamai_enabled: true,
+ akamai_enabled: true
});
-```
+```
@@ -8451,27 +8428,27 @@ await client.supplementalSignals.patch({
-
-**request:** `Management.UpdateSupplementalSignalsRequestContent`
-
+**request:** `Management.UpdateSupplementalSignalsRequestContent`
+
-
-**requestOptions:** `SupplementalSignals.RequestOptions`
-
+**requestOptions:** `SupplementalSignalsClient.RequestOptions`
+
+
## Tickets
-
client.tickets.verifyEmail({ ...params }) -> Management.VerifyEmailTicketResponseContent
-
@@ -8485,7 +8462,6 @@ await client.supplementalSignals.patch({
-
Create an email verification ticket for a given user. An email verification ticket is a generated URL that the user can consume to verify their email address.
-
@@ -8501,10 +8477,10 @@ Create an email verification ticket for a given user. An email verification tick
```typescript
await client.tickets.verifyEmail({
- user_id: "user_id",
+ user_id: "user_id"
});
-```
+```
@@ -8518,21 +8494,22 @@ await client.tickets.verifyEmail({
-
-**request:** `Management.VerifyEmailTicketRequestContent`
-
+**request:** `Management.VerifyEmailTicketRequestContent`
+
-
-**requestOptions:** `Tickets.RequestOptions`
-
+**requestOptions:** `TicketsClient.RequestOptions`
+
+
@@ -8552,7 +8529,6 @@ await client.tickets.verifyEmail({
Create a password change ticket for a given user. A password change ticket is a generated URL that the user can consume to start a reset password flow.
Note: This endpoint does not verify the given user’s identity. If you call this endpoint within your application, you must design your application to verify the user’s identity.
-
@@ -8568,8 +8544,8 @@ Note: This endpoint does not verify the given user’s identity. If you call thi
```typescript
await client.tickets.changePassword();
-```
+```
@@ -8583,27 +8559,27 @@ await client.tickets.changePassword();
-
-**request:** `Management.ChangePasswordTicketRequestContent`
-
+**request:** `Management.ChangePasswordTicketRequestContent`
+
-
-**requestOptions:** `Tickets.RequestOptions`
-
+**requestOptions:** `TicketsClient.RequestOptions`
+
+
## TokenExchangeProfiles
-
client.tokenExchangeProfiles.list({ ...params }) -> core.Page
-
@@ -8619,14 +8595,12 @@ await client.tickets.changePassword();
Retrieve a list of all Token Exchange Profiles available in your tenant.
This endpoint supports Checkpoint pagination. To search by checkpoint, use the following parameters:
-
from: Optional id from which to start selection.take: The total amount 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.
-
@@ -8643,7 +8617,7 @@ This endpoint supports Checkpoint pagination. To search by checkpoint, use the f
```typescript
const pageableResponse = await client.tokenExchangeProfiles.list({
from: "from",
- take: 1,
+ take: 1
});
for await (const item of pageableResponse) {
console.log(item);
@@ -8652,7 +8626,7 @@ for await (const item of pageableResponse) {
// Or you can manually iterate page-by-page
let page = await client.tokenExchangeProfiles.list({
from: "from",
- take: 1,
+ take: 1
});
while (page.hasNextPage()) {
page = page.getNextPage();
@@ -8660,8 +8634,8 @@ while (page.hasNextPage()) {
// You can also access the underlying response
const response = page.response;
-```
+```
@@ -8675,21 +8649,22 @@ const response = page.response;
-
-**request:** `Management.TokenExchangeProfilesListRequest`
-
+**request:** `Management.TokenExchangeProfilesListRequest`
+
-
-**requestOptions:** `TokenExchangeProfiles.RequestOptions`
-
+**requestOptions:** `TokenExchangeProfilesClient.RequestOptions`
+
+
@@ -8707,7 +8682,6 @@ const response = page.response;
Create a new Token Exchange Profile within your tenant.
-
@@ -8725,10 +8699,10 @@ Create a new Token Exchange Profile within your tenant.
await client.tokenExchangeProfiles.create({
name: "name",
subject_token_type: "subject_token_type",
- action_id: "action_id",
+ action_id: "action_id"
});
-```
+```
@@ -8742,21 +8716,22 @@ await client.tokenExchangeProfiles.create({
-
-**request:** `Management.CreateTokenExchangeProfileRequestContent`
-
+**request:** `Management.CreateTokenExchangeProfileRequestContent`
+
-
-**requestOptions:** `TokenExchangeProfiles.RequestOptions`
-
+**requestOptions:** `TokenExchangeProfilesClient.RequestOptions`
+
+
@@ -8774,7 +8749,6 @@ await client.tokenExchangeProfiles.create({
Retrieve details about a single Token Exchange Profile specified by ID.
-
@@ -8790,8 +8764,8 @@ Retrieve details about a single Token Exchange Profile specified by ID.
```typescript
await client.tokenExchangeProfiles.get("id");
-```
+```
@@ -8806,20 +8780,21 @@ await client.tokenExchangeProfiles.get("id");
**id:** `string` — ID of the Token Exchange Profile to retrieve.
-
+
-
-**requestOptions:** `TokenExchangeProfiles.RequestOptions`
-
+**requestOptions:** `TokenExchangeProfilesClient.RequestOptions`
+
+
@@ -8837,7 +8812,6 @@ await client.tokenExchangeProfiles.get("id");
Delete a Token Exchange Profile within your tenant.
-
@@ -8853,8 +8827,8 @@ Delete a Token Exchange Profile within your tenant.
```typescript
await client.tokenExchangeProfiles.delete("id");
-```
+```
@@ -8869,20 +8843,21 @@ await client.tokenExchangeProfiles.delete("id");
**id:** `string` — ID of the Token Exchange Profile to delete.
-
+
-
-**requestOptions:** `TokenExchangeProfiles.RequestOptions`
-
+**requestOptions:** `TokenExchangeProfilesClient.RequestOptions`
+
+
@@ -8900,7 +8875,6 @@ await client.tokenExchangeProfiles.delete("id");
Update a Token Exchange Profile within your tenant.
-
@@ -8916,8 +8890,8 @@ Update a Token Exchange Profile within your tenant.
```typescript
await client.tokenExchangeProfiles.update("id");
-```
+```
@@ -8932,35 +8906,35 @@ await client.tokenExchangeProfiles.update("id");
**id:** `string` — ID of the Token Exchange Profile to update.
-
+
-
-**request:** `Management.UpdateTokenExchangeProfileRequestContent`
-
+**request:** `Management.UpdateTokenExchangeProfileRequestContent`
+
-
-**requestOptions:** `TokenExchangeProfiles.RequestOptions`
-
+**requestOptions:** `TokenExchangeProfilesClient.RequestOptions`
+
+
-## UserAttributeProfiles
-
-client.userAttributeProfiles.list({ ...params }) -> core.Page
+## UserBlocks
+client.userBlocks.listByIdentifier({ ...params }) -> Management.ListUserBlocksByIdentifierResponseContent
-
@@ -8972,8 +8946,7 @@ await client.tokenExchangeProfiles.update("id");
-
-Retrieve a list of User Attribute Profiles. This endpoint supports Checkpoint pagination.
-
+Retrieve details of all Brute-force Protection blocks for a user with the given identifier (username, phone number, or email).
@@ -8988,27 +8961,12 @@ Retrieve a list of User Attribute Profiles. This endpoint supports Checkpoint pa
-
```typescript
-const pageableResponse = await client.userAttributeProfiles.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.userAttributeProfiles.list({
- from: "from",
- take: 1,
+await client.userBlocks.listByIdentifier({
+ identifier: "identifier",
+ consider_brute_force_enablement: true
});
-while (page.hasNextPage()) {
- page = page.getNextPage();
-}
-// You can also access the underlying response
-const response = page.response;
```
-
@@ -9022,26 +8980,27 @@ const response = page.response;
-
-**request:** `Management.ListUserAttributeProfileRequestParameters`
-
+**request:** `Management.ListUserBlocksByIdentifierRequestParameters`
+
-
-**requestOptions:** `UserAttributeProfiles.RequestOptions`
-
+**requestOptions:** `UserBlocksClient.RequestOptions`
+
+
-client.userAttributeProfiles.create({ ...params }) -> Management.CreateUserAttributeProfileResponseContent
+client.userBlocks.deleteByIdentifier({ ...params }) -> void
-
@@ -9053,8 +9012,9 @@ const response = page.response;
-
-Retrieve details about a single User Attribute Profile specified by ID.
+Remove all Brute-force Protection blocks for the user with the given identifier (username, phone number, or email).
+Note: This endpoint does not unblock users that were blocked by a tenant administrator.
@@ -9069,19 +9029,11 @@ Retrieve details about a single User Attribute Profile specified by ID.
-
```typescript
-await client.userAttributeProfiles.create({
- name: "name",
- user_attributes: {
- key: {
- description: "description",
- label: "label",
- profile_required: true,
- auth0_mapping: "auth0_mapping",
- },
- },
+await client.userBlocks.deleteByIdentifier({
+ identifier: "identifier"
});
-```
+```
@@ -9095,26 +9047,27 @@ await client.userAttributeProfiles.create({
-
-**request:** `Management.CreateUserAttributeProfileRequestContent`
-
+**request:** `Management.DeleteUserBlocksByIdentifierRequestParameters`
+
-
-**requestOptions:** `UserAttributeProfiles.RequestOptions`
-
+**requestOptions:** `UserBlocksClient.RequestOptions`
+
+
-client.userAttributeProfiles.listTemplates() -> Management.ListUserAttributeProfileTemplateResponseContent
+client.userBlocks.list(id, { ...params }) -> Management.ListUserBlocksResponseContent
-
@@ -9126,8 +9079,7 @@ await client.userAttributeProfiles.create({
-
-Retrieve a list of User Attribute Profile Templates.
-
+Retrieve details of all Brute-force Protection blocks for the user with the given ID.
@@ -9142,9 +9094,11 @@ Retrieve a list of User Attribute Profile Templates.
-
```typescript
-await client.userAttributeProfiles.listTemplates();
-```
+await client.userBlocks.list("id", {
+ consider_brute_force_enablement: true
+});
+```
@@ -9158,31 +9112,49 @@ await client.userAttributeProfiles.listTemplates();
-
-**requestOptions:** `UserAttributeProfiles.RequestOptions`
-
-
-
-
-
-
+**id:** `string` — user_id of the user blocks to retrieve.
+
-
-client.userAttributeProfiles.getTemplate(id) -> Management.GetUserAttributeProfileTemplateResponseContent
-
-#### 📝 Description
+**request:** `Management.ListUserBlocksRequestParameters`
+
+
+
-
+**requestOptions:** `UserBlocksClient.RequestOptions`
+
+
+
+
+
+
+
+
+
+
+
+client.userBlocks.delete(id) -> void
+
+-
+
+#### 📝 Description
+
-
-Retrieve a User Attribute Profile Template.
+
+-
+
+Remove all Brute-force Protection blocks for the user with the given ID.
+Note: This endpoint does not unblock users that were blocked by a tenant administrator.
@@ -9197,9 +9169,9 @@ Retrieve a User Attribute Profile Template.
-
```typescript
-await client.userAttributeProfiles.getTemplate("id");
-```
+await client.userBlocks.delete("id");
+```
@@ -9213,26 +9185,28 @@ await client.userAttributeProfiles.getTemplate("id");
-
-**id:** `string` — ID of the user-attribute-profile-template to retrieve.
-
+**id:** `string` — The user_id of the user to update.
+
-
-**requestOptions:** `UserAttributeProfiles.RequestOptions`
-
+**requestOptions:** `UserBlocksClient.RequestOptions`
+
+
-client.userAttributeProfiles.get(id) -> Management.GetUserAttributeProfileResponseContent
+## Users
+client.users.list({ ...params }) -> core.Page
-
@@ -9244,8 +9218,20 @@ await client.userAttributeProfiles.getTemplate("id");
-
-Retrieve details about a single User Attribute Profile specified by ID.
+Retrieve details of users. It is possible to:
+
+- Specify a search criteria for users
+- Sort the users to be returned
+- Select the fields to be returned
+- Specify the number of users to retrieve per page and the page index
+
+The
q query parameter can be used to get users that match the specified criteria using query string syntax.
+
+Learn more about searching for users.
+
+Read about best practices when working with the API endpoints for retrieving users.
+Auth0 limits the number of users you can return. If you exceed this threshold, please redefine your search, use the export job, or the User Import / Export extension.
@@ -9260,9 +9246,43 @@ Retrieve details about a single User Attribute Profile specified by ID.
-
```typescript
-await client.userAttributeProfiles.get("id");
-```
+const pageableResponse = await client.users.list({
+ page: 1,
+ per_page: 1,
+ include_totals: true,
+ sort: "sort",
+ connection: "connection",
+ fields: "fields",
+ include_fields: true,
+ q: "q",
+ search_engine: "v1",
+ primary_order: true
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.users.list({
+ page: 1,
+ per_page: 1,
+ include_totals: true,
+ sort: "sort",
+ connection: "connection",
+ fields: "fields",
+ include_fields: true,
+ q: "q",
+ search_engine: "v1",
+ primary_order: true
+});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+// You can also access the underlying response
+const response = page.response;
+
+```
@@ -9276,26 +9296,27 @@ await client.userAttributeProfiles.get("id");
-
-**id:** `string` — ID of the user-attribute-profile to retrieve.
-
+**request:** `Management.ListUsersRequestParameters`
+
-
-**requestOptions:** `UserAttributeProfiles.RequestOptions`
-
+**requestOptions:** `UsersClient.RequestOptions`
+
+
-client.userAttributeProfiles.delete(id) -> void
+client.users.create({ ...params }) -> Management.CreateUserResponseContent
-
@@ -9307,8 +9328,9 @@ await client.userAttributeProfiles.get("id");
-
-Delete a single User Attribute Profile specified by ID.
+Create a new user for a given database or passwordless connection.
+Note:
connection is required but other parameters such as email and password are dependent upon the type of connection.
@@ -9323,9 +9345,11 @@ Delete a single User Attribute Profile specified by ID.
-
```typescript
-await client.userAttributeProfiles.delete("id");
-```
+await client.users.create({
+ connection: "connection"
+});
+```
@@ -9339,26 +9363,27 @@ await client.userAttributeProfiles.delete("id");
-
-**id:** `string` — ID of the user-attribute-profile to delete.
-
+**request:** `Management.CreateUserRequestContent`
+
-
-**requestOptions:** `UserAttributeProfiles.RequestOptions`
-
+**requestOptions:** `UsersClient.RequestOptions`
+
+
-client.userAttributeProfiles.update(id, { ...params }) -> Management.UpdateUserAttributeProfileResponseContent
+client.users.listUsersByEmail({ ...params }) -> Management.UserResponseSchema[]
-
@@ -9370,8 +9395,11 @@ await client.userAttributeProfiles.delete("id");
-
-Update the details of a specific User attribute profile, such as name, user_id and user_attributes.
+Find users by email. If Auth0 is the identity provider (idP), the email address associated with a user is saved in lower case, regardless of how you initially provided it.
+For example, if you register a user as JohnSmith@example.com, Auth0 saves the user's email as johnsmith@example.com.
+
+Therefore, when using this endpoint, make sure that you are searching for users via email addresses using the correct case.
@@ -9386,9 +9414,13 @@ Update the details of a specific User attribute profile, such as name, user_id a
-
```typescript
-await client.userAttributeProfiles.update("id");
-```
+await client.users.listUsersByEmail({
+ fields: "fields",
+ include_fields: true,
+ email: "email"
+});
+```
@@ -9402,36 +9434,27 @@ await client.userAttributeProfiles.update("id");
-
-**id:** `string` — ID of the user attribute profile to update.
-
-
-
-
-
--
-
-**request:** `Management.UpdateUserAttributeProfileRequestContent`
-
+**request:** `Management.ListUsersByEmailRequestParameters`
+
-
-**requestOptions:** `UserAttributeProfiles.RequestOptions`
-
+**requestOptions:** `UsersClient.RequestOptions`
+
+
-## UserBlocks
-
-client.userBlocks.listByIdentifier({ ...params }) -> Management.ListUserBlocksByIdentifierResponseContent
+client.users.get(id, { ...params }) -> Management.GetUserResponseContent
-
@@ -9443,8 +9466,7 @@ await client.userAttributeProfiles.update("id");
-
-Retrieve details of all Brute-force Protection blocks for a user with the given identifier (username, phone number, or email).
-
+Retrieve user details. A list of fields to include or exclude may also be specified. For more information, see Retrieve Users with the Get Users Endpoint.
@@ -9459,12 +9481,12 @@ Retrieve details of all
@@ -9478,26 +9500,35 @@ await client.userBlocks.listByIdentifier({
-
-**request:** `Management.ListUserBlocksByIdentifierRequestParameters`
-
+**id:** `string` — ID of the user to retrieve.
+
-
-**requestOptions:** `UserBlocks.RequestOptions`
+**request:** `Management.GetUserRequestParameters`
+
+
+
+
+
+-
+**requestOptions:** `UsersClient.RequestOptions`
+
+
-client.userBlocks.deleteByIdentifier({ ...params }) -> void
+client.users.delete(id) -> void
-
@@ -9509,10 +9540,7 @@ await client.userBlocks.listByIdentifier({
-
-Remove all Brute-force Protection blocks for the user with the given identifier (username, phone number, or email).
-
-Note: This endpoint does not unblock users that were blocked by a tenant administrator.
-
+Delete a user by user ID. This action cannot be undone. For Auth0 Dashboard instructions, see Delete Users.
@@ -9527,11 +9555,9 @@ Note: This endpoint does not unblock users that were
@@ -9545,26 +9571,27 @@ await client.userBlocks.deleteByIdentifier({
-
-**request:** `Management.DeleteUserBlocksByIdentifierRequestParameters`
-
+**id:** `string` — ID of the user to delete.
+
-
-**requestOptions:** `UserBlocks.RequestOptions`
-
+**requestOptions:** `UsersClient.RequestOptions`
+
+
-client.userBlocks.list(id, { ...params }) -> Management.ListUserBlocksResponseContent
+client.users.update(id, { ...params }) -> Management.UpdateUserResponseContent
-
@@ -9576,8 +9603,76 @@ await client.userBlocks.deleteByIdentifier({
-
-Retrieve details of all Brute-force Protection blocks for the user with the given ID.
+Update a user.
+
+These are the attributes that can be updated at the root level:
+
+
+ - app_metadata
+ - blocked
+ - email
+ - email_verified
+ - family_name
+ - given_name
+ - name
+ - nickname
+ - password
+ - phone_number
+ - phone_verified
+ - picture
+ - username
+ - user_metadata
+ - verify_email
+
+
+Some considerations:
+
+ - The properties of the new object will replace the old ones.
+ - The metadata fields are an exception to this rule (
user_metadata and app_metadata). These properties are merged instead of being replaced but be careful, the merge only occurs on the first level.
+ - If you are updating
email, email_verified, phone_number, phone_verified, username or password of a secondary identity, you need to specify the connection property too.
+ - If you are updating
email or phone_number you can specify, optionally, the client_id property.
+ - Updating
email_verified is not supported for enterprise and passwordless sms connections.
+ - Updating the
blocked to false does not affect the user's blocked state from an excessive amount of incorrectly provided credentials. Use the "Unblock a user" endpoint from the "User Blocks" API to change the user's state.
+ - Supported attributes can be unset by supplying
null as the value.
+
+
+Updating a field (non-metadata property)
+To mark the email address of a user as verified, the body to send should be:
+{ "email_verified": true }
+
+Updating a user metadata root property
Let's assume that our test user has the following user_metadata:
+{ "user_metadata" : { "profileCode": 1479 } }
+
+To add the field addresses the body to send should be:
+{ "user_metadata" : { "addresses": {"work_address": "100 Industrial Way"} }}
+
+The modified object ends up with the following user_metadata property:{
+ "user_metadata": {
+ "profileCode": 1479,
+ "addresses": { "work_address": "100 Industrial Way" }
+ }
+}
+
+Updating an inner user metadata property
If there's existing user metadata to which we want to add "home_address": "742 Evergreen Terrace" (using the addresses property) we should send the whole addresses object. Since this is a first-level object, the object will be merged in, but its own properties will not be. The body to send should be:
+{
+ "user_metadata": {
+ "addresses": {
+ "work_address": "100 Industrial Way",
+ "home_address": "742 Evergreen Terrace"
+ }
+ }
+}
+The modified object ends up with the following user_metadata property:
+{
+ "user_metadata": {
+ "profileCode": 1479,
+ "addresses": {
+ "work_address": "100 Industrial Way",
+ "home_address": "742 Evergreen Terrace"
+ }
+ }
+}
@@ -9592,11 +9687,9 @@ Retrieve details of all
@@ -9610,34 +9703,35 @@ await client.userBlocks.list("id", {
-
-**id:** `string` — user_id of the user blocks to retrieve.
-
+**id:** `string` — ID of the user to update.
+
-
-**request:** `Management.ListUserBlocksRequestParameters`
-
+**request:** `Management.UpdateUserRequestContent`
+
-
-**requestOptions:** `UserBlocks.RequestOptions`
-
+**requestOptions:** `UsersClient.RequestOptions`
+
+
-client.userBlocks.delete(id) -> void
+client.users.regenerateRecoveryCode(id) -> Management.RegenerateUsersRecoveryCodeResponseContent
-
@@ -9649,10 +9743,7 @@ await client.userBlocks.list("id", {
-
-Remove all Brute-force Protection blocks for the user with the given ID.
-
-Note: This endpoint does not unblock users that were blocked by a tenant administrator.
-
+Remove an existing multi-factor authentication (MFA) recovery code and generate a new one. If a user cannot access the original device or account used for MFA enrollment, they can use a recovery code to authenticate.
@@ -9667,9 +9758,9 @@ Note: This endpoint does not unblock users that were
@@ -9683,28 +9774,27 @@ await client.userBlocks.delete("id");
-
-**id:** `string` — The user_id of the user to update.
-
+**id:** `string` — ID of the user to regenerate a multi-factor authentication recovery code for.
+
-
-**requestOptions:** `UserBlocks.RequestOptions`
-
+**requestOptions:** `UsersClient.RequestOptions`
+
+
-## Users
-
-client.users.list({ ...params }) -> core.Page
+client.users.revokeAccess(id, { ...params }) -> void
-
@@ -9716,25 +9806,11 @@ await client.userBlocks.delete("id");
-
-Retrieve details of users. It is possible to:
-
-- Specify a search criteria for users
-- Sort the users to be returned
-- Select the fields to be returned
-- Specify the number of users to retrieve per page and the page index
-
- The
q query parameter can be used to get users that match the specified criteria using query string syntax.
-
-Learn more about searching for users.
-
-Read about best practices when working with the API endpoints for retrieving users.
-
-Auth0 limits the number of users you can return. If you exceed this threshold, please redefine your search, use the export job, or the User Import / Export extension.
-
-
-
-
-
+Revokes selected resources related to a user (sessions, refresh tokens, ...).
+
+
+
+
#### 🔌 Usage
@@ -9745,43 +9821,9 @@ Auth0 limits the number of users you can return. If you exceed this threshold, p
```typescript
-const pageableResponse = await client.users.list({
- page: 1,
- per_page: 1,
- include_totals: true,
- sort: "sort",
- connection: "connection",
- fields: "fields",
- include_fields: true,
- q: "q",
- search_engine: "v1",
- primary_order: true,
-});
-for await (const item of pageableResponse) {
- console.log(item);
-}
-
-// Or you can manually iterate page-by-page
-let page = await client.users.list({
- page: 1,
- per_page: 1,
- include_totals: true,
- sort: "sort",
- connection: "connection",
- fields: "fields",
- include_fields: true,
- q: "q",
- search_engine: "v1",
- primary_order: true,
-});
-while (page.hasNextPage()) {
- page = page.getNextPage();
-}
+await client.users.revokeAccess("id");
-// You can also access the underlying response
-const response = page.response;
```
-
@@ -9795,26 +9837,36 @@ const response = page.response;
-
-**request:** `Management.ListUsersRequestParameters`
-
+**id:** `string` — ID of the user.
+
-
-**requestOptions:** `Users.RequestOptions`
+**request:** `Management.RevokeUserAccessRequestContent`
+
+
+
+
+
+-
+**requestOptions:** `UsersClient.RequestOptions`
+
+
-client.users.create({ ...params }) -> Management.CreateUserResponseContent
+## Actions Versions
+client.actions.versions.list(actionId, { ...params }) -> core.Page
-
@@ -9826,10 +9878,7 @@ const response = page.response;
-
-Create a new user for a given database or passwordless connection.
-
-Note:
connection is required but other parameters such as email and password are dependent upon the type of connection.
-
+Retrieve all of an action's versions. An action version is created whenever an action is deployed. An action version is immutable, once created.
@@ -9844,11 +9893,27 @@ Note: connection is required but other parameters such as ema
-
```typescript
-await client.users.create({
- connection: "connection",
+const pageableResponse = await client.actions.versions.list("actionId", {
+ page: 1,
+ per_page: 1
});
-```
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.actions.versions.list("actionId", {
+ page: 1,
+ per_page: 1
+});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
+```
@@ -9862,26 +9927,35 @@ await client.users.create({
-
-**request:** `Management.CreateUserRequestContent`
-
+**actionId:** `string` — The ID of the action.
+
-
-**requestOptions:** `Users.RequestOptions`
+**request:** `Management.ListActionVersionsRequestParameters`
+
+
+
+
+
+-
+**requestOptions:** `VersionsClient.RequestOptions`
+
+
-client.users.listUsersByEmail({ ...params }) -> Management.UserResponseSchema[]
+client.actions.versions.get(actionId, id) -> Management.GetActionVersionResponseContent
-
@@ -9893,12 +9967,7 @@ await client.users.create({
-
-Find users by email. If Auth0 is the identity provider (idP), the email address associated with a user is saved in lower case, regardless of how you initially provided it.
-
-For example, if you register a user as JohnSmith@example.com, Auth0 saves the user's email as johnsmith@example.com.
-
-Therefore, when using this endpoint, make sure that you are searching for users via email addresses using the correct case.
-
+Retrieve a specific version of an action. An action version is created whenever an action is deployed. An action version is immutable, once created.
@@ -9913,13 +9982,9 @@ Therefore, when using this endpoint, make sure that you are searching for users
-
```typescript
-await client.users.listUsersByEmail({
- fields: "fields",
- include_fields: true,
- email: "email",
-});
-```
+await client.actions.versions.get("actionId", "id");
+```
@@ -9933,26 +9998,35 @@ await client.users.listUsersByEmail({
-
-**request:** `Management.ListUsersByEmailRequestParameters`
-
+**actionId:** `string` — The ID of the action.
+
-
-**requestOptions:** `Users.RequestOptions`
+**id:** `string` — The ID of the action version.
+
+
+
+
+
+-
+**requestOptions:** `VersionsClient.RequestOptions`
+
+
-client.users.get(id, { ...params }) -> Management.GetUserResponseContent
+client.actions.versions.deploy(actionId, id, { ...params }) -> Management.DeployActionVersionResponseContent
-
@@ -9964,8 +10038,7 @@ await client.users.listUsersByEmail({
-
-Retrieve user details. A list of fields to include or exclude may also be specified. For more information, see Retrieve Users with the Get Users Endpoint.
-
+Performs the equivalent of a roll-back of an action to an earlier, specified version. Creates a new, deployed action version that is identical to the specified version. If this action is currently bound to a trigger, the system will begin executing the newly-created version immediately.
@@ -9980,12 +10053,9 @@ Retrieve user details. A list of fields to include or exclude may also be specif
-
```typescript
-await client.users.get("id", {
- fields: "fields",
- include_fields: true,
-});
-```
+await client.actions.versions.deploy("actionId", "id");
+```
@@ -9999,34 +10069,44 @@ await client.users.get("id", {
-
-**id:** `string` — ID of the user to retrieve.
-
+**actionId:** `string` — The ID of an action.
+
-
-**request:** `Management.GetUserRequestParameters`
-
+**id:** `string` — The ID of an action version.
+
-
-**requestOptions:** `Users.RequestOptions`
+**request:** `Management.DeployActionVersionRequestContent | undefined`
+
+
+
+
+
+-
+**requestOptions:** `VersionsClient.RequestOptions`
+
+
-client.users.delete(id) -> void
+## Actions Executions
+client.actions.executions.get(id) -> Management.GetActionExecutionResponseContent
-
@@ -10038,8 +10118,7 @@ await client.users.get("id", {
-
-Delete a user by user ID. This action cannot be undone. For Auth0 Dashboard instructions, see Delete Users.
-
+Retrieve information about a specific execution of a trigger. Relevant execution IDs will be included in tenant logs generated as part of that authentication flow. Executions will only be stored for 10 days after their creation.
@@ -10054,9 +10133,9 @@ Delete a user by user ID. This action cannot be undone. For Auth0 Dashboard inst
-
```typescript
-await client.users.delete("id");
-```
+await client.actions.executions.get("id");
+```
@@ -10070,26 +10149,28 @@ await client.users.delete("id");
-
-**id:** `string` — ID of the user to delete.
-
+**id:** `string` — The ID of the execution to retrieve.
+
-
-**requestOptions:** `Users.RequestOptions`
-
+**requestOptions:** `ExecutionsClient.RequestOptions`
+
+
-client.users.update(id, { ...params }) -> Management.UpdateUserResponseContent
+## Actions Triggers
+client.actions.triggers.list() -> Management.ListActionTriggersResponseContent
-
@@ -10101,79 +10182,7 @@ await client.users.delete("id");
-
-Update a user.
-
-These are the attributes that can be updated at the root level:
-
-
- - app_metadata
- - blocked
- - email
- - email_verified
- - family_name
- - given_name
- - name
- - nickname
- - password
- - phone_number
- - phone_verified
- - picture
- - username
- - user_metadata
- - verify_email
-
-
-Some considerations:
-
-
- - The properties of the new object will replace the old ones.
- - The metadata fields are an exception to this rule (
user_metadata and app_metadata). These properties are merged instead of being replaced but be careful, the merge only occurs on the first level.
- - If you are updating
email, email_verified, phone_number, phone_verified, username or password of a secondary identity, you need to specify the connection property too.
- - If you are updating
email or phone_number you can specify, optionally, the client_id property.
- - Updating
email_verified is not supported for enterprise and passwordless sms connections.
- - Updating the
blocked to false does not affect the user's blocked state from an excessive amount of incorrectly provided credentials. Use the "Unblock a user" endpoint from the "User Blocks" API to change the user's state.
- - Supported attributes can be unset by supplying
null as the value.
-
-
-Updating a field (non-metadata property)
-To mark the email address of a user as verified, the body to send should be:
-{ "email_verified": true }
-
-Updating a user metadata root property
Let's assume that our test user has the following user_metadata:
-{ "user_metadata" : { "profileCode": 1479 } }
-
-To add the field addresses the body to send should be:
-
-{ "user_metadata" : { "addresses": {"work_address": "100 Industrial Way"} }}
-
-The modified object ends up with the following user_metadata property:{
-"user_metadata": {
-"profileCode": 1479,
-"addresses": { "work_address": "100 Industrial Way" }
-}
-}
-
-Updating an inner user metadata property
If there's existing user metadata to which we want to add "home_address": "742 Evergreen Terrace" (using the addresses property) we should send the whole addresses object. Since this is a first-level object, the object will be merged in, but its own properties will not be. The body to send should be:
-{
- "user_metadata": {
- "addresses": {
- "work_address": "100 Industrial Way",
- "home_address": "742 Evergreen Terrace"
- }
- }
-}
-
-The modified object ends up with the following user_metadata property:
-
-{
- "user_metadata": {
- "profileCode": 1479,
- "addresses": {
- "work_address": "100 Industrial Way",
- "home_address": "742 Evergreen Terrace"
- }
- }
-}
+Retrieve the set of triggers currently available within actions. A trigger is an extensibility point to which actions can be bound.
@@ -10188,9 +10197,9 @@ The modified object ends up with the following user_metadata proper
-
```typescript
-await client.users.update("id");
-```
+await client.actions.triggers.list();
+```
@@ -10204,34 +10213,20 @@ await client.users.update("id");
-
-**id:** `string` — ID of the user to update.
-
+**requestOptions:** `TriggersClient.RequestOptions`
+
-
-
--
-
-**request:** `Management.UpdateUserRequestContent`
-
-
--
-
-**requestOptions:** `Users.RequestOptions`
-
-
-
-
-
-client.users.regenerateRecoveryCode(id) -> Management.RegenerateUsersRecoveryCodeResponseContent
+## Actions Triggers Bindings
+client.actions.triggers.bindings.list(triggerId, { ...params }) -> core.Page
-
@@ -10243,8 +10238,7 @@ await client.users.update("id");
-
-Remove an existing multi-factor authentication (MFA) recovery code and generate a new one. If a user cannot access the original device or account used for MFA enrollment, they can use a recovery code to authenticate.
-
+Retrieve the actions that are bound to a trigger. Once an action is created and deployed, it must be attached (i.e. bound) to a trigger so that it will be executed as part of a flow. The list of actions returned reflects the order in which they will be executed during the appropriate flow.
@@ -10259,12 +10253,30 @@ Remove an existing multi-factor authentication (MFA)
-
-
+const pageableResponse = await client.actions.triggers.bindings.list("triggerId", {
+ page: 1,
+ per_page: 1
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.actions.triggers.bindings.list("triggerId", {
+ page: 1,
+ per_page: 1
+});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
+
+```
+
+
+
#### ⚙️ Parameters
@@ -10275,26 +10287,35 @@ await client.users.regenerateRecoveryCode("id");
-
-**id:** `string` — ID of the user to regenerate a multi-factor authentication recovery code for.
-
+**triggerId:** `Management.ActionTriggerTypeEnum` — An actions extensibility point.
+
-
-**requestOptions:** `Users.RequestOptions`
+**request:** `Management.ListActionTriggerBindingsRequestParameters`
+
+
+
+
+
+-
+**requestOptions:** `BindingsClient.RequestOptions`
+
+
-client.users.revokeAccess(id, { ...params }) -> void
+client.actions.triggers.bindings.updateMany(triggerId, { ...params }) -> Management.UpdateActionBindingsResponseContent
-
@@ -10306,8 +10327,7 @@ await client.users.regenerateRecoveryCode("id");
-
-Revokes selected resources related to a user (sessions, refresh tokens, ...).
-
+Update the actions that are bound (i.e. attached) to a trigger. Once an action is created and deployed, it must be attached (i.e. bound) to a trigger so that it will be executed as part of a flow. The order in which the actions are provided will determine the order in which they are executed.
@@ -10322,9 +10342,9 @@ Revokes selected resources related to a user (sessions, refresh tokens, ...).
-
```typescript
-await client.users.revokeAccess("id");
-```
+await client.actions.triggers.bindings.updateMany("triggerId");
+```
@@ -10338,36 +10358,36 @@ await client.users.revokeAccess("id");
-
-**id:** `string` — ID of the user.
-
+**triggerId:** `Management.ActionTriggerTypeEnum` — An actions extensibility point.
+
-
-**request:** `Management.RevokeUserAccessRequestContent`
-
+**request:** `Management.UpdateActionBindingsRequestContent`
+
-
-**requestOptions:** `Users.RequestOptions`
-
+**requestOptions:** `BindingsClient.RequestOptions`
+
+
-## Actions Versions
-
-client.actions.versions.list(actionId, { ...params }) -> core.Page
+## Anomaly Blocks
+client.anomaly.blocks.checkIp(id) -> void
-
@@ -10379,8 +10399,7 @@ await client.users.revokeAccess("id");
-
-Retrieve all of an action's versions. An action version is created whenever an action is deployed. An action version is immutable, once created.
-
+Check if the given IP address is blocked via the Suspicious IP Throttling due to multiple suspicious attempts.
@@ -10395,27 +10414,9 @@ Retrieve all of an action's versions. An action version is created whenever an a
-
```typescript
-const pageableResponse = await client.actions.versions.list("actionId", {
- page: 1,
- per_page: 1,
-});
-for await (const item of pageableResponse) {
- console.log(item);
-}
-
-// Or you can manually iterate page-by-page
-let page = await client.actions.versions.list("actionId", {
- page: 1,
- per_page: 1,
-});
-while (page.hasNextPage()) {
- page = page.getNextPage();
-}
+await client.anomaly.blocks.checkIp("id");
-// You can also access the underlying response
-const response = page.response;
```
-
@@ -10429,34 +10430,27 @@ const response = page.response;
-
-**actionId:** `string` — The ID of the action.
-
-
-
-
-
--
-
-**request:** `Management.ListActionVersionsRequestParameters`
-
+**id:** `Management.AnomalyIpFormat` — IP address to check.
+
-
-**requestOptions:** `Versions.RequestOptions`
-
+**requestOptions:** `BlocksClient.RequestOptions`
+
+
-client.actions.versions.get(actionId, id) -> Management.GetActionVersionResponseContent
+client.anomaly.blocks.unblockIp(id) -> void
-
@@ -10468,8 +10462,7 @@ const response = page.response;
-
-Retrieve a specific version of an action. An action version is created whenever an action is deployed. An action version is immutable, once created.
-
+Remove a block imposed by Suspicious IP Throttling for the given IP address.
@@ -10484,9 +10477,9 @@ Retrieve a specific version of an action. An action version is created whenever
-
```typescript
-await client.actions.versions.get("actionId", "id");
-```
+await client.anomaly.blocks.unblockIp("id");
+```
@@ -10500,34 +10493,28 @@ await client.actions.versions.get("actionId", "id");
-
-**actionId:** `string` — The ID of the action.
-
-
-
-
-
--
-
-**id:** `string` — The ID of the action version.
-
+**id:** `Management.AnomalyIpFormat` — IP address to unblock.
+
-
-**requestOptions:** `Versions.RequestOptions`
-
+**requestOptions:** `BlocksClient.RequestOptions`
+
+
-client.actions.versions.deploy(actionId, id, { ...params }) -> Management.DeployActionVersionResponseContent
+## AttackProtection BreachedPasswordDetection
+client.attackProtection.breachedPasswordDetection.get() -> Management.GetBreachedPasswordDetectionSettingsResponseContent
-
@@ -10539,8 +10526,7 @@ await client.actions.versions.get("actionId", "id");
-
-Performs the equivalent of a roll-back of an action to an earlier, specified version. Creates a new, deployed action version that is identical to the specified version. If this action is currently bound to a trigger, the system will begin executing the newly-created version immediately.
-
+Retrieve details of the Breached Password Detection configuration of your tenant.
@@ -10555,9 +10541,9 @@ Performs the equivalent of a roll-back of an action to an earlier, specified ver
-
```typescript
-await client.actions.versions.deploy("actionId", "id");
-```
+await client.attackProtection.breachedPasswordDetection.get();
+```
@@ -10571,44 +10557,19 @@ await client.actions.versions.deploy("actionId", "id");
-
-**actionId:** `string` — The ID of an action.
-
-
-
-
-
--
-
-**id:** `string` — The ID of an action version.
-
+**requestOptions:** `BreachedPasswordDetectionClient.RequestOptions`
+
-
-
--
-
-**request:** `Management.DeployActionVersionRequestContent | undefined`
-
-
--
-
-**requestOptions:** `Versions.RequestOptions`
-
-
-
-
-
-## Actions Executions
-
-client.actions.executions.get(id) -> Management.GetActionExecutionResponseContent
+client.attackProtection.breachedPasswordDetection.update({ ...params }) -> Management.UpdateBreachedPasswordDetectionSettingsResponseContent
-
@@ -10620,8 +10581,7 @@ await client.actions.versions.deploy("actionId", "id");
-
-Retrieve information about a specific execution of a trigger. Relevant execution IDs will be included in tenant logs generated as part of that authentication flow. Executions will only be stored for 10 days after their creation.
-
+Update details of the Breached Password Detection configuration of your tenant.
@@ -10636,9 +10596,9 @@ Retrieve information about a specific execution of a trigger. Relevant execution
-
```typescript
-await client.actions.executions.get("id");
-```
+await client.attackProtection.breachedPasswordDetection.update();
+```
@@ -10652,28 +10612,28 @@ await client.actions.executions.get("id");
-
-**id:** `string` — The ID of the execution to retrieve.
-
+**request:** `Management.UpdateBreachedPasswordDetectionSettingsRequestContent`
+
-
-**requestOptions:** `Executions.RequestOptions`
-
+**requestOptions:** `BreachedPasswordDetectionClient.RequestOptions`
+
+
-## Actions Triggers
-
-client.actions.triggers.list() -> Management.ListActionTriggersResponseContent
+## AttackProtection BruteForceProtection
+client.attackProtection.bruteForceProtection.get() -> Management.GetBruteForceSettingsResponseContent
-
@@ -10685,8 +10645,7 @@ await client.actions.executions.get("id");
-
-Retrieve the set of triggers currently available within actions. A trigger is an extensibility point to which actions can be bound.
-
+Retrieve details of the Brute-force Protection configuration of your tenant.
@@ -10701,9 +10660,9 @@ Retrieve the set of triggers currently available within actions. A trigger is an
-
```typescript
-await client.actions.triggers.list();
-```
+await client.attackProtection.bruteForceProtection.get();
+```
@@ -10717,20 +10676,19 @@ await client.actions.triggers.list();
-
-**requestOptions:** `Triggers.RequestOptions`
-
+**requestOptions:** `BruteForceProtectionClient.RequestOptions`
+
+
-## Actions Triggers Bindings
-
-client.actions.triggers.bindings.list(triggerId, { ...params }) -> core.Page
+client.attackProtection.bruteForceProtection.update({ ...params }) -> Management.UpdateBruteForceSettingsResponseContent
-
@@ -10742,8 +10700,7 @@ await client.actions.triggers.list();
-
-Retrieve the actions that are bound to a trigger. Once an action is created and deployed, it must be attached (i.e. bound) to a trigger so that it will be executed as part of a flow. The list of actions returned reflects the order in which they will be executed during the appropriate flow.
-
+Update the Brute-force Protection configuration of your tenant.
@@ -10758,27 +10715,9 @@ Retrieve the actions that are bound to a trigger. Once an action is created and
-
```typescript
-const pageableResponse = await client.actions.triggers.bindings.list("triggerId", {
- page: 1,
- per_page: 1,
-});
-for await (const item of pageableResponse) {
- console.log(item);
-}
-
-// Or you can manually iterate page-by-page
-let page = await client.actions.triggers.bindings.list("triggerId", {
- page: 1,
- per_page: 1,
-});
-while (page.hasNextPage()) {
- page = page.getNextPage();
-}
+await client.attackProtection.bruteForceProtection.update();
-// You can also access the underlying response
-const response = page.response;
```
-
@@ -10792,34 +10731,28 @@ const response = page.response;
-
-**triggerId:** `Management.ActionTriggerTypeEnum` — An actions extensibility point.
-
-
-
-
-
--
-
-**request:** `Management.ListActionTriggerBindingsRequestParameters`
-
+**request:** `Management.UpdateBruteForceSettingsRequestContent`
+
-
-**requestOptions:** `Bindings.RequestOptions`
-
+**requestOptions:** `BruteForceProtectionClient.RequestOptions`
+
+
-client.actions.triggers.bindings.updateMany(triggerId, { ...params }) -> Management.UpdateActionBindingsResponseContent
+## AttackProtection SuspiciousIpThrottling
+client.attackProtection.suspiciousIpThrottling.get() -> Management.GetSuspiciousIpThrottlingSettingsResponseContent
-
@@ -10831,8 +10764,7 @@ const response = page.response;
-
-Update the actions that are bound (i.e. attached) to a trigger. Once an action is created and deployed, it must be attached (i.e. bound) to a trigger so that it will be executed as part of a flow. The order in which the actions are provided will determine the order in which they are executed.
-
+Retrieve details of the Suspicious IP Throttling configuration of your tenant.
@@ -10847,9 +10779,9 @@ Update the actions that are bound (i.e. attached) to a trigger. Once an action i
-
```typescript
-await client.actions.triggers.bindings.updateMany("triggerId");
-```
+await client.attackProtection.suspiciousIpThrottling.get();
+```
@@ -10863,36 +10795,19 @@ await client.actions.triggers.bindings.updateMany("triggerId");
-
-**triggerId:** `Management.ActionTriggerTypeEnum` — An actions extensibility point.
-
+**requestOptions:** `SuspiciousIpThrottlingClient.RequestOptions`
+
-
-
--
-
-**request:** `Management.UpdateActionBindingsRequestContent`
-
-
--
-
-**requestOptions:** `Bindings.RequestOptions`
-
-
-
-
-
-## Anomaly Blocks
-
-client.anomaly.blocks.checkIp(id) -> void
+client.attackProtection.suspiciousIpThrottling.update({ ...params }) -> Management.UpdateSuspiciousIpThrottlingSettingsResponseContent
-
@@ -10904,8 +10819,7 @@ await client.actions.triggers.bindings.updateMany("triggerId");
-
-Check if the given IP address is blocked via the Suspicious IP Throttling due to multiple suspicious attempts.
-
+Update the details of the Suspicious IP Throttling configuration of your tenant.
@@ -10920,9 +10834,9 @@ Check if the given IP address is blocked via the
@@ -10936,30 +10850,32 @@ await client.anomaly.blocks.checkIp("id");
-
-**id:** `Management.AnomalyIpFormat` — IP address to check.
-
+**request:** `Management.UpdateSuspiciousIpThrottlingSettingsRequestContent`
+
-
-**requestOptions:** `Blocks.RequestOptions`
-
+**requestOptions:** `SuspiciousIpThrottlingClient.RequestOptions`
+
+
-client.anomaly.blocks.unblockIp(id) -> void
+## Branding Templates
+client.branding.templates.getUniversalLogin() -> Management.GetUniversalLoginTemplateResponseContent
-
-#### 📝 Description
+#### 🔌 Usage
-
@@ -10967,25 +10883,10 @@ await client.anomaly.blocks.checkIp("id");
-
-Remove a block imposed by Suspicious IP Throttling for the given IP address.
+```typescript
+await client.branding.templates.getUniversalLogin();
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.anomaly.blocks.unblockIp("id");
```
-
@@ -10999,83 +10900,19 @@ await client.anomaly.blocks.unblockIp("id");
-
-**id:** `Management.AnomalyIpFormat` — IP address to unblock.
-
-
-
-
-
--
-
-**requestOptions:** `Blocks.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-## AttackProtection BotDetection
-
-client.attackProtection.botDetection.get() -> Management.GetBotDetectionSettingsResponseContent
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Get the Bot Detection configuration of your tenant.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.attackProtection.botDetection.get();
-```
-
+**requestOptions:** `TemplatesClient.RequestOptions`
+
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**requestOptions:** `BotDetection.RequestOptions`
-
-
-
-
-
-client.attackProtection.botDetection.update({ ...params }) -> Management.UpdateBotDetectionSettingsResponseContent
+client.branding.templates.updateUniversalLogin({ ...params }) -> void
-
@@ -11087,8 +10924,31 @@ await client.attackProtection.botDetection.get();
-
-Update the Bot Detection configuration of your tenant.
+Update the Universal Login branding template.
+
+
When content-type header is set to application/json, the expected body must be JSON:
+
+{
+ "template": "<!DOCTYPE html><html><head>{%- auth0:head -%}</head><body>{%- auth0:widget -%}</body></html>"
+}
+
+
+ When content-type header is set to text/html, the expected body must be the HTML template:
+
+
+<!DOCTYPE html>
+<code>
+ <html>
+ <head>
+ {%- auth0:head -%}
+ </head>
+ <body>
+ {%- auth0:widget -%}
+ </body>
+ </html>
+</code>
+
@@ -11103,9 +10963,9 @@ Update the Bot Detection configuration of your tenant.
-
```typescript
-await client.attackProtection.botDetection.update();
-```
+await client.branding.templates.updateUniversalLogin("string");
+```
@@ -11119,46 +10979,30 @@ await client.attackProtection.botDetection.update();
-
-**request:** `Management.UpdateBotDetectionSettingsRequestContent`
-
+**request:** `Management.UpdateUniversalLoginTemplateRequestContent`
+
-
-**requestOptions:** `BotDetection.RequestOptions`
-
+**requestOptions:** `TemplatesClient.RequestOptions`
+
+
-## AttackProtection BreachedPasswordDetection
-
-client.attackProtection.breachedPasswordDetection.get() -> Management.GetBreachedPasswordDetectionSettingsResponseContent
-
--
-
-#### 📝 Description
-
-
--
-
+
client.branding.templates.deleteUniversalLogin() -> void
-
-Retrieve details of the Breached Password Detection configuration of your tenant.
-
-
-
-
-
-
#### 🔌 Usage
@@ -11168,9 +11012,9 @@ Retrieve details of the Breached Password Detection configuration of your tenant
-
```typescript
-await client.attackProtection.breachedPasswordDetection.get();
-```
+await client.branding.templates.deleteUniversalLogin();
+```
@@ -11184,18 +11028,20 @@ await client.attackProtection.breachedPasswordDetection.get();
-
-**requestOptions:** `BreachedPasswordDetection.RequestOptions`
-
+**requestOptions:** `TemplatesClient.RequestOptions`
+
+
-client.attackProtection.breachedPasswordDetection.update({ ...params }) -> Management.UpdateBreachedPasswordDetectionSettingsResponseContent
+## Branding Themes
+client.branding.themes.create({ ...params }) -> Management.CreateBrandingThemeResponseContent
-
@@ -11207,8 +11053,7 @@ await client.attackProtection.breachedPasswordDetection.get();
-
-Update details of the Breached Password Detection configuration of your tenant.
-
+Create branding theme.
@@ -11223,9 +11068,80 @@ Update details of the Breached Password Detection configuration of your tenant.
-
```typescript
-await client.attackProtection.breachedPasswordDetection.update();
-```
+await client.branding.themes.create({
+ borders: {
+ button_border_radius: 1.1,
+ button_border_weight: 1.1,
+ buttons_style: "pill",
+ input_border_radius: 1.1,
+ input_border_weight: 1.1,
+ inputs_style: "pill",
+ show_widget_shadow: true,
+ widget_border_weight: 1.1,
+ widget_corner_radius: 1.1
+ },
+ colors: {
+ body_text: "body_text",
+ error: "error",
+ header: "header",
+ icons: "icons",
+ input_background: "input_background",
+ input_border: "input_border",
+ input_filled_text: "input_filled_text",
+ input_labels_placeholders: "input_labels_placeholders",
+ links_focused_components: "links_focused_components",
+ primary_button: "primary_button",
+ primary_button_label: "primary_button_label",
+ secondary_button_border: "secondary_button_border",
+ secondary_button_label: "secondary_button_label",
+ success: "success",
+ widget_background: "widget_background",
+ widget_border: "widget_border"
+ },
+ fonts: {
+ body_text: {
+ bold: true,
+ size: 1.1
+ },
+ buttons_text: {
+ bold: true,
+ size: 1.1
+ },
+ font_url: "font_url",
+ input_labels: {
+ bold: true,
+ size: 1.1
+ },
+ links: {
+ bold: true,
+ size: 1.1
+ },
+ links_style: "normal",
+ reference_text_size: 1.1,
+ subtitle: {
+ bold: true,
+ size: 1.1
+ },
+ title: {
+ bold: true,
+ size: 1.1
+ }
+ },
+ page_background: {
+ background_color: "background_color",
+ background_image_url: "background_image_url",
+ page_layout: "center"
+ },
+ widget: {
+ header_text_alignment: "center",
+ logo_height: 1.1,
+ logo_position: "center",
+ logo_url: "logo_url",
+ social_buttons_layout: "bottom"
+ }
+});
+```
@@ -11239,28 +11155,27 @@ await client.attackProtection.breachedPasswordDetection.update();
-
-**request:** `Management.UpdateBreachedPasswordDetectionSettingsRequestContent`
-
+**request:** `Management.CreateBrandingThemeRequestContent`
+
-
-**requestOptions:** `BreachedPasswordDetection.RequestOptions`
-
+**requestOptions:** `ThemesClient.RequestOptions`
+
+
-## AttackProtection BruteForceProtection
-
-client.attackProtection.bruteForceProtection.get() -> Management.GetBruteForceSettingsResponseContent
+client.branding.themes.getDefault() -> Management.GetBrandingDefaultThemeResponseContent
-
@@ -11272,8 +11187,7 @@ await client.attackProtection.breachedPasswordDetection.update();
-
-Retrieve details of the Brute-force Protection configuration of your tenant.
-
+Retrieve default branding theme.
@@ -11288,9 +11202,9 @@ Retrieve details of the Brute-force Protection configuration of your tenant.
-
```typescript
-await client.attackProtection.bruteForceProtection.get();
-```
+await client.branding.themes.getDefault();
+```
@@ -11304,18 +11218,19 @@ await client.attackProtection.bruteForceProtection.get();
-
-**requestOptions:** `BruteForceProtection.RequestOptions`
-
+**requestOptions:** `ThemesClient.RequestOptions`
+
+
-client.attackProtection.bruteForceProtection.update({ ...params }) -> Management.UpdateBruteForceSettingsResponseContent
+client.branding.themes.get(themeId) -> Management.GetBrandingThemeResponseContent
-
@@ -11327,8 +11242,7 @@ await client.attackProtection.bruteForceProtection.get();
-
-Update the Brute-force Protection configuration of your tenant.
-
+Retrieve branding theme.
@@ -11343,9 +11257,9 @@ Update the Brute-force Protection configuration of your tenant.
-
```typescript
-await client.attackProtection.bruteForceProtection.update();
-```
+await client.branding.themes.get("themeId");
+```
@@ -11359,28 +11273,27 @@ await client.attackProtection.bruteForceProtection.update();
-
-**request:** `Management.UpdateBruteForceSettingsRequestContent`
-
+**themeId:** `string` — The ID of the theme
+
-
-**requestOptions:** `BruteForceProtection.RequestOptions`
-
+**requestOptions:** `ThemesClient.RequestOptions`
+
+
-## AttackProtection Captcha
-
-client.attackProtection.captcha.get() -> Management.GetAttackProtectionCaptchaResponseContent
+client.branding.themes.delete(themeId) -> void
-
@@ -11392,8 +11305,7 @@ await client.attackProtection.bruteForceProtection.update();
-
-Get the CAPTCHA configuration for your client.
-
+Delete branding theme.
@@ -11408,9 +11320,9 @@ Get the CAPTCHA configuration for your client.
-
```typescript
-await client.attackProtection.captcha.get();
-```
+await client.branding.themes.delete("themeId");
+```
@@ -11424,18 +11336,27 @@ await client.attackProtection.captcha.get();
-
-**requestOptions:** `Captcha.RequestOptions`
+**themeId:** `string` — The ID of the theme
+
+
+
+
+
+-
+**requestOptions:** `ThemesClient.RequestOptions`
+
+
-client.attackProtection.captcha.update({ ...params }) -> Management.UpdateAttackProtectionCaptchaResponseContent
+client.branding.themes.update(themeId, { ...params }) -> Management.UpdateBrandingThemeResponseContent
-
@@ -11447,8 +11368,7 @@ await client.attackProtection.captcha.get();
-
-Update existing CAPTCHA configuration for your client.
-
+Update branding theme.
@@ -11463,1583 +11383,80 @@ Update existing CAPTCHA configuration for your client.
-
```typescript
-await client.attackProtection.captcha.update();
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request:** `Management.UpdateAttackProtectionCaptchaRequestContent`
-
-
-
-
-
--
-
-**requestOptions:** `Captcha.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-## AttackProtection SuspiciousIpThrottling
-
-client.attackProtection.suspiciousIpThrottling.get() -> Management.GetSuspiciousIpThrottlingSettingsResponseContent
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Retrieve details of the Suspicious IP Throttling configuration of your tenant.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.attackProtection.suspiciousIpThrottling.get();
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**requestOptions:** `SuspiciousIpThrottling.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.attackProtection.suspiciousIpThrottling.update({ ...params }) -> Management.UpdateSuspiciousIpThrottlingSettingsResponseContent
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Update the details of the Suspicious IP Throttling configuration of your tenant.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.attackProtection.suspiciousIpThrottling.update();
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request:** `Management.UpdateSuspiciousIpThrottlingSettingsRequestContent`
-
-
-
-
-
--
-
-**requestOptions:** `SuspiciousIpThrottling.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-## Branding Templates
-
-client.branding.templates.getUniversalLogin() -> Management.GetUniversalLoginTemplateResponseContent
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.branding.templates.getUniversalLogin();
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**requestOptions:** `Templates.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.branding.templates.updateUniversalLogin({ ...params }) -> void
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Update the Universal Login branding template.
-
-
When content-type header is set to application/json:
-
-{
- "template": "<!DOCTYPE html>{% assign resolved_dir = dir | default: "auto" %}<html lang="{{locale}}" dir="{{resolved_dir}}"><head>{%- auth0:head -%}</head><body class="_widget-auto-layout">{%- auth0:widget -%}</body></html>"
-}
-
-
-
- When content-type header is set to text/html:
-
-
-<!DOCTYPE html>
-{% assign resolved_dir = dir | default: "auto" %}
-<html lang="{{locale}}" dir="{{resolved_dir}}">
- <head>
- {%- auth0:head -%}
- </head>
- <body class="_widget-auto-layout">
- {%- auth0:widget -%}
- </body>
-</html>
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.branding.templates.updateUniversalLogin("string");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request:** `Management.UpdateUniversalLoginTemplateRequestContent`
-
-
-
-
-
--
-
-**requestOptions:** `Templates.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.branding.templates.deleteUniversalLogin() -> void
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.branding.templates.deleteUniversalLogin();
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**requestOptions:** `Templates.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-## Branding Themes
-
-client.branding.themes.create({ ...params }) -> Management.CreateBrandingThemeResponseContent
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Create branding theme.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.branding.themes.create({
- borders: {
- button_border_radius: 1.1,
- button_border_weight: 1.1,
- buttons_style: "pill",
- input_border_radius: 1.1,
- input_border_weight: 1.1,
- inputs_style: "pill",
- show_widget_shadow: true,
- widget_border_weight: 1.1,
- widget_corner_radius: 1.1,
- },
- colors: {
- body_text: "body_text",
- error: "error",
- header: "header",
- icons: "icons",
- input_background: "input_background",
- input_border: "input_border",
- input_filled_text: "input_filled_text",
- input_labels_placeholders: "input_labels_placeholders",
- links_focused_components: "links_focused_components",
- primary_button: "primary_button",
- primary_button_label: "primary_button_label",
- secondary_button_border: "secondary_button_border",
- secondary_button_label: "secondary_button_label",
- success: "success",
- widget_background: "widget_background",
- widget_border: "widget_border",
- },
- fonts: {
- body_text: {
- bold: true,
- size: 1.1,
- },
- buttons_text: {
- bold: true,
- size: 1.1,
- },
- font_url: "font_url",
- input_labels: {
- bold: true,
- size: 1.1,
- },
- links: {
- bold: true,
- size: 1.1,
- },
- links_style: "normal",
- reference_text_size: 1.1,
- subtitle: {
- bold: true,
- size: 1.1,
- },
- title: {
- bold: true,
- size: 1.1,
- },
- },
- page_background: {
- background_color: "background_color",
- background_image_url: "background_image_url",
- page_layout: "center",
- },
- widget: {
- header_text_alignment: "center",
- logo_height: 1.1,
- logo_position: "center",
- logo_url: "logo_url",
- social_buttons_layout: "bottom",
- },
-});
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request:** `Management.CreateBrandingThemeRequestContent`
-
-
-
-
-
--
-
-**requestOptions:** `Themes.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.branding.themes.getDefault() -> Management.GetBrandingDefaultThemeResponseContent
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Retrieve default branding theme.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.branding.themes.getDefault();
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**requestOptions:** `Themes.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.branding.themes.get(themeId) -> Management.GetBrandingThemeResponseContent
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Retrieve branding theme.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.branding.themes.get("themeId");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**themeId:** `string` — The ID of the theme
-
-
-
-
-
--
-
-**requestOptions:** `Themes.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.branding.themes.delete(themeId) -> void
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Delete branding theme.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.branding.themes.delete("themeId");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**themeId:** `string` — The ID of the theme
-
-
-
-
-
--
-
-**requestOptions:** `Themes.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.branding.themes.update(themeId, { ...params }) -> Management.UpdateBrandingThemeResponseContent
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Update branding theme.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.branding.themes.update("themeId", {
- borders: {
- button_border_radius: 1.1,
- button_border_weight: 1.1,
- buttons_style: "pill",
- input_border_radius: 1.1,
- input_border_weight: 1.1,
- inputs_style: "pill",
- show_widget_shadow: true,
- widget_border_weight: 1.1,
- widget_corner_radius: 1.1,
- },
- colors: {
- body_text: "body_text",
- error: "error",
- header: "header",
- icons: "icons",
- input_background: "input_background",
- input_border: "input_border",
- input_filled_text: "input_filled_text",
- input_labels_placeholders: "input_labels_placeholders",
- links_focused_components: "links_focused_components",
- primary_button: "primary_button",
- primary_button_label: "primary_button_label",
- secondary_button_border: "secondary_button_border",
- secondary_button_label: "secondary_button_label",
- success: "success",
- widget_background: "widget_background",
- widget_border: "widget_border",
- },
- fonts: {
- body_text: {
- bold: true,
- size: 1.1,
- },
- buttons_text: {
- bold: true,
- size: 1.1,
- },
- font_url: "font_url",
- input_labels: {
- bold: true,
- size: 1.1,
- },
- links: {
- bold: true,
- size: 1.1,
- },
- links_style: "normal",
- reference_text_size: 1.1,
- subtitle: {
- bold: true,
- size: 1.1,
- },
- title: {
- bold: true,
- size: 1.1,
- },
- },
- page_background: {
- background_color: "background_color",
- background_image_url: "background_image_url",
- page_layout: "center",
- },
- widget: {
- header_text_alignment: "center",
- logo_height: 1.1,
- logo_position: "center",
- logo_url: "logo_url",
- social_buttons_layout: "bottom",
- },
-});
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**themeId:** `string` — The ID of the theme
-
-
-
-
-
--
-
-**request:** `Management.UpdateBrandingThemeRequestContent`
-
-
-
-
-
--
-
-**requestOptions:** `Themes.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-## Branding Phone Providers
-
-client.branding.phone.providers.list({ ...params }) -> Management.ListBrandingPhoneProvidersResponseContent
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Retrieve a list of phone providers details set for a Tenant. A list of fields to include or exclude may also be specified.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.branding.phone.providers.list({
- disabled: true,
-});
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request:** `Management.ListBrandingPhoneProvidersRequestParameters`
-
-
-
-
-
--
-
-**requestOptions:** `Providers.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.branding.phone.providers.create({ ...params }) -> Management.CreateBrandingPhoneProviderResponseContent
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Create a phone provider.
-The
credentials object requires different properties depending on the phone provider (which is specified using the name property).
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.branding.phone.providers.create({
- name: "twilio",
- credentials: {
- auth_token: "auth_token",
- },
-});
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request:** `Management.CreateBrandingPhoneProviderRequestContent`
-
-
-
-
-
--
-
-**requestOptions:** `Providers.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.branding.phone.providers.get(id) -> Management.GetBrandingPhoneProviderResponseContent
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Retrieve phone provider details. A list of fields to include or exclude may also be specified.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.branding.phone.providers.get("id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `string`
-
-
-
-
-
--
-
-**requestOptions:** `Providers.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.branding.phone.providers.delete(id) -> void
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Delete the configured phone provider.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.branding.phone.providers.delete("id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `string`
-
-
-
-
-
--
-
-**requestOptions:** `Providers.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.branding.phone.providers.update(id, { ...params }) -> Management.UpdateBrandingPhoneProviderResponseContent
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Update a phone provider.
-The
credentials object requires different properties depending on the phone provider (which is specified using the name property).
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.branding.phone.providers.update("id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Management.UpdateBrandingPhoneProviderRequestContent`
-
-
-
-
-
--
-
-**requestOptions:** `Providers.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.branding.phone.providers.test(id, { ...params }) -> Management.CreatePhoneProviderSendTestResponseContent
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.branding.phone.providers.test("id", {
- to: "to",
-});
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Management.CreatePhoneProviderSendTestRequestContent`
-
-
-
-
-
--
-
-**requestOptions:** `Providers.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-## Branding Phone Templates
-
-client.branding.phone.templates.list({ ...params }) -> Management.ListPhoneTemplatesResponseContent
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.branding.phone.templates.list({
- disabled: true,
-});
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request:** `Management.ListPhoneTemplatesRequestParameters`
-
-
-
-
-
--
-
-**requestOptions:** `Templates.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.branding.phone.templates.create({ ...params }) -> Management.CreatePhoneTemplateResponseContent
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.branding.phone.templates.create();
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request:** `Management.CreatePhoneTemplateRequestContent`
-
-
-
-
-
--
-
-**requestOptions:** `Templates.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.branding.phone.templates.get(id) -> Management.GetPhoneTemplateResponseContent
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.branding.phone.templates.get("id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `string`
-
-
-
-
-
--
-
-**requestOptions:** `Templates.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.branding.phone.templates.delete(id) -> void
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.branding.phone.templates.delete("id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `string`
-
-
-
-
-
--
-
-**requestOptions:** `Templates.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.branding.phone.templates.update(id, { ...params }) -> Management.UpdatePhoneTemplateResponseContent
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.branding.phone.templates.update("id");
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Management.UpdatePhoneTemplateRequestContent`
-
-
-
-
-
--
-
-**requestOptions:** `Templates.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.branding.phone.templates.reset(id, { ...params }) -> Management.ResetPhoneTemplateResponseContent
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.branding.phone.templates.reset("id", {
- key: "value",
-});
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Management.ResetPhoneTemplateRequestContent`
-
-
-
-
-
--
-
-**requestOptions:** `Templates.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.branding.phone.templates.test(id, { ...params }) -> Management.CreatePhoneTemplateTestNotificationResponseContent
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-await client.branding.phone.templates.test("id", {
- to: "to",
-});
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `string`
-
-
-
-
-
--
-
-**request:** `Management.CreatePhoneTemplateTestNotificationRequestContent`
-
-
-
-
-
--
-
-**requestOptions:** `Templates.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-## ClientGrants Organizations
-
-client.clientGrants.organizations.list(id, { ...params }) -> core.Page
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```typescript
-const pageableResponse = await client.clientGrants.organizations.list("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.clientGrants.organizations.list("id", {
- from: "from",
- take: 1,
+await client.branding.themes.update("themeId", {
+ borders: {
+ button_border_radius: 1.1,
+ button_border_weight: 1.1,
+ buttons_style: "pill",
+ input_border_radius: 1.1,
+ input_border_weight: 1.1,
+ inputs_style: "pill",
+ show_widget_shadow: true,
+ widget_border_weight: 1.1,
+ widget_corner_radius: 1.1
+ },
+ colors: {
+ body_text: "body_text",
+ error: "error",
+ header: "header",
+ icons: "icons",
+ input_background: "input_background",
+ input_border: "input_border",
+ input_filled_text: "input_filled_text",
+ input_labels_placeholders: "input_labels_placeholders",
+ links_focused_components: "links_focused_components",
+ primary_button: "primary_button",
+ primary_button_label: "primary_button_label",
+ secondary_button_border: "secondary_button_border",
+ secondary_button_label: "secondary_button_label",
+ success: "success",
+ widget_background: "widget_background",
+ widget_border: "widget_border"
+ },
+ fonts: {
+ body_text: {
+ bold: true,
+ size: 1.1
+ },
+ buttons_text: {
+ bold: true,
+ size: 1.1
+ },
+ font_url: "font_url",
+ input_labels: {
+ bold: true,
+ size: 1.1
+ },
+ links: {
+ bold: true,
+ size: 1.1
+ },
+ links_style: "normal",
+ reference_text_size: 1.1,
+ subtitle: {
+ bold: true,
+ size: 1.1
+ },
+ title: {
+ bold: true,
+ size: 1.1
+ }
+ },
+ page_background: {
+ background_color: "background_color",
+ background_image_url: "background_image_url",
+ page_layout: "center"
+ },
+ widget: {
+ header_text_alignment: "center",
+ logo_height: 1.1,
+ logo_position: "center",
+ logo_url: "logo_url",
+ social_buttons_layout: "bottom"
+ }
});
-while (page.hasNextPage()) {
- page = page.getNextPage();
-}
-// You can also access the underlying response
-const response = page.response;
```
-
@@ -13053,101 +11470,36 @@ const response = page.response;
-
-**id:** `string` — ID of the client grant
-
-
-
-
-
--
-
-**request:** `Management.ListClientGrantOrganizationsRequestParameters`
-
-
-
-
-
--
-
-**requestOptions:** `Organizations.RequestOptions`
-
-
-
-
-
-
+**themeId:** `string` — The ID of the theme
+
-
-
-## Clients Credentials
-
-client.clients.credentials.list(clientId) -> Management.ClientCredential[]
-
--
-
-#### 📝 Description
-
-
--
-
-Get the details of a client credential.
-
-Important: To enable credentials to be used for a client authentication method, set the
client_authentication_methods property on the client. To enable credentials to be used for JWT-Secured Authorization requests set the signed_request_object property on the client.
-
+**request:** `Management.UpdateBrandingThemeRequestContent`
+
-
-
-
-#### 🔌 Usage
-
-
--
-
-```typescript
-await client.clients.credentials.list("client_id");
-```
-
-
-
+**requestOptions:** `ThemesClient.RequestOptions`
+
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**clientId:** `string` — ID of the client.
-
-
--
-
-**requestOptions:** `Credentials.RequestOptions`
-
-
-
-
-
-client.clients.credentials.create(clientId, { ...params }) -> Management.PostClientCredentialResponseContent
+## Branding Phone Providers
+client.branding.phone.providers.list({ ...params }) -> Management.ListBrandingPhoneProvidersResponseContent
-
@@ -13159,41 +11511,7 @@ await client.clients.credentials.list("client_id");
-
-Create a client credential associated to your application. Credentials can be used to configure Private Key JWT and mTLS authentication methods, as well as for JWT-secured Authorization requests.
-
-
Public Key
Public Key credentials can be used to set up Private Key JWT client authentication and JWT-secured Authorization requests.
-
-Sample: {
-"credential_type": "public_key",
-"name": "string",
-"pem": "string",
-"alg": "RS256",
-"parse_expiry_from_cert": false,
-"expires_at": "2022-12-31T23:59:59Z"
-}
-
-Certificate (CA-signed & self-signed)
Certificate credentials can be used to set up mTLS client authentication. CA-signed certificates can be configured either with a signed certificate or with just the certificate Subject DN.
-
-CA-signed Certificate Sample (pem): {
-"credential_type": "x509_cert",
-"name": "string",
-"pem": "string"
-}
CA-signed Certificate Sample (subject_dn): {
-"credential_type": "cert_subject_dn",
-"name": "string",
-"subject_dn": "string"
-}
Self-signed Certificate Sample: {
-"credential_type": "cert_subject_dn",
-"name": "string",
-"pem": "string"
-}
-
-The credential will be created but not yet enabled for use until you set the corresponding properties in the client:
-
-
- - To enable the credential for Private Key JWT or mTLS authentication methods, set the
client_authentication_methods property on the client. For more information, read Configure Private Key JWT Authentication and Configure mTLS Authentication
- - To enable the credential for JWT-secured Authorization requests, set the
signed_request_objectproperty on the client. For more information, read Configure JWT-secured Authorization Requests (JAR)
-
+Retrieve a list of phone providers details set for a Tenant. A list of fields to include or exclude may also be specified.
@@ -13208,125 +11526,45 @@ The credential will be created but not yet enabled for use until you set the cor
-
```typescript
-await client.clients.credentials.create("client_id", {
- credential_type: "public_key",
+await client.branding.phone.providers.list({
+ disabled: true
});
-```
-
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**clientId:** `string` — ID of the client.
-
-
-
-
-
--
-
-**request:** `Management.PostClientCredentialRequestContent`
-
-
-
-
-
--
-
-**requestOptions:** `Credentials.RequestOptions`
-
-
-
-
-
-
-
-
-
-
-client.clients.credentials.get(clientId, credentialId) -> Management.GetClientCredentialResponseContent
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Get the details of a client credential.
-
-Important: To enable credentials to be used for a client authentication method, set the
client_authentication_methods property on the client. To enable credentials to be used for JWT-Secured Authorization requests set the signed_request_object property on the client.
-
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-```typescript
-await client.clients.credentials.get("client_id", "credential_id");
```
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**clientId:** `string` — ID of the client.
-
-
-
+#### ⚙️ Parameters
-
-**credentialId:** `string` — ID of the credential.
+
+-
+**request:** `Management.ListBrandingPhoneProvidersRequestParameters`
+
-
-**requestOptions:** `Credentials.RequestOptions`
-
+**requestOptions:** `ProvidersClient.RequestOptions`
+
+
-client.clients.credentials.delete(clientId, credentialId) -> void
+client.branding.phone.providers.create({ ...params }) -> Management.CreateBrandingPhoneProviderResponseContent
-
@@ -13338,8 +11576,8 @@ await client.clients.credentials.get("client_id", "credential_id");
-
-Delete a client credential you previously created. May be enabled or disabled. For more information, read Client Credential Flow.
-
+Create a phone provider.
+The
credentials object requires different properties depending on the phone provider (which is specified using the name property).
@@ -13354,9 +11592,14 @@ Delete a client credential you previously created. May be enabled or disabled. F
-
```typescript
-await client.clients.credentials.delete("client_id", "credential_id");
-```
+await client.branding.phone.providers.create({
+ name: "twilio",
+ credentials: {
+ auth_token: "auth_token"
+ }
+});
+```
@@ -13370,34 +11613,27 @@ await client.clients.credentials.delete("client_id", "credential_id");
-
-**clientId:** `string` — ID of the client.
-
-
-
-
-
--
-
-**credentialId:** `string` — ID of the credential to delete.
-
+**request:** `Management.CreateBrandingPhoneProviderRequestContent`
+
-
-**requestOptions:** `Credentials.RequestOptions`
-
+**requestOptions:** `ProvidersClient.RequestOptions`
+
+
-client.clients.credentials.update(clientId, credentialId, { ...params }) -> Management.PatchClientCredentialResponseContent
+client.branding.phone.providers.get(id) -> Management.GetBrandingPhoneProviderResponseContent
-
@@ -13409,8 +11645,7 @@ await client.clients.credentials.delete("client_id", "credential_id");
-
-Change a client credential you previously created. May be enabled or disabled. For more information, read Client Credential Flow.
-
+Retrieve phone provider details. A list of fields to include or exclude may also be specified.
@@ -13425,9 +11660,9 @@ Change a client credential you previously created. May be enabled or disabled. F
-
```typescript
-await client.clients.credentials.update("client_id", "credential_id");
-```
+await client.branding.phone.providers.get("id");
+```
@@ -13441,44 +11676,27 @@ await client.clients.credentials.update("client_id", "credential_id");
-
-**clientId:** `string` — ID of the client.
-
+**id:** `string`
+
-
-**credentialId:** `string` — ID of the credential.
-
+**requestOptions:** `ProvidersClient.RequestOptions`
+
-
-
--
-
-**request:** `Management.PatchClientCredentialRequestContent`
-
-
--
-
-**requestOptions:** `Credentials.RequestOptions`
-
-
-
-
-
-## Clients Connections
-
-client.clients.connections.get(id, { ...params }) -> core.Page
+client.branding.phone.providers.delete(id) -> void
-
@@ -13490,16 +11708,7 @@ await client.clients.credentials.update("client_id", "credential_id");
-
-Retrieve all connections that are enabled for the specified Application, using checkpoint pagination. A list of fields to include or exclude for each connection may also be specified.
-
-
- -
- This endpoint requires the
read:connections scope and any one of read:clients or read:client_summary.
-
- -
- Note: The first time you call this endpoint, 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 further results are remaining.
-
-
+Delete the configured phone provider.
@@ -13514,31 +11723,9 @@ Retrieve all connections that are enabled for the specified
@@ -13552,36 +11739,27 @@ const response = page.response;
-
-**id:** `string` — ID of the client for which to retrieve enabled connections.
-
-
-
-
-
--
-
-**request:** `Management.ConnectionsGetRequest`
-
+**id:** `string`
+
-
-**requestOptions:** `Connections.RequestOptions`
-
+**requestOptions:** `ProvidersClient.RequestOptions`
+
+
-## Connections Clients
-
-client.connections.clients.get(id, { ...params }) -> core.Page
+client.branding.phone.providers.update(id, { ...params }) -> Management.UpdateBrandingPhoneProviderResponseContent
-
@@ -13593,10 +11771,8 @@ const response = page.response;
-
-Retrieve all clients that have the specified connection enabled.
-
-Note: The first time you call this endpoint, 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 further results are remaining.
-
+Update a phone provider.
+The credentials object requires different properties depending on the phone provider (which is specified using the name property).
@@ -13611,27 +11787,9 @@ Retrieve all clients that have the specified
@@ -13645,34 +11803,35 @@ const response = page.response;
-
-**id:** `string` — The id of the connection for which enabled clients are to be retrieved
-
+**id:** `string`
+
-
-**request:** `Management.GetConnectionEnabledClientsRequestParameters`
-
+**request:** `Management.UpdateBrandingPhoneProviderRequestContent`
+
-
-**requestOptions:** `Clients.RequestOptions`
-
+**requestOptions:** `ProvidersClient.RequestOptions`
+
+
-client.connections.clients.update(id, { ...params }) -> void
+client.branding.phone.providers.test(id, { ...params }) -> Management.CreatePhoneProviderSendTestResponseContent
-
@@ -13685,14 +11844,11 @@ const response = page.response;
-
```typescript
-await client.connections.clients.update("id", [
- {
- client_id: "client_id",
- status: true,
- },
-]);
-```
+await client.branding.phone.providers.test("id", {
+ to: "to"
+});
+```
@@ -13706,54 +11862,39 @@ await client.connections.clients.update("id", [
-
-**id:** `string` — The id of the connection to modify
-
+**id:** `string`
+
-
-**request:** `Management.UpdateEnabledClientConnectionsRequestContent`
-
+**request:** `Management.CreatePhoneProviderSendTestRequestContent`
+
-
-**requestOptions:** `Clients.RequestOptions`
-
+**requestOptions:** `ProvidersClient.RequestOptions`
+
+
-## Connections Keys
-
-client.connections.keys.get(id) -> Management.ConnectionKey[]
-
--
-
-#### 📝 Description
-
-
--
-
+## Branding Phone Templates
+
client.branding.phone.templates.list({ ...params }) -> Management.ListPhoneTemplatesResponseContent
-
-Gets the connection keys for the Okta or OIDC connection strategy.
-
-
-
-
-
-
#### 🔌 Usage
@@ -13763,9 +11904,11 @@ Gets the connection keys for the Okta or OIDC connection strategy.
-
```typescript
-await client.connections.keys.get("id");
-```
+await client.branding.phone.templates.list({
+ disabled: true
+});
+```
@@ -13779,44 +11922,30 @@ await client.connections.keys.get("id");
-
-**id:** `string` — ID of the connection
-
+**request:** `Management.ListPhoneTemplatesRequestParameters`
+
-
-**requestOptions:** `Keys.RequestOptions`
-
+**requestOptions:** `TemplatesClient.RequestOptions`
+
+
-client.connections.keys.rotate(id, { ...params }) -> Management.RotateConnectionsKeysResponseContent
-
--
-
-#### 📝 Description
-
-
--
-
+
client.branding.phone.templates.create({ ...params }) -> Management.CreatePhoneTemplateResponseContent
-
-Rotates the connection keys for the Okta or OIDC connection strategies.
-
-
-
-
-
-
#### 🔌 Usage
@@ -13826,9 +11955,9 @@ Rotates the connection keys for the Okta or OIDC connection strategies.
-
```typescript
-await client.connections.keys.rotate("id");
-```
+await client.branding.phone.templates.create();
+```
@@ -13842,40 +11971,31 @@ await client.connections.keys.rotate("id");
-
-**id:** `string` — ID of the connection
-
-
-
-
-
--
-
-**request:** `Management.RotateConnectionKeysRequestContent | null`
-
+**request:** `Management.CreatePhoneTemplateRequestContent`
+
-
-**requestOptions:** `Keys.RequestOptions`
-
+**requestOptions:** `TemplatesClient.RequestOptions`
+
+
-## Connections ScimConfiguration
-
-client.connections.scimConfiguration.get(id) -> Management.GetScimConfigurationResponseContent
+client.branding.phone.templates.get(id) -> Management.GetPhoneTemplateResponseContent
-
-#### 📝 Description
+#### 🔌 Usage
-
@@ -13883,14 +12003,16 @@ await client.connections.keys.rotate("id");
-
-Retrieves a scim configuration by its
connectionId.
+```typescript
+await client.branding.phone.templates.get("id");
+```
-#### 🔌 Usage
+#### ⚙️ Parameters
-
@@ -13898,60 +12020,78 @@ Retrieves a scim configuration by its
connectionId.
-
-```typescript
-await client.connections.scimConfiguration.get("id");
-```
+**id:** `string`
+
+
+
+
+-
+
+**requestOptions:** `TemplatesClient.RequestOptions`
+
-#### ⚙️ Parameters
-
--
+
+
+
+client.branding.phone.templates.delete(id) -> void
-
-**id:** `string` — The id of the connection to retrieve its SCIM configuration
+#### 🔌 Usage
-
-
+
+-
-
-**requestOptions:** `ScimConfiguration.RequestOptions`
+```typescript
+await client.branding.phone.templates.delete("id");
+```
-
-
-
+#### ⚙️ Parameters
-client.connections.scimConfiguration.create(id, { ...params }) -> Management.CreateScimConfigurationResponseContent
-
-#### 📝 Description
-
-
+**id:** `string`
+
+
+
+
-
-Create a scim configuration for a connection.
-
+**requestOptions:** `TemplatesClient.RequestOptions`
+
+
+
+
+
+
+
+client.branding.phone.templates.update(id, { ...params }) -> Management.UpdatePhoneTemplateResponseContent
+
+-
#### 🔌 Usage
@@ -13962,9 +12102,9 @@ Create a scim configuration for a connection.
-
```typescript
-await client.connections.scimConfiguration.create("id");
-```
+await client.branding.phone.templates.update("id");
+```
@@ -13978,38 +12118,39 @@ await client.connections.scimConfiguration.create("id");
-
-**id:** `string` — The id of the connection to create its SCIM configuration
-
+**id:** `string`
+
-
-**request:** `Management.CreateScimConfigurationRequestContent | null`
-
+**request:** `Management.UpdatePhoneTemplateRequestContent`
+
-
-**requestOptions:** `ScimConfiguration.RequestOptions`
-
+**requestOptions:** `TemplatesClient.RequestOptions`
+
+
-client.connections.scimConfiguration.delete(id) -> void
+client.branding.phone.templates.reset(id, { ...params }) -> Management.ResetPhoneTemplateResponseContent
-
-#### 📝 Description
+#### 🔌 Usage
-
@@ -14017,14 +12158,18 @@ await client.connections.scimConfiguration.create("id");
-
-Deletes a scim configuration by its
connectionId.
+```typescript
+await client.branding.phone.templates.reset("id", {
+ "key": "value"
+});
+```
-#### 🔌 Usage
+#### ⚙️ Parameters
-
@@ -14032,61 +12177,38 @@ Deletes a scim configuration by its
connectionId.
-
-```typescript
-await client.connections.scimConfiguration.delete("id");
-```
-
+**id:** `string`
+
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-**id:** `string` — The id of the connection to delete its SCIM configuration
-
+**request:** `Management.ResetPhoneTemplateRequestContent`
+
-
-**requestOptions:** `ScimConfiguration.RequestOptions`
-
+**requestOptions:** `TemplatesClient.RequestOptions`
+
+
-client.connections.scimConfiguration.update(id, { ...params }) -> Management.UpdateScimConfigurationResponseContent
-
--
-
-#### 📝 Description
-
-
--
-
+
client.branding.phone.templates.test(id, { ...params }) -> Management.CreatePhoneTemplateTestNotificationResponseContent
-
-Update a scim configuration by its
connectionId.
-
-
-
-
-
-
#### 🔌 Usage
@@ -14096,12 +12218,11 @@ Update a scim configuration by its connectionId.
-
```typescript
-await client.connections.scimConfiguration.update("id", {
- user_id_attribute: "user_id_attribute",
- mapping: [{}],
+await client.branding.phone.templates.test("id", {
+ to: "to"
});
-```
+```
@@ -14115,38 +12236,40 @@ await client.connections.scimConfiguration.update("id", {
-
-**id:** `string` — The id of the connection to update its SCIM configuration
-
+**id:** `string`
+
-
-**request:** `Management.UpdateScimConfigurationRequestContent`
-
+**request:** `Management.CreatePhoneTemplateTestNotificationRequestContent`
+
-
-**requestOptions:** `ScimConfiguration.RequestOptions`
-
+**requestOptions:** `TemplatesClient.RequestOptions`
+
+
-client.connections.scimConfiguration.getDefaultMapping(id) -> Management.GetScimConfigurationDefaultMappingResponseContent
+## ClientGrants Organizations
+client.clientGrants.organizations.list(id, { ...params }) -> core.Page
-
-#### 📝 Description
+#### 🔌 Usage
-
@@ -14154,14 +12277,34 @@ await client.connections.scimConfiguration.update("id", {
-
-Retrieves a scim configuration's default mapping by its
connectionId.
+```typescript
+const pageableResponse = await client.clientGrants.organizations.list("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.clientGrants.organizations.list("id", {
+ from: "from",
+ take: 1
+});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
+```
-#### 🔌 Usage
+#### ⚙️ Parameters
-
@@ -14169,45 +12312,36 @@ Retrieves a scim configuration's default mapping by its
connectionId
-
-```typescript
-await client.connections.scimConfiguration.getDefaultMapping("id");
-```
-
-
-
+**id:** `string` — ID of the client grant
+
-#### ⚙️ Parameters
-
-
--
-
-
-**id:** `string` — The id of the connection to retrieve its default SCIM mapping
-
+**request:** `Management.ListClientGrantOrganizationsRequestParameters`
+
-
-**requestOptions:** `ScimConfiguration.RequestOptions`
-
+**requestOptions:** `OrganizationsClient.RequestOptions`
+
+
-## Connections Users
-
-client.connections.users.deleteByEmail(id, { ...params }) -> void
+## Clients Credentials
+client.clients.credentials.list(client_id) -> Management.ClientCredential[]
-
@@ -14219,8 +12353,9 @@ await client.connections.scimConfiguration.getDefaultMapping("id");
-
-Deletes a specified connection user by its email (you cannot delete all users from specific connection). Currently, only Database Connections are supported.
+Get the details of a client credential.
+Important: To enable credentials to be used for a client authentication method, set the
client_authentication_methods property on the client. To enable credentials to be used for JWT-Secured Authorization requests set the signed_request_object property on the client.
@@ -14235,11 +12370,9 @@ Deletes a specified connection user by its email (you cannot delete all users fr
-
```typescript
-await client.connections.users.deleteByEmail("id", {
- email: "email",
-});
-```
+await client.clients.credentials.list("client_id");
+```
@@ -14253,36 +12386,27 @@ await client.connections.users.deleteByEmail("id", {
-
-**id:** `string` — The id of the connection (currently only database connections are supported)
-
-
-
-
-
--
-
-**request:** `Management.DeleteConnectionUsersByEmailQueryParameters`
-
+**client_id:** `string` — ID of the client.
+
-
-**requestOptions:** `Users.RequestOptions`
-
+**requestOptions:** `CredentialsClient.RequestOptions`
+
+
-## Connections ScimConfiguration Tokens
-
-client.connections.scimConfiguration.tokens.get(id) -> Management.GetScimTokensResponseContent
+client.clients.credentials.create(client_id, { ...params }) -> Management.PostClientCredentialResponseContent
-
@@ -14294,8 +12418,39 @@ await client.connections.users.deleteByEmail("id", {
-
-Retrieves all scim tokens by its connection
id.
+Create a client credential associated to your application. Credentials can be used to configure Private Key JWT and mTLS authentication methods, as well as for JWT-secured Authorization requests.
+
+Public Key
Public Key credentials can be used to set up Private Key JWT client authentication and JWT-secured Authorization requests.
+
+Sample: {
+ "credential_type": "public_key",
+ "name": "string",
+ "pem": "string",
+ "alg": "RS256",
+ "parse_expiry_from_cert": false,
+ "expires_at": "2022-12-31T23:59:59Z"
+}
+Certificate (CA-signed & self-signed)
Certificate credentials can be used to set up mTLS client authentication. CA-signed certificates can be configured either with a signed certificate or with just the certificate Subject DN.
+
+CA-signed Certificate Sample (pem): {
+ "credential_type": "x509_cert",
+ "name": "string",
+ "pem": "string"
+}
CA-signed Certificate Sample (subject_dn): {
+ "credential_type": "cert_subject_dn",
+ "name": "string",
+ "subject_dn": "string"
+}
Self-signed Certificate Sample: {
+ "credential_type": "cert_subject_dn",
+ "name": "string",
+ "pem": "string"
+}
+The credential will be created but not yet enabled for use until you set the corresponding properties in the client:
+
+ - To enable the credential for Private Key JWT or mTLS authentication methods, set the
client_authentication_methods property on the client. For more information, read Configure Private Key JWT Authentication and Configure mTLS Authentication
+ - To enable the credential for JWT-secured Authorization requests, set the
signed_request_objectproperty on the client. For more information, read Configure JWT-secured Authorization Requests (JAR)
+
@@ -14310,9 +12465,11 @@ Retrieves all scim tokens by its connection id.
-
```typescript
-await client.connections.scimConfiguration.tokens.get("id");
-```
+await client.clients.credentials.create("client_id", {
+ credential_type: "public_key"
+});
+```
@@ -14326,26 +12483,35 @@ await client.connections.scimConfiguration.tokens.get("id");
-
-**id:** `string` — The id of the connection to retrieve its SCIM configuration
-
+**client_id:** `string` — ID of the client.
+
-
-**requestOptions:** `Tokens.RequestOptions`
+**request:** `Management.PostClientCredentialRequestContent`
+
+
+
+
+
+-
+**requestOptions:** `CredentialsClient.RequestOptions`
+
+
-client.connections.scimConfiguration.tokens.create(id, { ...params }) -> Management.CreateScimTokenResponseContent
+client.clients.credentials.get(client_id, credential_id) -> Management.GetClientCredentialResponseContent
-
@@ -14357,8 +12523,9 @@ await client.connections.scimConfiguration.tokens.get("id");
-
-Create a scim token for a scim client.
+Get the details of a client credential.
+Important: To enable credentials to be used for a client authentication method, set the
client_authentication_methods property on the client. To enable credentials to be used for JWT-Secured Authorization requests set the signed_request_object property on the client.
@@ -14373,9 +12540,9 @@ Create a scim token for a scim client.
-
```typescript
-await client.connections.scimConfiguration.tokens.create("id");
-```
+await client.clients.credentials.get("client_id", "credential_id");
+```
@@ -14389,34 +12556,35 @@ await client.connections.scimConfiguration.tokens.create("id");
-
-**id:** `string` — The id of the connection to create its SCIM token
-
+**client_id:** `string` — ID of the client.
+
-
-**request:** `Management.CreateScimTokenRequestContent`
-
+**credential_id:** `string` — ID of the credential.
+
-
-**requestOptions:** `Tokens.RequestOptions`
-
+**requestOptions:** `CredentialsClient.RequestOptions`
+
+
-client.connections.scimConfiguration.tokens.delete(id, tokenId) -> void
+client.clients.credentials.delete(client_id, credential_id) -> void
-
@@ -14428,8 +12596,7 @@ await client.connections.scimConfiguration.tokens.create("id");
-
-Deletes a scim token by its connection
id and tokenId.
-
+Delete a client credential you previously created. May be enabled or disabled. For more information, read Client Credential Flow.
@@ -14444,9 +12611,9 @@ Deletes a scim token by its connection id and tokenId.
-
```typescript
-await client.connections.scimConfiguration.tokens.delete("id", "tokenId");
-```
+await client.clients.credentials.delete("client_id", "credential_id");
+```
@@ -14460,36 +12627,35 @@ await client.connections.scimConfiguration.tokens.delete("id", "tokenId");
-
-**id:** `string` — The connection id that owns the SCIM token to delete
-
+**client_id:** `string` — ID of the client.
+
-
-**tokenId:** `string` — The id of the scim token to delete
-
+**credential_id:** `string` — ID of the credential to delete.
+
-
-**requestOptions:** `Tokens.RequestOptions`
-
+**requestOptions:** `CredentialsClient.RequestOptions`
+
+
-## Emails Provider
-
-client.emails.provider.get({ ...params }) -> Management.GetEmailProviderResponseContent
+client.clients.credentials.update(client_id, credential_id, { ...params }) -> Management.PatchClientCredentialResponseContent
-
@@ -14501,8 +12667,7 @@ await client.connections.scimConfiguration.tokens.delete("id", "tokenId");
-
-Retrieve details of the email provider configuration in your tenant. A list of fields to include or exclude may also be specified.
-
+Change a client credential you previously created. May be enabled or disabled. For more information, read Client Credential Flow.
@@ -14517,12 +12682,9 @@ Retrieve details of the
@@ -14536,26 +12698,44 @@ await client.emails.provider.get({
-
-**request:** `Management.GetEmailProviderRequestParameters`
+**client_id:** `string` — ID of the client.
+
+
+
+
+
+-
+**credential_id:** `string` — ID of the credential.
+
-
-**requestOptions:** `Provider.RequestOptions`
+**request:** `Management.PatchClientCredentialRequestContent`
+
+
+
+
+
+-
+**requestOptions:** `CredentialsClient.RequestOptions`
+
+
-client.emails.provider.create({ ...params }) -> Management.CreateEmailProviderResponseContent
+## Clients Connections
+client.clients.connections.get(id, { ...params }) -> core.Page
-
@@ -14563,51 +12743,17 @@ await client.emails.provider.get({
-
-
-
--
-
-Create an email provider. The
credentials object
-requires different properties depending on the email provider (which is specified using the name property):
-
-
- mandrill requires api_keysendgrid requires api_key-
-
sparkpost requires api_key. Optionally, set region to eu to use
- the SparkPost service hosted in Western Europe; set to null to use the SparkPost service hosted in
- North America. eu or null are the only valid values for region.
-
- -
-
mailgun requires api_key and domain. Optionally, set region to
- eu to use the Mailgun service hosted in Europe; set to null otherwise. eu or
- null are the only valid values for region.
-
- ses requires accessKeyId, secretAccessKey, and region-
-
smtp requires smtp_host, smtp_port, smtp_user, and
- smtp_pass
-
-
-Depending on the type of provider it is possible to specify settings object with different configuration
-options, which will be used when sending an email:
+
+
+-
+
+Retrieve all connections that are enabled for the specified Application, using checkpoint pagination. A list of fields to include or exclude for each connection may also be specified.
-
-
smtp provider, settings may contain headers object.
-
- -
- When using AWS SES SMTP host, you may provide a name of configuration set in
-
X-SES-Configuration-Set header. Value must be a string.
-
- -
- When using Sparkpost host, you may provide value for
-
X-MSYS_API header. Value must be an object.
-
-
+ This endpoint requires the read:connections scope and any one of read:clients or read:client_summary.
-
- for
ses provider, settings may contain message object, where you can provide
- a name of configuration set in configuration_set_name property. Value must be a string.
+ Note: The first time you call this endpoint, 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 further results are remaining.
@@ -14624,14 +12770,31 @@ options, which will be used when sending an email:
-
```typescript
-await client.emails.provider.create({
- name: "mailgun",
- credentials: {
- api_key: "api_key",
- },
+const pageableResponse = await client.clients.connections.get("id", {
+ from: "from",
+ take: 1,
+ fields: "fields",
+ include_fields: true
});
-```
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+// Or you can manually iterate page-by-page
+let page = await client.clients.connections.get("id", {
+ from: "from",
+ take: 1,
+ fields: "fields",
+ include_fields: true
+});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
+
+```
@@ -14645,26 +12808,36 @@ await client.emails.provider.create({
-
-**request:** `Management.CreateEmailProviderRequestContent`
-
+**id:** `string` — ID of the client for which to retrieve enabled connections.
+
-
-**requestOptions:** `Provider.RequestOptions`
+**request:** `Management.ConnectionsGetRequest`
+
+
+
+
+
+-
+**requestOptions:** `ConnectionsClient.RequestOptions`
+
+
-client.emails.provider.delete() -> void
+## Connections Clients
+client.connections.clients.get(id, { ...params }) -> core.Page
-
@@ -14676,8 +12849,9 @@ await client.emails.provider.create({
-
-Delete the email provider.
+Retrieve all clients that have the specified connection enabled.
+Note: The first time you call this endpoint, 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 further results are remaining.
@@ -14692,9 +12866,27 @@ Delete the email provider.
-
```typescript
-await client.emails.provider.delete();
-```
+const pageableResponse = await client.connections.clients.get("id", {
+ take: 1,
+ from: "from"
+});
+for await (const item of pageableResponse) {
+ console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.connections.clients.get("id", {
+ take: 1,
+ from: "from"
+});
+while (page.hasNextPage()) {
+ page = page.getNextPage();
+}
+// You can also access the underlying response
+const response = page.response;
+
+```
@@ -14708,75 +12900,38 @@ await client.emails.provider.delete();
-
-**requestOptions:** `Provider.RequestOptions`
-
-
-
-
-
-
+**id:** `string` — The id of the connection for which enabled clients are to be retrieved
+
-
-client.emails.provider.update({ ...params }) -> Management.UpdateEmailProviderResponseContent
-
-#### 📝 Description
-
-
--
+**request:** `Management.GetConnectionEnabledClientsRequestParameters`
+
+
+
-
-Update an email provider. The
credentials object
-requires different properties depending on the email provider (which is specified using the name property):
-
-
- mandrill requires api_keysendgrid requires api_key-
-
sparkpost requires api_key. Optionally, set region to eu to use
- the SparkPost service hosted in Western Europe; set to null to use the SparkPost service hosted in
- North America. eu or null are the only valid values for region.
-
- -
-
mailgun requires api_key and domain. Optionally, set region to
- eu to use the Mailgun service hosted in Europe; set to null otherwise. eu or
- null are the only valid values for region.
-
- ses requires accessKeyId, secretAccessKey, and region-
-
smtp requires smtp_host, smtp_port, smtp_user, and
- smtp_pass
-
-
-Depending on the type of provider it is possible to specify settings object with different configuration
-options, which will be used when sending an email:
-
- -
-
smtp provider, settings may contain headers object.
-
- -
- When using AWS SES SMTP host, you may provide a name of configuration set in
-
X-SES-Configuration-Set header. Value must be a string.
-
- -
- When using Sparkpost host, you may provide value for
-
X-MSYS_API header. Value must be an object.
-
-
- for ses provider, settings may contain message object, where you can provide
- a name of configuration set in configuration_set_name property. Value must be a string.
-
-
+**requestOptions:** `ClientsClient.RequestOptions`
+
+
+
+
+
+
+client.connections.clients.update(id, { ...params }) -> void
+
+-
+
#### 🔌 Usage
@@ -14786,9 +12941,12 @@ options, which will be used when sending an email:
-
```typescript
-await client.emails.provider.update();
-```
+await client.connections.clients.update("id", [{
+ client_id: "client_id",
+ status: true
+ }]);
+```
@@ -14802,32 +12960,40 @@ await client.emails.provider.update();
-
-**request:** `Management.UpdateEmailProviderRequestContent`
-
+**id:** `string` — The id of the connection to modify
+
-
-**requestOptions:** `Provider.RequestOptions`
+**request:** `Management.UpdateEnabledClientConnectionsRequestContent`
+
+
+
+
+
+-
+**requestOptions:** `ClientsClient.RequestOptions`
+
+
-## EventStreams Deliveries
-
-client.eventStreams.deliveries.list(id, { ...params }) -> Management.EventStreamDelivery[]
+## Connections Keys
+client.connections.keys.get(id) -> Management.ConnectionKey[]
-
-#### 🔌 Usage
+#### 📝 Description
-
@@ -14835,23 +13001,13 @@ await client.emails.provider.update();
-
-```typescript
-await client.eventStreams.deliveries.list("id", {
- statuses: "statuses",
- event_types: "event_types",
- date_from: "date_from",
- date_to: "date_to",
- from: "from",
- take: 1,
-});
-```
-
+Gets the connection keys for the Okta or OIDC connection strategy.
-#### ⚙️ Parameters
+#### 🔌 Usage
-
@@ -14859,37 +13015,61 @@ await client.eventStreams.deliveries.list("id", {
-
-**id:** `string` — Unique identifier for the event stream.
+```typescript
+await client.connections.keys.get("id");
+```
+
+
+#### ⚙️ Parameters
+
-
-**request:** `Management.ListEventStreamDeliveriesRequestParameters`
+
+-
+**id:** `string` — ID of the connection
+
-
-**requestOptions:** `Deliveries.RequestOptions`
-
+**requestOptions:** `KeysClient.RequestOptions`
+
+
-client.eventStreams.deliveries.getHistory(id, eventId) -> Management.GetEventStreamDeliveryHistoryResponseContent
+client.connections.keys.rotate(id, { ...params }) -> Management.RotateConnectionsKeysResponseContent
+
+-
+
+#### 📝 Description
+
+
+-
+
-
+Rotates the connection keys for the Okta or OIDC connection strategies.
+
+
+
+
+
#### 🔌 Usage
@@ -14899,9 +13079,9 @@ await client.eventStreams.deliveries.list("id", {
-
```typescript
-await client.eventStreams.deliveries.getHistory("id", "event_id");
-```
+await client.connections.keys.rotate("id");
+```
@@ -14915,39 +13095,53 @@ await client.eventStreams.deliveries.getHistory("id", "event_id");
-
-**id:** `string` — Unique identifier for the event stream.
-
+**id:** `string` — ID of the connection
+
-
-**eventId:** `string` — Unique identifier for the event
-
+**request:** `Management.RotateConnectionKeysRequestContent | null`
+
-
-**requestOptions:** `Deliveries.RequestOptions`
-
+**requestOptions:** `KeysClient.RequestOptions`
+
+
-## EventStreams Redeliveries
+## Connections ScimConfiguration
+client.connections.scimConfiguration.get(id) -> Management.GetScimConfigurationResponseContent
+
+-
+
+#### 📝 Description
-
client.eventStreams.redeliveries.create(id, { ...params }) -> Management.CreateEventStreamRedeliveryResponseContent
-
+
+-
+
+Retrieves a scim configuration by its
connectionId.
+
+
+
+
+
#### 🔌 Usage
@@ -14957,9 +13151,9 @@ await client.eventStreams.deliveries.getHistory("id", "event_id");
-
```typescript
-await client.eventStreams.redeliveries.create("id");
-```
+await client.connections.scimConfiguration.get("id");
+```
@@ -14973,37 +13167,44 @@ await client.eventStreams.redeliveries.create("id");
-
-**id:** `string` — Unique identifier for the event stream.
-
+**id:** `string` — The id of the connection to retrieve its SCIM configuration
+
-
-**request:** `Management.CreateEventStreamRedeliveryRequestContent`
+**requestOptions:** `ScimConfigurationClient.RequestOptions`
+
+
+
+
+
+
+
+
+client.connections.scimConfiguration.create(id, { ...params }) -> Management.CreateScimConfigurationResponseContent
+
+-
+
+#### 📝 Description
-
-**requestOptions:** `Redeliveries.RequestOptions`
+
+-
+Create a scim configuration for a connection.
-
-
-
-
-client.eventStreams.redeliveries.createById(id, eventId) -> void
-
--
-
#### 🔌 Usage
@@ -15013,9 +13214,9 @@ await client.eventStreams.redeliveries.create("id");
-
```typescript
-await client.eventStreams.redeliveries.createById("id", "event_id");
-```
+await client.connections.scimConfiguration.create("id");
+```
@@ -15029,40 +13230,39 @@ await client.eventStreams.redeliveries.createById("id", "event_id");
-
-**id:** `string` — Unique identifier for the event stream.
-
+**id:** `string` — The id of the connection to create its SCIM configuration
+
-
-**eventId:** `string` — Unique identifier for the event
-
+**request:** `Management.CreateScimConfigurationRequestContent | null`
+
-
-**requestOptions:** `Redeliveries.RequestOptions`
-
+**requestOptions:** `ScimConfigurationClient.RequestOptions`
+
+
-## Flows Executions
-
-client.flows.executions.list(flowId, { ...params }) -> core.Page
+client.connections.scimConfiguration.delete(id) -> void
-
-#### 🔌 Usage
+#### 📝 Description
-
@@ -15070,34 +13270,13 @@ await client.eventStreams.redeliveries.createById("id", "event_id");
-
-```typescript
-const pageableResponse = await client.flows.executions.list("flow_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.flows.executions.list("flow_id", {
- from: "from",
- take: 1,
-});
-while (page.hasNextPage()) {
- page = page.getNextPage();
-}
-
-// You can also access the underlying response
-const response = page.response;
-```
-
+Deletes a scim configuration by its
connectionId.
-#### ⚙️ Parameters
+#### 🔌 Usage
-
@@ -15105,38 +13284,48 @@ const response = page.response;
-
-**flowId:** `string` — Flow id
+```typescript
+await client.connections.scimConfiguration.delete("id");
+```
+
+
+#### ⚙️ Parameters
+
-
-**request:** `Management.ExecutionsListRequest`
+
+-
+**id:** `string` — The id of the connection to delete its SCIM configuration
+
-
-**requestOptions:** `Executions.RequestOptions`
-
+**requestOptions:** `ScimConfigurationClient.RequestOptions`
+
+
-client.flows.executions.get(flowId, executionId, { ...params }) -> Management.GetFlowExecutionResponseContent
+client.connections.scimConfiguration.update(id, { ...params }) -> Management.UpdateScimConfigurationResponseContent
-
-#### 🔌 Usage
+#### 📝 Description
-
@@ -15144,16 +13333,13 @@ const response = page.response;
-
-```typescript
-await client.flows.executions.get("flow_id", "execution_id");
-```
-
+Update a scim configuration by its
connectionId.
-#### ⚙️ Parameters
+#### 🔌 Usage
-
@@ -15161,46 +13347,59 @@ await client.flows.executions.get("flow_id", "execution_id");
-
-**flowId:** `string` — Flow id
+```typescript
+await client.connections.scimConfiguration.update("id", {
+ user_id_attribute: "user_id_attribute",
+ mapping: [{}]
+});
+```
+
+
+#### ⚙️ Parameters
+
-
-**executionId:** `string` — Flow execution id
+
+-
+**id:** `string` — The id of the connection to update its SCIM configuration
+
-
-**request:** `Management.ExecutionsGetRequest`
-
+**request:** `Management.UpdateScimConfigurationRequestContent`
+
-
-**requestOptions:** `Executions.RequestOptions`
-
+**requestOptions:** `ScimConfigurationClient.RequestOptions`
+
+
-client.flows.executions.delete(flowId, executionId) -> void
+client.connections.scimConfiguration.getDefaultMapping(id) -> Management.GetScimConfigurationDefaultMappingResponseContent
-
-#### 🔌 Usage
+#### 📝 Description
-
@@ -15208,16 +13407,13 @@ await client.flows.executions.get("flow_id", "execution_id");
-
-```typescript
-await client.flows.executions.delete("flow_id", "execution_id");
-```
-
+Retrieves a scim configuration's default mapping by its
connectionId.
-#### ⚙️ Parameters
+#### 🔌 Usage
-
@@ -15225,39 +13421,62 @@ await client.flows.executions.delete("flow_id", "execution_id");
-
-**flowId:** `string` — Flows id
+```typescript
+await client.connections.scimConfiguration.getDefaultMapping("id");
+```
+
+
+
+#### ⚙️ Parameters
-
-**executionId:** `string` — Flow execution identifier
+
+-
+**id:** `string` — The id of the connection to retrieve its default SCIM mapping
+
-
-**requestOptions:** `Executions.RequestOptions`
-
+**requestOptions:** `ScimConfigurationClient.RequestOptions`
+
+
-## Flows Vault Connections
+## Connections Users
+client.connections.users.deleteByEmail(id, { ...params }) -> void
+
+-
+
+#### 📝 Description
+
+
+-
-
client.flows.vault.connections.list({ ...params }) -> core.Page
-
+Deletes a specified connection user by its email (you cannot delete all users from specific connection). Currently, only Database Connections are supported.
+
+
+
+
+
#### 🔌 Usage
@@ -15267,29 +13486,11 @@ await client.flows.executions.delete("flow_id", "execution_id");
-
```typescript
-const pageableResponse = await client.flows.vault.connections.list({
- page: 1,
- per_page: 1,
- include_totals: true,
-});
-for await (const item of pageableResponse) {
- console.log(item);
-}
-
-// Or you can manually iterate page-by-page
-let page = await client.flows.vault.connections.list({
- page: 1,
- per_page: 1,
- include_totals: true,
+await client.connections.users.deleteByEmail("id", {
+ email: "email"
});
-while (page.hasNextPage()) {
- page = page.getNextPage();
-}
-// You can also access the underlying response
-const response = page.response;
```
-
@@ -15303,29 +13504,53 @@ const response = page.response;
-
-**request:** `Management.ListFlowsVaultConnectionsRequestParameters`
-
+**id:** `string` — The id of the connection (currently only database connections are supported)
+
-
-**requestOptions:** `Connections.RequestOptions`
+**request:** `Management.DeleteConnectionUsersByEmailQueryParameters`
+
+
+
+
+
+-
+**requestOptions:** `UsersClient.RequestOptions`
+
+
-client.flows.vault.connections.create({ ...params }) -> Management.CreateFlowsVaultConnectionResponseContent
+## Connections ScimConfiguration Tokens
+client.connections.scimConfiguration.tokens.get(id) -> Management.GetScimTokensResponseContent
+
+-
+
+#### 📝 Description
+
+
+-
+
-
+Retrieves all scim tokens by its connection
id.
+
+
+
+
+
#### 🔌 Usage
@@ -15335,17 +13560,9 @@ const response = page.response;
-
```typescript
-await client.flows.vault.connections.create({
- name: "name",
- app_id: "ACTIVECAMPAIGN",
- setup: {
- type: "API_KEY",
- api_key: "api_key",
- base_url: "base_url",
- },
-});
-```
+await client.connections.scimConfiguration.tokens.get("id");
+```
@@ -15359,30 +13576,31 @@ await client.flows.vault.connections.create({
-
-**request:** `Management.CreateFlowsVaultConnectionRequestContent`
-
+**id:** `string` — The id of the connection to retrieve its SCIM configuration
+
-
-**requestOptions:** `Connections.RequestOptions`
-
+**requestOptions:** `TokensClient.RequestOptions`
+
+
-client.flows.vault.connections.get(id) -> Management.GetFlowsVaultConnectionResponseContent
+client.connections.scimConfiguration.tokens.create(id, { ...params }) -> Management.CreateScimTokenResponseContent
-
-#### 🔌 Usage
+#### 📝 Description
-
@@ -15390,16 +13608,13 @@ await client.flows.vault.connections.create({
-
-```typescript
-await client.flows.vault.connections.get("id");
-```
-
+Create a scim token for a scim client.
-#### ⚙️ Parameters
+#### 🔌 Usage
-
@@ -15407,77 +13622,69 @@ await client.flows.vault.connections.get("id");
-
-**id:** `string` — Flows Vault connection ID
+```typescript
+await client.connections.scimConfiguration.tokens.create("id");
+```
+
+
+#### ⚙️ Parameters
+
-
-**requestOptions:** `Connections.RequestOptions`
-
-
-
-
-
+
+-
+**id:** `string` — The id of the connection to create its SCIM token
+
-
-client.flows.vault.connections.delete(id) -> void
-
-#### 🔌 Usage
-
-
--
+**request:** `Management.CreateScimTokenRequestContent`
+
+
+
-
-```typescript
-await client.flows.vault.connections.delete("id");
-```
-
+**requestOptions:** `TokensClient.RequestOptions`
+
-#### ⚙️ Parameters
-
--
+
+
+
+client.connections.scimConfiguration.tokens.delete(id, tokenId) -> void
-
-**id:** `string` — Vault connection id
-
-
-
+#### 📝 Description
-
-**requestOptions:** `Connections.RequestOptions`
+
+-
+Deletes a scim token by its connection
id and tokenId.
-
-
-
-
-client.flows.vault.connections.update(id, { ...params }) -> Management.UpdateFlowsVaultConnectionResponseContent
-
--
-
#### 🔌 Usage
@@ -15487,9 +13694,9 @@ await client.flows.vault.connections.delete("id");
-
```typescript
-await client.flows.vault.connections.update("id");
-```
+await client.connections.scimConfiguration.tokens.delete("id", "tokenId");
+```
@@ -15503,36 +13710,36 @@ await client.flows.vault.connections.update("id");
-
-**id:** `string` — Flows Vault connection ID
-
+**id:** `string` — The connection id that owns the SCIM token to delete
+
-
-**request:** `Management.UpdateFlowsVaultConnectionRequestContent`
-
+**tokenId:** `string` — The id of the scim token to delete
+
-
-**requestOptions:** `Connections.RequestOptions`
-
+**requestOptions:** `TokensClient.RequestOptions`
+
+
-## Guardian Enrollments
-
-client.guardian.enrollments.createTicket({ ...params }) -> Management.CreateGuardianEnrollmentTicketResponseContent
+## Emails Provider
+client.emails.provider.get({ ...params }) -> Management.GetEmailProviderResponseContent
-
@@ -15544,11 +13751,7 @@ await client.flows.vault.connections.update("id");
-
-Create a multi-factor authentication (MFA) enrollment ticket, and optionally send an email with the created ticket, to a given user.
-Create a multi-factor authentication (MFA) enrollment ticket, and optionally send an email with the created ticket to a given user. Enrollment tickets can specify which factor users must enroll with or allow existing MFA users to enroll in additional factors.
-
-Note: Users cannot enroll in Email as a factor through custom enrollment tickets.
-
+Retrieve details of the email provider configuration in your tenant. A list of fields to include or exclude may also be specified.
@@ -15563,11 +13766,12 @@ Note: Users cannot enroll in Email as a factor through custom enrollment tickets
-
```typescript
-await client.guardian.enrollments.createTicket({
- user_id: "user_id",
+await client.emails.provider.get({
+ fields: "fields",
+ include_fields: true
});
-```
+```
@@ -15581,26 +13785,27 @@ await client.guardian.enrollments.createTicket({
-
-**request:** `Management.CreateGuardianEnrollmentTicketRequestContent`
-
+**request:** `Management.GetEmailProviderRequestParameters`
+
-
-**requestOptions:** `Enrollments.RequestOptions`
-
+**requestOptions:** `ProviderClient.RequestOptions`
+
+
-client.guardian.enrollments.get(id) -> Management.GetGuardianEnrollmentResponseContent
+client.emails.provider.create({ ...params }) -> Management.CreateEmailProviderResponseContent
-
@@ -15612,8 +13817,48 @@ await client.guardian.enrollments.createTicket({
-
-Retrieve details, such as status and type, for a specific multi-factor authentication enrollment registered to a user account.
-
+Create an email provider. The
credentials object
+requires different properties depending on the email provider (which is specified using the name property):
+
+ mandrill requires api_keysendgrid requires api_key-
+
sparkpost requires api_key. Optionally, set region to eu to use
+ the SparkPost service hosted in Western Europe; set to null to use the SparkPost service hosted in
+ North America. eu or null are the only valid values for region.
+
+ -
+
mailgun requires api_key and domain. Optionally, set region to
+ eu to use the Mailgun service hosted in Europe; set to null otherwise. eu or
+ null are the only valid values for region.
+
+ ses requires accessKeyId, secretAccessKey, and region-
+
smtp requires smtp_host, smtp_port, smtp_user, and
+ smtp_pass
+
+
+Depending on the type of provider it is possible to specify settings object with different configuration
+options, which will be used when sending an email:
+
+ -
+
smtp provider, settings may contain headers object.
+
+ -
+ When using AWS SES SMTP host, you may provide a name of configuration set in
+
X-SES-Configuration-Set header. Value must be a string.
+
+ -
+ When using Sparkpost host, you may provide value for
+
X-MSYS_API header. Value must be an object.
+
+
+
+ -
+ for
ses provider, settings may contain message object, where you can provide
+ a name of configuration set in configuration_set_name property. Value must be a string.
+
+
@@ -15628,9 +13873,14 @@ Retrieve details, such as status and type, for a specific multi-factor authentic
-
```typescript
-await client.guardian.enrollments.get("id");
-```
+await client.emails.provider.create({
+ name: "mailgun",
+ credentials: {
+ api_key: "api_key"
+ }
+});
+```
@@ -15644,26 +13894,27 @@ await client.guardian.enrollments.get("id");
-
-**id:** `string` — ID of the enrollment to be retrieve.
-
+**request:** `Management.CreateEmailProviderRequestContent`
+
-
-**requestOptions:** `Enrollments.RequestOptions`
-
+**requestOptions:** `ProviderClient.RequestOptions`
+
+
-client.guardian.enrollments.delete(id) -> void
+client.emails.provider.delete() -> void
-
@@ -15675,8 +13926,7 @@ await client.guardian.enrollments.get("id");
-
-Remove a specific multi-factor authentication (MFA) enrollment from a user's account. This allows the user to re-enroll with MFA. For more information, review Reset User Multi-Factor Authentication and Recovery Codes.
-
+Delete the email provider.
@@ -15691,9 +13941,9 @@ Remove a specific multi-factor authentication (MFA) enrollment from a user's acc
-
```typescript
-await client.guardian.enrollments.delete("id");
-```
+await client.emails.provider.delete();
+```
@@ -15707,28 +13957,19 @@ await client.guardian.enrollments.delete("id");
-
-**id:** `string` — ID of the enrollment to be deleted.
-
-
-
-
-
--
-
-**requestOptions:** `Enrollments.RequestOptions`
-
+**requestOptions:** `ProviderClient.RequestOptions`
+
+
-## Guardian Factors
-
-client.guardian.factors.list() -> Management.GuardianFactor[]
+client.emails.provider.update({ ...params }) -> Management.UpdateEmailProviderResponseContent
-
@@ -15740,8 +13981,46 @@ await client.guardian.enrollments.delete("id");
-
-Retrieve details of all multi-factor authentication factors associated with your tenant.
-
+Update an email provider. The
credentials object
+requires different properties depending on the email provider (which is specified using the name property):
+
+ mandrill requires api_keysendgrid requires api_key-
+
sparkpost requires api_key. Optionally, set region to eu to use
+ the SparkPost service hosted in Western Europe; set to null to use the SparkPost service hosted in
+ North America. eu or null are the only valid values for region.
+
+ -
+
mailgun requires api_key and domain. Optionally, set region to
+ eu to use the Mailgun service hosted in Europe; set to null otherwise. eu or
+ null are the only valid values for region.
+
+ ses requires accessKeyId, secretAccessKey, and region-
+
smtp requires smtp_host, smtp_port, smtp_user, and
+ smtp_pass
+
+
+Depending on the type of provider it is possible to specify settings object with different configuration
+options, which will be used when sending an email:
+
+ -
+
smtp provider, settings may contain headers object.
+
+ -
+ When using AWS SES SMTP host, you may provide a name of configuration set in
+
X-SES-Configuration-Set header. Value must be a string.
+
+ -
+ When using Sparkpost host, you may provide value for
+
X-MSYS_API header. Value must be an object.
+
+
+ for ses provider, settings may contain message object, where you can provide
+ a name of configuration set in configuration_set_name property. Value must be a string.
+
+
@@ -15756,9 +14035,9 @@ Retrieve details of all set(name, { ...params }) -> Management.SetGuardianFactorResponseContent
-
--
-
-#### 📝 Description
-
-
--
-
+## EventStreams Deliveries
+
client.eventStreams.deliveries.list(id, { ...params }) -> Management.EventStreamDelivery[]
-
-Update the status (i.e., enabled or disabled) of a specific multi-factor authentication factor.
-
-
-
-
-
-
#### 🔌 Usage
@@ -15811,11 +14085,16 @@ Update the status (i.e., enabled or disabled) of a specific multi-factor authent
-
```typescript
-await client.guardian.factors.set("push-notification", {
- enabled: true,
+await client.eventStreams.deliveries.list("id", {
+ statuses: "statuses",
+ event_types: "event_types",
+ date_from: "date_from",
+ date_to: "date_to",
+ from: "from",
+ take: 1
});
-```
+```
@@ -15829,40 +14108,39 @@ await client.guardian.factors.set("push-notification", {
-
-**name:** `Management.GuardianFactorNameEnum` — Factor name. Can be `sms`, `push-notification`, `email`, `duo` `otp` `webauthn-roaming`, `webauthn-platform`, or `recovery-code`.
-
+**id:** `string` — Unique identifier for the event stream.
+
-
-**request:** `Management.SetGuardianFactorRequestContent`
-
+**request:** `Management.ListEventStreamDeliveriesRequestParameters`
+
-
-**requestOptions:** `Factors.RequestOptions`
-
+**requestOptions:** `DeliveriesClient.RequestOptions`
+
+
-## Guardian Policies
-
-client.guardian.policies.list() -> Management.ListGuardianPoliciesResponseContent
+client.eventStreams.deliveries.getHistory(id, event_id) -> Management.GetEventStreamDeliveryHistoryResponseContent
-
-#### 📝 Description
+#### 🔌 Usage
-
@@ -15870,23 +14148,16 @@ await client.guardian.factors.set("push-notification", {
-
-Retrieve the multi-factor authentication (MFA) policies configured for your tenant.
-
-The following policies are supported:
-
-
-all-applications policy prompts with MFA for all logins.confidence-score policy prompts with MFA only for low confidence logins.
-
-Note: The confidence-score policy is part of the Adaptive MFA feature. Adaptive MFA requires an add-on for the Enterprise plan; review Auth0 Pricing for more details.
+```typescript
+await client.eventStreams.deliveries.getHistory("id", "event_id");
+```
-#### 🔌 Usage
+#### ⚙️ Parameters
-
@@ -15894,39 +14165,40 @@ The following policies are supported:
-
-```typescript
-await client.guardian.policies.list();
-```
-
-
-
+**id:** `string` — Unique identifier for the event stream.
+
-#### ⚙️ Parameters
-
-
+**event_id:** `string` — Unique identifier for the event
+
+
+
+
-
-**requestOptions:** `Policies.RequestOptions`
-
+**requestOptions:** `DeliveriesClient.RequestOptions`
+
+
-client.guardian.policies.set({ ...params }) -> Management.SetGuardianPoliciesResponseContent
+## EventStreams Redeliveries
+client.eventStreams.redeliveries.create(id, { ...params }) -> Management.CreateEventStreamRedeliveryResponseContent
-
-#### 📝 Description
+#### 🔌 Usage
-
@@ -15934,23 +14206,16 @@ await client.guardian.policies.list();
-
-Set multi-factor authentication (MFA) policies for your tenant.
-
-The following policies are supported:
-
-
-all-applications policy prompts with MFA for all logins.confidence-score policy prompts with MFA only for low confidence logins.
-
-Note: The confidence-score policy is part of the Adaptive MFA feature. Adaptive MFA requires an add-on for the Enterprise plan; review Auth0 Pricing for more details.
+```typescript
+await client.eventStreams.redeliveries.create("id");
+```
-#### 🔌 Usage
+#### ⚙️ Parameters
-
@@ -15958,49 +14223,39 @@ The following policies are supported:
-
-```typescript
-await client.guardian.policies.set(["all-applications"]);
-```
-
-
-
+**id:** `string` — Unique identifier for the event stream.
+
-#### ⚙️ Parameters
-
-
--
-
-
-**request:** `Management.SetGuardianPoliciesRequestContent`
-
+**request:** `Management.CreateEventStreamRedeliveryRequestContent`
+
-
-**requestOptions:** `Policies.RequestOptions`
-
+**requestOptions:** `RedeliveriesClient.RequestOptions`
+
+
-## Guardian Factors Phone
-
-client.guardian.factors.phone.getMessageTypes() -> Management.GetGuardianFactorPhoneMessageTypesResponseContent
+client.eventStreams.redeliveries.createById(id, event_id) -> void
-
-#### 📝 Description
+#### 🔌 Usage
-
@@ -16008,14 +14263,16 @@ await client.guardian.policies.set(["all-applications"]);
-
-Retrieve list of phone-type MFA factors (i.e., sms and voice) that are enabled for your tenant.
+```typescript
+await client.eventStreams.redeliveries.createById("id", "event_id");
+```
-#### 🔌 Usage
+#### ⚙️ Parameters
-
@@ -16023,39 +14280,40 @@ Retrieve list of setMessageTypes({ ...params }) -> Management.SetGuardianFactorPhoneMessageTypesResponseContent
+## Flows Executions
+client.flows.executions.list(flow_id, { ...params }) -> core.Pageclient.guardian.factors.phone.getTwilioProvider() -> Management.GetGuardianFactorsProviderPhoneTwilioResponseContentclient.flows.executions.get(flow_id, execution_id, { ...params }) -> Management.GetFlowExecutionResponseContentclient.guardian.factors.phone.setTwilioProvider({ ...params }) -> Management.SetGuardianFactorsProviderPhoneTwilioResponseContentclient.flows.executions.delete(flow_id, execution_id) -> voidclient.guardian.factors.phone.getSelectedProvider() -> Management.GetGuardianFactorsProviderPhoneResponseContentclient.guardian.enrollments.createTicket({ ...params }) -> Management.CreateGuardianEnrollmentTicketResponseContentclient.guardian.factors.phone.setProvider({ ...params }) -> Management.SetGuardianFactorsProviderPhoneResponseContentclient.guardian.enrollments.get(id) -> Management.GetGuardianEnrollmentResponseContentclient.guardian.factors.phone.getTemplates() -> Management.GetGuardianFactorPhoneTemplatesResponseContentclient.guardian.enrollments.delete(id) -> voidclient.guardian.factors.phone.setTemplates({ ...params }) -> Management.SetGuardianFactorPhoneTemplatesResponseContentclient.guardian.factors.list() -> Management.GuardianFactor[]client.guardian.factors.pushNotification.getApnsProvider() -> Management.GetGuardianFactorsProviderApnsResponseContentclient.guardian.factors.set(name, { ...params }) -> Management.SetGuardianFactorResponseContentclient.guardian.factors.pushNotification.setApnsProvider({ ...params }) -> Management.SetGuardianFactorsProviderPushNotificationApnsResponseContentclient.guardian.policies.list() -> Management.ListGuardianPoliciesResponseContentall-applications policy prompts with MFA for all logins.confidence-score policy prompts with MFA only for low confidence logins.confidence-score policy is part of the Adaptive MFA feature. Adaptive MFA requires an add-on for the Enterprise plan; review Auth0 Pricing for more details.
client.guardian.factors.pushNotification.setFcmProvider({ ...params }) -> Management.SetGuardianFactorsProviderPushNotificationFcmResponseContentclient.guardian.policies.set({ ...params }) -> Management.SetGuardianPoliciesResponseContentall-applications policy prompts with MFA for all logins.confidence-score policy prompts with MFA only for low confidence logins.confidence-score policy is part of the Adaptive MFA feature. Adaptive MFA requires an add-on for the Enterprise plan; review Auth0 Pricing for more details.
client.guardian.factors.pushNotification.setFcmv1Provider({ ...params }) -> Management.SetGuardianFactorsProviderPushNotificationFcmv1ResponseContentclient.guardian.factors.phone.getMessageTypes() -> Management.GetGuardianFactorPhoneMessageTypesResponseContentclient.guardian.factors.pushNotification.getSnsProvider() -> Management.GetGuardianFactorsProviderSnsResponseContentclient.guardian.factors.phone.setMessageTypes({ ...params }) -> Management.SetGuardianFactorPhoneMessageTypesResponseContentclient.guardian.factors.pushNotification.setSnsProvider({ ...params }) -> Management.SetGuardianFactorsProviderPushNotificationSnsResponseContentclient.guardian.factors.phone.getTwilioProvider() -> Management.GetGuardianFactorsProviderPhoneTwilioResponseContentclient.guardian.factors.phone.setTwilioProvider({ ...params }) -> Management.SetGuardianFactorsProviderPhoneTwilioResponseContentclient.guardian.factors.phone.getSelectedProvider() -> Management.GetGuardianFactorsProviderPhoneResponseContentclient.guardian.factors.pushNotification.setProvider({ ...params }) -> Management.SetGuardianFactorsProviderPushNotificationResponseContentclient.guardian.factors.phone.setProvider({ ...params }) -> Management.SetGuardianFactorsProviderPhoneResponseContentclient.guardian.factors.sms.getTwilioProvider() -> Management.GetGuardianFactorsProviderSmsTwilioResponseContentclient.guardian.factors.phone.getTemplates() -> Management.GetGuardianFactorPhoneTemplatesResponseContentclient.guardian.factors.phone.setTemplates({ ...params }) -> Management.SetGuardianFactorPhoneTemplatesResponseContentclient.guardian.factors.sms.getSelectedProvider() -> Management.GetGuardianFactorsProviderSmsResponseContentclient.guardian.factors.pushNotification.getApnsProvider() -> Management.GetGuardianFactorsProviderApnsResponseContentclient.guardian.factors.pushNotification.setApnsProvider({ ...params }) -> Management.SetGuardianFactorsProviderPushNotificationApnsResponseContentclient.guardian.factors.sms.getTemplates() -> Management.GetGuardianFactorSmsTemplatesResponseContentclient.guardian.factors.pushNotification.setFcmProvider({ ...params }) -> Management.SetGuardianFactorsProviderPushNotificationFcmResponseContentclient.guardian.factors.pushNotification.setFcmv1Provider({ ...params }) -> Management.SetGuardianFactorsProviderPushNotificationFcmv1ResponseContentclient.guardian.factors.duo.settings.get() -> Management.GetGuardianFactorDuoSettingsResponseContentclient.guardian.factors.pushNotification.getSnsProvider() -> Management.GetGuardianFactorsProviderSnsResponseContentclient.guardian.factors.duo.settings.set({ ...params }) -> Management.SetGuardianFactorDuoSettingsResponseContentclient.guardian.factors.pushNotification.setSnsProvider({ ...params }) -> Management.SetGuardianFactorsProviderPushNotificationSnsResponseContentclient.guardian.factors.duo.settings.update({ ...params }) -> Management.UpdateGuardianFactorDuoSettingsResponseContentclient.guardian.factors.pushNotification.updateSnsProvider({ ...params }) -> Management.UpdateGuardianFactorsProviderPushNotificationSnsResponseContentclient.hooks.secrets.get(id) -> Management.GetHookSecretResponseContentclient.guardian.factors.pushNotification.getSelectedProvider() -> Management.GetGuardianFactorsProviderPushNotificationResponseContentclient.hooks.secrets.create(id, { ...params }) -> voidclient.guardian.factors.pushNotification.setProvider({ ...params }) -> Management.SetGuardianFactorsProviderPushNotificationResponseContentclient.hooks.secrets.delete(id, { ...params }) -> voidclient.guardian.factors.sms.getTwilioProvider() -> Management.GetGuardianFactorsProviderSmsTwilioResponseContentclient.hooks.secrets.update(id, { ...params }) -> voidclient.guardian.factors.sms.setTwilioProvider({ ...params }) -> Management.SetGuardianFactorsProviderSmsTwilioResponseContentclient.jobs.usersExports.create({ ...params }) -> Management.CreateExportUsersResponseContentclient.guardian.factors.sms.getSelectedProvider() -> Management.GetGuardianFactorsProviderSmsResponseContentclient.jobs.usersImports.create({ ...params }) -> Management.CreateImportUsersResponseContentclient.guardian.factors.sms.setProvider({ ...params }) -> Management.SetGuardianFactorsProviderSmsResponseContentclient.jobs.verificationEmail.create({ ...params }) -> Management.CreateVerificationEmailResponseContentclient.guardian.factors.sms.getTemplates() -> Management.GetGuardianFactorSmsTemplatesResponseContentclient.jobs.errors.get(id) -> Management.ErrorsGetResponseclient.guardian.factors.sms.setTemplates({ ...params }) -> Management.SetGuardianFactorSmsTemplatesResponseContentclient.keys.customSigning.get() -> Management.GetCustomSigningKeysResponseContentclient.guardian.factors.duo.settings.get() -> Management.GetGuardianFactorDuoSettingsResponseContentclient.keys.customSigning.set({ ...params }) -> Management.SetCustomSigningKeysResponseContentclient.guardian.factors.duo.settings.set({ ...params }) -> Management.SetGuardianFactorDuoSettingsResponseContentclient.keys.customSigning.delete() -> voidclient.guardian.factors.duo.settings.update({ ...params }) -> Management.UpdateGuardianFactorDuoSettingsResponseContentclient.keys.encryption.list({ ...params }) -> core.Pageclient.hooks.secrets.get(id) -> Management.GetHookSecretResponseContentclient.keys.encryption.create({ ...params }) -> Management.CreateEncryptionKeyResponseContentclient.hooks.secrets.create(id, { ...params }) -> voidclient.keys.encryption.rekey() -> voidclient.hooks.secrets.delete(id, { ...params }) -> voidclient.keys.encryption.get(kid) -> Management.GetEncryptionKeyResponseContentclient.hooks.secrets.update(id, { ...params }) -> voidclient.keys.encryption.import(kid, { ...params }) -> Management.ImportEncryptionKeyResponseContentclient.jobs.usersExports.create({ ...params }) -> Management.CreateExportUsersResponseContentclient.keys.encryption.delete(kid) -> voidclient.jobs.usersImports.create({ ...params }) -> Management.CreateImportUsersResponseContentclient.keys.encryption.createPublicWrappingKey(kid) -> Management.CreateEncryptionKeyPublicWrappingResponseContentclient.jobs.verificationEmail.create({ ...params }) -> Management.CreateVerificationEmailResponseContentclient.keys.signing.list() -> Management.SigningKeys[]client.jobs.errors.get(id) -> Management.ErrorsGetResponseclient.keys.signing.rotate() -> Management.RotateSigningKeysResponseContentclient.keys.customSigning.get() -> Management.GetCustomSigningKeysResponseContentclient.keys.signing.get(kid) -> Management.GetSigningKeysResponseContentclient.keys.customSigning.set({ ...params }) -> Management.SetCustomSigningKeysResponseContentclient.keys.signing.revoke(kid) -> Management.RevokedSigningKeysResponseContentclient.keys.customSigning.delete() -> voidclient.keys.encryption.list({ ...params }) -> core.Pageclient.organizations.clientGrants.list(id, { ...params }) -> core.Pageclient.organizations.clientGrants.create(id, { ...params }) -> Management.AssociateOrganizationClientGrantResponseContentclient.keys.encryption.create({ ...params }) -> Management.CreateEncryptionKeyResponseContentclient.organizations.clientGrants.delete(id, grantId) -> voidclient.keys.encryption.rekey() -> voidclient.organizations.discoveryDomains.list(id, { ...params }) -> core.Pageclient.keys.encryption.get(kid) -> Management.GetEncryptionKeyResponseContentclient.organizations.discoveryDomains.create(id, { ...params }) -> Management.CreateOrganizationDiscoveryDomainResponseContentclient.keys.encryption.import(kid, { ...params }) -> Management.ImportEncryptionKeyResponseContentstatus field must be either pending or verified.
-
+Import wrapped key material and activate encryption key.
s
-
```typescript
-await client.organizations.discoveryDomains.create("id", {
- domain: "domain",
+await client.keys.encryption.import("kid", {
+ wrapped_key: "wrapped_key"
});
-```
+```
client.organizations.discoveryDomains.get(id, discoveryDomainId) -> Management.GetOrganizationDiscoveryDomainResponseContentclient.keys.encryption.delete(kid) -> voidclient.organizations.discoveryDomains.delete(id, discoveryDomainId) -> voidclient.keys.encryption.createPublicWrappingKey(kid) -> Management.CreateEncryptionKeyPublicWrappingResponseContentclient.organizations.discoveryDomains.update(id, discoveryDomainId, { ...params }) -> Management.UpdateOrganizationDiscoveryDomainResponseContentclient.keys.signing.list() -> Management.SigningKeys[]status field must be either pending or verified.
-
+Retrieve details of all the application signing keys associated with your tenant.
s
-
```typescript
-await client.organizations.discoveryDomains.update("id", "discovery_domain_id");
-```
+await client.keys.signing.list();
+```
client.keys.signing.rotate() -> Management.RotateSigningKeysResponseContentclient.organizations.enabledConnections.list(id, { ...params }) -> core.Pageclient.keys.signing.get(kid) -> Management.GetSigningKeysResponseContentclient.organizations.enabledConnections.add(id, { ...params }) -> Management.AddOrganizationConnectionResponseContentclient.keys.signing.revoke(kid) -> Management.RevokedSigningKeysResponseContentclient.organizations.enabledConnections.get(id, connectionId) -> Management.GetOrganizationConnectionResponseContentclient.organizations.clientGrants.list(id, { ...params }) -> core.Pageclient.organizations.enabledConnections.delete(id, connectionId) -> voidclient.organizations.clientGrants.create(id, { ...params }) -> Management.AssociateOrganizationClientGrantResponseContentclient.organizations.enabledConnections.update(id, connectionId, { ...params }) -> Management.UpdateOrganizationConnectionResponseContentclient.organizations.clientGrants.delete(id, grant_id) -> voidclient.organizations.invitations.list(id, { ...params }) -> core.Pageclient.organizations.enabledConnections.list(id, { ...params }) -> core.Pageclient.organizations.invitations.create(id, { ...params }) -> Management.CreateOrganizationInvitationResponseContentclient.organizations.enabledConnections.add(id, { ...params }) -> Management.AddOrganizationConnectionResponseContentclient.organizations.invitations.get(id, invitationId, { ...params }) -> Management.GetOrganizationInvitationResponseContentclient.organizations.enabledConnections.get(id, connectionId) -> Management.GetOrganizationConnectionResponseContentclient.organizations.invitations.delete(id, invitationId) -> voidclient.organizations.enabledConnections.delete(id, connectionId) -> voidclient.organizations.members.list(id, { ...params }) -> core.Pageclient.organizations.enabledConnections.update(id, connectionId, { ...params }) -> Management.UpdateOrganizationConnectionResponseContentfields parameter to optionally define the specific member details retrieved. If fields is left blank, all fields (except roles) are returned.
- fields=roles to retrieve the roles assigned to each listed member. To use this parameter, you must include the read:organization_member_roles scope in the token.
- from parameter. If there are more results, a next value will be included in the response. You can use this for subsequent API calls. When next is no longer included in the response, this indicates there are no more pages remaining.
-
+Modify the details of a specific connection currently enabled for an Organization.
client.organizations.members.create(id, { ...params }) -> voidclient.organizations.invitations.list(id, { ...params }) -> core.Pageclient.organizations.members.delete(id, { ...params }) -> voidclient.organizations.invitations.create(id, { ...params }) -> Management.CreateOrganizationInvitationResponseContentclient.organizations.members.roles.list(id, userId, { ...params }) -> core.Pageclient.organizations.invitations.get(id, invitation_id, { ...params }) -> Management.GetOrganizationInvitationResponseContentclient.organizations.members.roles.assign(id, userId, { ...params }) -> voidclient.organizations.invitations.delete(id, invitation_id) -> voidclient.organizations.members.roles.delete(id, userId, { ...params }) -> voidclient.organizations.members.list(id, { ...params }) -> core.Pagefields parameter to optionally define the specific member details retrieved. If fields is left blank, all fields (except roles) are returned.
+ fields=roles to retrieve the roles assigned to each listed member. To use this parameter, you must include the read:organization_member_roles scope in the token.
+ from parameter. If there are more results, a next value will be included in the response. You can use this for subsequent API calls. When next is no longer included in the response, this indicates there are no more pages remaining.
client.prompts.rendering.list({ ...params }) -> core.Pageclient.organizations.members.create(id, { ...params }) -> voidclient.prompts.rendering.bulkUpdate({ ...params }) -> Management.BulkUpdateAculResponseContentclient.organizations.members.delete(id, { ...params }) -> void
- Example head_tags array. See our documentation on using Liquid variables within head tags.
-
{
- "head_tags": [
- {
- "tag": "script",
- "attributes": {
- "defer": true,
- "src": "URL_TO_ASSET",
- "async": true,
- "integrity": [
- "ASSET_SHA"
- ]
- }
- },
- {
- "tag": "link",
- "attributes": {
- "href": "URL_TO_ASSET",
- "rel": "stylesheet"
- }
- }
- ]
-}
-
+```
- Example head_tags array. See our documentation on using Liquid variables within head tags.
-
{
- "head_tags": [
- {
- "tag": "script",
- "attributes": {
- "defer": true,
- "src": "URL_TO_ASSET",
- "async": true,
- "integrity": [
- "ASSET_SHA"
- ]
- }
- },
- {
- "tag": "link",
- "attributes": {
- "href": "URL_TO_ASSET",
- "rel": "stylesheet"
- }
- }
- ]
-}
-
+Users can be members of multiple Organizations with unique roles assigned for each membership. This action assigns roles to a user only for the specified Organization. Roles cannot be assigned to a user across multiple Organizations in the same call.
+ Example head_tags array. See our documentation on using Liquid variables within head tags.
+
{
+ "head_tags": [
+ {
+ "tag": "script",
+ "attributes": {
+ "defer": true,
+ "src": "URL_TO_ASSET",
+ "async": true,
+ "integrity": [
+ "ASSET_SHA"
+ ]
+ }
+ },
+ {
+ "tag": "link",
+ "attributes": {
+ "href": "URL_TO_ASSET",
+ "rel": "stylesheet"
+ }
+ }
+ ]
+}
+
client.riskAssessments.settings.get() -> Management.GetRiskAssessmentsSettingsResponseContentclient.prompts.customText.get(prompt, language) -> Management.GetCustomTextsByLanguageResponseContentclient.riskAssessments.settings.update({ ...params }) -> Management.UpdateRiskAssessmentsSettingsResponseContentclient.prompts.customText.set(prompt, language, { ...params }) -> voidclient.riskAssessments.settings.newDevice.get() -> Management.GetRiskAssessmentsSettingsNewDeviceResponseContentclient.prompts.partials.get(prompt) -> Management.GetPartialsResponseContentclient.riskAssessments.settings.newDevice.update({ ...params }) -> Management.UpdateRiskAssessmentsSettingsNewDeviceResponseContentclient.prompts.partials.set(prompt, { ...params }) -> voidclient.roles.permissions.list(id, { ...params }) -> core.Pageclient.roles.users.list(id, { ...params }) -> core.Pagefrom: Optional id from which to start selection.take: The total amount of entries to retrieve when using the from parameter. Defaults to 50.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.
-
client.selfServiceProfiles.customText.list(id, language, page) -> Management.ListSelfServiceProfileCustomTextResponseContentclient.selfServiceProfiles.ssoTicket.create(id, { ...params }) -> Management.CreateSelfServiceProfileSsoTicketResponseContentclient.tenants.settings.get({ ...params }) -> Management.GetTenantSettingsResponseContentclient.users.authenticationMethods.list(id, { ...params }) -> core.Pageclient.users.authenticationMethods.get(id, authenticationMethodId) -> Management.GetUserAuthenticationMethodResponseContentclient.users.authenticationMethods.get(id, authentication_method_id) -> Management.GetUserAuthenticationMethodResponseContentclient.users.authenticationMethods.delete(id, authenticationMethodId) -> voidclient.users.authenticationMethods.delete(id, authentication_method_id) -> voidclient.users.authenticationMethods.update(id, authenticationMethodId, { ...params }) -> Management.UpdateUserAuthenticationMethodResponseContentclient.users.authenticationMethods.update(id, authentication_method_id, { ...params }) -> Management.UpdateUserAuthenticationMethodResponseContentclient.users.authenticators.deleteAll(id) -> voidclient.users.connectedAccounts.list(id, { ...params }) -> core.Pageclient.users.enrollments.get(id) -> Management.UsersEnrollment[]client.users.federatedConnectionsTokensets.list(id) -> Management.FederatedConnectionTokenSet[]client.users.federatedConnectionsTokensets.delete(id, tokensetId) -> voidclient.users.federatedConnectionsTokensets.delete(id, tokenset_id) -> voidclient.users.identities.link(id, { ...params }) -> Management.UserIdentity[]client.users.identities.delete(id, provider, userId) -> Management.DeleteUserIdentityResponseContentclient.users.identities.delete(id, provider, user_id) -> Management.DeleteUserIdentityResponseContentclient.users.logs.list(id, { ...params }) -> core.Pageclient.users.multifactor.invalidateRememberBrowser(id) -> voidclient.users.organizations.list(id, { ...params }) -> core.Pageclient.users.permissions.list(id, { ...params }) -> core.Pageclient.users.riskAssessments.clear(id, { ...params }) -> voidclient.users.roles.list(id, { ...params }) -> core.Pageclient.users.refreshToken.list(userId, { ...params }) -> core.Pageclient.users.refreshToken.list(user_id, { ...params }) -> core.Pageclient.users.refreshToken.delete(userId) -> voidclient.users.refreshToken.delete(user_id) -> voidclient.users.sessions.list(userId, { ...params }) -> core.Pageclient.users.sessions.list(user_id, { ...params }) -> core.Pageclient.users.sessions.delete(userId) -> voidclient.users.sessions.delete(user_id) -> voidclient.verifiableCredentials.verification.templates.list({ ...params }) -> core.Pagetrue if the custom login page is to be used, false otherwise. */
custom_login_page_on?: boolean;
token_endpoint_auth_method?: Management.ClientTokenEndpointAuthMethodOrNullEnum | null;
- /** If true, trust that the IP specified in the `auth0-forwarded-for` header is the end-user's IP for brute-force-protection on token endpoint. */
- is_token_endpoint_ip_header_trusted?: boolean;
app_type?: Management.ClientAppTypeEnum;
/** Whether this client a first party client or not */
is_first_party?: boolean;
@@ -377,8 +356,6 @@ export interface UpdateClientRequestContent {
default_organization?: Management.ClientDefaultOrganization | null;
organization_usage?: Management.ClientOrganizationUsagePatchEnum | null;
organization_require_behavior?: Management.ClientOrganizationRequireBehaviorPatchEnum | null;
- /** Defines the available methods for organization discovery during the `pre_login_prompt`. Users can discover their organization either by `email`, `organization_name` or both. */
- organization_discovery_methods?: Management.ClientOrganizationDiscoveryEnum[];
client_authentication_methods?: Management.ClientAuthenticationMethod | null;
/** Makes the use of Pushed Authorization Requests mandatory for this client */
require_pushed_authorization_requests?: boolean;
@@ -386,15 +363,8 @@ export interface UpdateClientRequestContent {
require_proof_of_possession?: boolean;
signed_request_object?: Management.ClientSignedRequestObjectWithCredentialId;
compliance_level?: Management.ClientComplianceLevelEnum | null;
- /**
- * Controls whether a confirmation prompt is shown during login flows when the redirect URI uses non-verifiable callback URIs (for example, a custom URI schema such as `myapp://`, or `localhost`).
- * If set to true, a confirmation prompt will not be shown. We recommend that this is set to false for improved protection from malicious apps.
- * See https://auth0.com/docs/secure/security-guidance/measures-against-app-impersonation for more information.
- */
- skip_non_verifiable_callback_uri_confirmation_prompt?: boolean | null;
/** Specifies how long, in seconds, a Pushed Authorization Request URI remains valid */
par_request_expiry?: number | null;
- async_approval_notification_channels?: Management.ClientAsyncApprovalNotificationsChannelsApiPatchConfiguration;
}
/**
@@ -445,8 +415,6 @@ export interface CreateConnectionRequestContent {
/** Defines the realms for which the connection will be used (ie: email domains). If the array is empty or the property is not specified, the connection name will be added as realm. */
realms?: string[];
metadata?: Management.ConnectionsMetadata;
- authentication?: Management.ConnectionAuthenticationPurpose;
- connected_accounts?: Management.ConnectionConnectedAccountsPurpose;
}
/**
@@ -480,8 +448,6 @@ export interface UpdateConnectionRequestContent {
/** Defines the realms for which the connection will be used (ie: email domains). If the array is empty or the property is not specified, the connection name will be added as realm. */
realms?: string[];
metadata?: Management.ConnectionsMetadata;
- authentication?: Management.ConnectionAuthenticationPurpose;
- connected_accounts?: Management.ConnectionConnectedAccountsPurpose;
}
/**
@@ -663,6 +629,20 @@ export interface UpdateEventStreamRequestContent {
status?: Management.EventStreamStatusEnum;
}
+/**
+ * @example
+ * {
+ * date_from: "date_from",
+ * date_to: "date_to"
+ * }
+ */
+export interface EventStreamsGetStatsRequest {
+ /** The RFC3339 start date for the stats query. */
+ date_from?: string | null;
+ /** The RFC3339 end date for the stats query. */
+ date_to?: string | null;
+}
+
/**
* @example
* {
@@ -923,7 +903,7 @@ export interface UpdateLogStreamRequestContent {
* fields: "fields",
* include_fields: true,
* include_totals: true,
- * search: "search"
+ * q: "q"
* }
*/
export interface ListLogsRequestParameters {
@@ -939,12 +919,8 @@ export interface ListLogsRequestParameters {
include_fields?: boolean | null;
/** Return results as an array when false (default). Return results inside an object that also contains a total result count when true. */
include_totals?: boolean | null;
- /**
- * Retrieves logs that match the specified search criteria. This parameter can be combined with all the others in the /api/logs endpoint but is specified separately for clarity.
- * If no fields are provided a case insensitive 'starts with' search is performed on all of the following fields: client_name, connection, user_name. Otherwise, you can specify multiple fields and specify the search using the %field%:%search%, for example: application:node user:"John@contoso.com".
- * Values specified without quotes are matched using a case insensitive 'starts with' search. If quotes are used a case insensitve exact search is used. If multiple fields are used, the AND operator is used to join the clauses.
- */
- search?: string | null;
+ /** Query in Lucene query string syntax. */
+ q?: string | null;
}
/**
@@ -1131,7 +1107,6 @@ export interface CreateResourceServerRequestContent {
consent_policy?: (Management.ResourceServerConsentPolicyEnum | undefined) | null;
authorization_details?: unknown[];
proof_of_possession?: Management.ResourceServerProofOfPossession | null;
- subject_type_authorization?: Management.ResourceServerSubjectTypeAuthorization;
}
/**
@@ -1170,7 +1145,6 @@ export interface UpdateResourceServerRequestContent {
consent_policy?: (Management.ResourceServerConsentPolicyEnum | undefined) | null;
authorization_details?: unknown[];
proof_of_possession?: Management.ResourceServerProofOfPossession | null;
- subject_type_authorization?: Management.ResourceServerSubjectTypeAuthorization;
}
/**
@@ -1334,8 +1308,6 @@ export interface CreateSelfServiceProfileRequestContent {
allowed_strategies?: Management.SelfServiceProfileAllowedStrategyEnum[];
/** List of attributes to be mapped that will be shown to the user during the SS-SSO flow. */
user_attributes?: Management.SelfServiceProfileUserAttribute[];
- /** ID of the user-attribute-profile to associate with this self-service profile. */
- user_attribute_profile_id?: string;
}
/**
@@ -1350,16 +1322,6 @@ export interface UpdateSelfServiceProfileRequestContent {
/** List of IdP strategies that will be shown to users during the Self-Service SSO flow. Possible values: [`oidc`, `samlp`, `waad`, `google-apps`, `adfs`, `okta`, `keycloak-samlp`, `pingfederate`] */
allowed_strategies?: Management.SelfServiceProfileAllowedStrategyEnum[];
user_attributes?: (Management.SelfServiceProfileUserAttributes | undefined) | null;
- /** ID of the user-attribute-profile to associate with this self-service profile. */
- user_attribute_profile_id?: string | null;
-}
-
-/**
- * @example
- * {}
- */
-export interface UpdateSessionRequestContent {
- session_metadata?: (Management.SessionMetadata | undefined) | null;
}
/**
@@ -1476,50 +1438,6 @@ export interface UpdateTokenExchangeProfileRequestContent {
subject_token_type?: string;
}
-/**
- * @example
- * {
- * from: "from",
- * take: 1
- * }
- */
-export interface ListUserAttributeProfileRequestParameters {
- /** Optional Id from which to start selection. */
- from?: string | null;
- /** Number of results per page. Defaults to 5. */
- take?: number | null;
-}
-
-/**
- * @example
- * {
- * name: "name",
- * user_attributes: {
- * "key": {
- * description: "description",
- * label: "label",
- * profile_required: true,
- * auth0_mapping: "auth0_mapping"
- * }
- * }
- * }
- */
-export interface CreateUserAttributeProfileRequestContent {
- name: Management.UserAttributeProfileName;
- user_id?: Management.UserAttributeProfileUserId;
- user_attributes: Management.UserAttributeProfileUserAttributes;
-}
-
-/**
- * @example
- * {}
- */
-export interface UpdateUserAttributeProfileRequestContent {
- name?: Management.UserAttributeProfileName;
- user_id?: Management.UserAttributeProfilePatchUserId | undefined;
- user_attributes?: Management.UserAttributeProfileUserAttributes;
-}
-
/**
* @example
* {
@@ -1763,19 +1681,6 @@ export interface UpdateActionBindingsRequestContent {
bindings?: Management.ActionBindingWithRef[];
}
-/**
- * @example
- * {}
- */
-export interface UpdateBotDetectionSettingsRequestContent {
- bot_detection_level?: Management.BotDetectionLevelEnum;
- challenge_password_policy?: Management.BotDetectionChallengePolicyPasswordFlowEnum;
- challenge_passwordless_policy?: Management.BotDetectionChallengePolicyPasswordlessFlowEnum;
- challenge_password_reset_policy?: Management.BotDetectionChallengePolicyPasswordResetFlowEnum;
- allowlist?: Management.BotDetectionAllowlist;
- monitoring_mode_enabled?: Management.BotDetectionMonitoringModeEnabled;
-}
-
/**
* @example
* {}
@@ -1842,21 +1747,6 @@ export namespace UpdateBruteForceSettingsRequestContent {
export type Mode = (typeof Mode)[keyof typeof Mode];
}
-/**
- * @example
- * {}
- */
-export interface UpdateAttackProtectionCaptchaRequestContent {
- active_provider_id?: Management.AttackProtectionCaptchaProviderId;
- arkose?: Management.AttackProtectionUpdateCaptchaArkose;
- auth_challenge?: Management.AttackProtectionCaptchaAuthChallengeRequest;
- hcaptcha?: Management.AttackProtectionUpdateCaptchaHcaptcha;
- friendly_captcha?: Management.AttackProtectionUpdateCaptchaFriendlyCaptcha;
- recaptcha_enterprise?: Management.AttackProtectionUpdateCaptchaRecaptchaEnterprise;
- recaptcha_v2?: Management.AttackProtectionUpdateCaptchaRecaptchaV2;
- simple_captcha?: Management.AttackProtectionCaptchaSimpleCaptchaResponseContent;
-}
-
/**
* @example
* {}
@@ -2366,33 +2256,6 @@ export interface ExecutionsGetRequest {
hydrate?: ("debug" | null) | ("debug" | null)[];
}
-/**
- * @example
- * {
- * page: 1,
- * per_page: 1,
- * include_totals: true
- * }
- */
-export interface ListFlowsVaultConnectionsRequestParameters {
- /** Page index of the results to return. First page is 0. */
- page?: number | null;
- /** Number of results per page. Defaults to 50. */
- per_page?: number | null;
- /** Return results inside an object that contains the total result count (true) or as a direct array of results (false, default). */
- include_totals?: boolean | null;
-}
-
-/**
- * @example
- * {}
- */
-export interface UpdateFlowsVaultConnectionRequestContent {
- /** Flows Vault Connection name. */
- name?: string;
- setup?: Management.UpdateFlowsVaultConnectionSetup;
-}
-
/**
* @example
* {
@@ -2703,40 +2566,6 @@ export interface AssociateOrganizationClientGrantRequestContent {
grant_id: string;
}
-/**
- * @example
- * {
- * from: "from",
- * take: 1
- * }
- */
-export interface ListOrganizationDiscoveryDomainsRequestParameters {
- /** Optional Id from which to start selection. */
- from?: string | null;
- /** Number of results per page. Defaults to 50. */
- take?: number | null;
-}
-
-/**
- * @example
- * {
- * domain: "domain"
- * }
- */
-export interface CreateOrganizationDiscoveryDomainRequestContent {
- /** The domain name to associate with the organization e.g. acme.com. */
- domain: string;
- status?: Management.OrganizationDiscoveryDomainStatus;
-}
-
-/**
- * @example
- * {}
- */
-export interface UpdateOrganizationDiscoveryDomainRequestContent {
- status?: Management.OrganizationDiscoveryDomainStatus;
-}
-
/**
* @example
* {
@@ -2968,61 +2797,21 @@ export interface ListAculsRequestParameters {
/**
* @example
- * {
- * configs: [{
- * prompt: "login",
- * screen: "login",
- * rendering_mode: "advanced",
- * head_tags: [{}]
- * }]
- * }
- */
-export interface BulkUpdateAculRequestContent {
- configs: Management.AculConfigs;
-}
-
-/**
- * @example
- * {
- * rendering_mode: "advanced",
- * head_tags: [{}]
- * }
+ * {}
*/
export interface UpdateAculRequestContent {
- rendering_mode: Management.AculRenderingModeEnum;
+ rendering_mode?: Management.AculRenderingModeEnum;
/** Context values to make available */
context_configuration?: string[];
/** Override Universal Login default head tags */
default_head_tags_disabled?: boolean | null;
/** An array of head tags */
- head_tags: Management.AculHeadTag[];
+ head_tags?: Management.AculHeadTag[];
filters?: Management.AculFilters | null;
/** Use page template with ACUL */
use_page_template?: boolean | null;
}
-/**
- * @example
- * {
- * enabled: true
- * }
- */
-export interface UpdateRiskAssessmentsSettingsRequestContent {
- /** Whether or not risk assessment is enabled. */
- enabled: boolean;
-}
-
-/**
- * @example
- * {
- * remember_for: 1
- * }
- */
-export interface UpdateRiskAssessmentsSettingsNewDeviceRequestContent {
- /** Length of time to remember devices for, in days. */
- remember_for: number;
-}
-
/**
* @example
* {
@@ -3180,12 +2969,6 @@ export interface UpdateTenantSettingsRequestContent {
pushed_authorization_requests_supported?: boolean | null;
/** Supports iss parameter in authorization responses */
authorization_response_iss_parameter_supported?: boolean | null;
- /**
- * Controls whether a confirmation prompt is shown during login flows when the redirect URI uses non-verifiable callback URIs (for example, a custom URI schema such as `myapp://`, or `localhost`).
- * If set to true, a confirmation prompt will not be shown. We recommend that this is set to false for improved protection from malicious apps.
- * See https://auth0.com/docs/secure/security-guidance/measures-against-app-impersonation for more information.
- */
- skip_non_verifiable_callback_uri_confirmation_prompt?: boolean | null;
}
export namespace UpdateTenantSettingsRequestContent {
@@ -3315,7 +3098,7 @@ export interface CreateUserAuthenticationMethodRequestContent {
preferred_authentication_method?: Management.PreferredAuthenticationMethodEnum;
/** Applies to webauthn authentication methods only. The id of the credential. */
key_id?: string;
- /** Applies to webauthn authentication methods only. The public key, which is encoded as base64. */
+ /** Applies to webauthn authentication methods only. The public key. */
public_key?: string;
/** Applies to webauthn authentication methods only. The relying party identifier. */
relying_party_identifier?: string;
@@ -3331,20 +3114,6 @@ export interface UpdateUserAuthenticationMethodRequestContent {
preferred_authentication_method?: Management.PreferredAuthenticationMethodEnum;
}
-/**
- * @example
- * {
- * from: "from",
- * take: 1
- * }
- */
-export interface GetUserConnectedAccountsRequestParameters {
- /** Optional Id from which to start selection. */
- from?: string | null;
- /** Number of results to return. Defaults to 10 with a maximum of 20 */
- take?: number | null;
-}
-
/**
* @example
* {}
@@ -3353,7 +3122,7 @@ export interface LinkUserIdentityRequestContent {
provider?: Management.UserIdentityProviderEnum;
/** connection_id of the secondary user account being linked when more than one `auth0` database provider exists. */
connection_id?: string;
- user_id?: Management.UserId;
+ user_id?: Management.UserIdEnum;
/** JWT for the secondary account being linked. If sending this parameter, `provider`, `user_id`, and `connection_id` must not be sent. */
link_with?: string;
}
@@ -3440,20 +3209,6 @@ export interface DeleteUserPermissionsRequestContent {
permissions: Management.PermissionRequestPayload[];
}
-/**
- * @example
- * {
- * connection: "connection",
- * assessors: ["new-device"]
- * }
- */
-export interface ClearAssessorsRequestContent {
- /** The name of the connection containing the user whose assessors should be cleared. */
- connection: string;
- /** List of assessors to clear. */
- assessors: Management.AssessorsTypeEnum[];
-}
-
/**
* @example
* {
diff --git a/src/management/api/resources/actions/client/Client.ts b/src/management/api/resources/actions/client/Client.ts
index f4c582ddc3..7e77f61a8c 100644
--- a/src/management/api/resources/actions/client/Client.ts
+++ b/src/management/api/resources/actions/client/Client.ts
@@ -1,48 +1,50 @@
// This file was auto-generated by Fern from our API Definition.
import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
-import * as environments from "../../../../environments.js";
+import { type NormalizedClientOptionsWithAuth, normalizeClientOptionsWithAuth } from "../../../../BaseClient.js";
+import { mergeHeaders } from "../../../../core/headers.js";
import * as core from "../../../../core/index.js";
-import * as Management from "../../../index.js";
-import { mergeHeaders, mergeOnlyDefinedHeaders } from "../../../../core/headers.js";
+import * as environments from "../../../../environments.js";
+import { handleNonStatusCodeError } from "../../../../errors/handleNonStatusCodeError.js";
import * as errors from "../../../../errors/index.js";
-import { Versions } from "../resources/versions/client/Client.js";
-import { Executions } from "../resources/executions/client/Client.js";
-import { Triggers } from "../resources/triggers/client/Client.js";
+import * as Management from "../../../index.js";
+import { ExecutionsClient } from "../resources/executions/client/Client.js";
+import { TriggersClient } from "../resources/triggers/client/Client.js";
+import { VersionsClient } from "../resources/versions/client/Client.js";
-export declare namespace Actions {
+export declare namespace ActionsClient {
export interface Options extends BaseClientOptions {}
export interface RequestOptions extends BaseRequestOptions {}
}
-export class Actions {
- protected readonly _options: Actions.Options;
- protected _versions: Versions | undefined;
- protected _executions: Executions | undefined;
- protected _triggers: Triggers | undefined;
+export class ActionsClient {
+ protected readonly _options: NormalizedClientOptionsWithAuthcredentials object requires different properties depending on the phone provider (which is specified using the name property).
*
* @param {Management.CreateBrandingPhoneProviderRequestContent} request
- * @param {Providers.RequestOptions} requestOptions - Request-specific configuration.
+ * @param {ProvidersClient.RequestOptions} requestOptions - Request-specific configuration.
*
* @throws {@link Management.BadRequestError}
* @throws {@link Management.UnauthorizedError}
@@ -139,18 +138,24 @@ export class Providers {
*/
public create(
request: Management.CreateBrandingPhoneProviderRequestContent,
- requestOptions?: Providers.RequestOptions,
+ requestOptions?: ProvidersClient.RequestOptions,
): core.HttpResponsePromiseWhen content-type header is set to application/json:
When content-type header is set to application/json, the expected body must be JSON:
* {
- * "template": "<!DOCTYPE html>{% assign resolved_dir = dir | default: "auto" %}<html lang="{{locale}}" dir="{{resolved_dir}}"><head>{%- auth0:head -%}</head><body class="_widget-auto-layout">{%- auth0:widget -%}</body></html>"
+ * "template": "<!DOCTYPE html><html><head>{%- auth0:head -%}</head><body>{%- auth0:widget -%}</body></html>"
* }
*
*
*
- * When content-type header is set to text/html:
+ * When content-type header is set to text/html, the expected body must be the HTML template:
*
* <!DOCTYPE html>
- * {% assign resolved_dir = dir | default: "auto" %}
- * <html lang="{{locale}}" dir="{{resolved_dir}}">
- * <head>
- * {%- auth0:head -%}
- * </head>
- * <body class="_widget-auto-layout">
- * {%- auth0:widget -%}
- * </body>
- * </html>
+ * <code>
+ * <html>
+ * <head>
+ * {%- auth0:head -%}
+ * </head>
+ * <body>
+ * {%- auth0:widget -%}
+ * </body>
+ * </html>
+ * </code>
*
*
* @param {Management.UpdateUniversalLoginTemplateRequestContent} request
- * @param {Templates.RequestOptions} requestOptions - Request-specific configuration.
+ * @param {TemplatesClient.RequestOptions} requestOptions - Request-specific configuration.
*
* @throws {@link Management.BadRequestError}
* @throws {@link Management.UnauthorizedError}
@@ -149,18 +149,24 @@ export class Templates {
*/
public updateUniversalLogin(
request: Management.UpdateUniversalLoginTemplateRequestContent,
- requestOptions?: Templates.RequestOptions,
+ requestOptions?: TemplatesClient.RequestOptions,
): core.HttpResponsePromise