# Reference ## Actions
client.actions.list({ ...params }) -> core.Page<Management.Action, Management.ListActionsPaginatedResponseContent>
#### 📝 Description
Retrieve all actions.
#### 🔌 Usage
```typescript const pageableResponse = await client.actions.list({ triggerId: "post-login", actionName: "actionName", deployed: true, page: 1, per_page: 1, installed: true, }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.actions.list({ triggerId: "post-login", actionName: "actionName", deployed: true, page: 1, per_page: 1, installed: true, }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Management.ListActionsRequestParameters`
**requestOptions:** `ActionsClient.RequestOptions`
client.actions.create({ ...params }) -> Management.CreateActionResponseContent
#### 📝 Description
Create an action. Once an action is created, it must be deployed, and then bound to a trigger before it will be executed as part of a flow.
#### 🔌 Usage
```typescript await client.actions.create({ name: "name", supported_triggers: [ { id: "post-login", }, ], }); ```
#### ⚙️ Parameters
**request:** `Management.CreateActionRequestContent`
**requestOptions:** `ActionsClient.RequestOptions`
client.actions.get(id) -> Management.GetActionResponseContent
#### 📝 Description
Retrieve an action by its ID.
#### 🔌 Usage
```typescript await client.actions.get("id"); ```
#### ⚙️ Parameters
**id:** `string` — The ID of the action to retrieve.
**requestOptions:** `ActionsClient.RequestOptions`
client.actions.delete(id, { ...params }) -> void
#### 📝 Description
Deletes an action and all of its associated versions. An action must be unbound from all triggers before it can be deleted.
#### 🔌 Usage
```typescript await client.actions.delete("id", { force: true, }); ```
#### ⚙️ Parameters
**id:** `string` — The ID of the action to delete.
**request:** `Management.DeleteActionRequestParameters`
**requestOptions:** `ActionsClient.RequestOptions`
client.actions.update(id, { ...params }) -> Management.UpdateActionResponseContent
#### 📝 Description
Update an existing action. If this action is currently bound to a trigger, updating it will not affect any user flows until the action is deployed.
#### 🔌 Usage
```typescript await client.actions.update("id"); ```
#### ⚙️ Parameters
**id:** `string` — The id of the action to update.
**request:** `Management.UpdateActionRequestContent`
**requestOptions:** `ActionsClient.RequestOptions`
client.actions.deploy(id) -> Management.DeployActionResponseContent
#### 📝 Description
Deploy an action. Deploying an action will create a new immutable version of the action. If the action is currently bound to a trigger, then the system will begin executing the newly deployed version of the action immediately. Otherwise, the action will only be executed as a part of a flow once it is bound to that flow.
#### 🔌 Usage
```typescript await client.actions.deploy("id"); ```
#### ⚙️ Parameters
**id:** `string` — The ID of an action.
**requestOptions:** `ActionsClient.RequestOptions`
client.actions.test(id, { ...params }) -> Management.TestActionResponseContent
#### 📝 Description
Test an action. After updating an action, it can be tested prior to being deployed to ensure it behaves as expected.
#### 🔌 Usage
```typescript await client.actions.test("id", { payload: { key: "value", }, }); ```
#### ⚙️ Parameters
**id:** `string` — The id of the action to test.
**request:** `Management.TestActionRequestContent`
**requestOptions:** `ActionsClient.RequestOptions`
## Branding
client.branding.get() -> Management.GetBrandingResponseContent
#### 📝 Description
Retrieve branding settings.
#### 🔌 Usage
```typescript await client.branding.get(); ```
#### ⚙️ Parameters
**requestOptions:** `BrandingClient.RequestOptions`
client.branding.update({ ...params }) -> Management.UpdateBrandingResponseContent
#### 📝 Description
Update branding settings.
#### 🔌 Usage
```typescript await client.branding.update(); ```
#### ⚙️ Parameters
**request:** `Management.UpdateBrandingRequestContent`
**requestOptions:** `BrandingClient.RequestOptions`
## ClientGrants
client.clientGrants.list({ ...params }) -> core.Page<Management.ClientGrantResponseContent, Management.ListClientGrantPaginatedResponseContent>
#### 📝 Description
Retrieve a list of client grants, including the scopes associated with the application/API pair.
#### 🔌 Usage
```typescript const pageableResponse = await client.clientGrants.list({ from: "from", take: 1, audience: "audience", client_id: "client_id", allow_any_organization: true, subject_type: "client", default_for: "third_party_clients", }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.clientGrants.list({ from: "from", take: 1, audience: "audience", client_id: "client_id", allow_any_organization: true, subject_type: "client", default_for: "third_party_clients", }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Management.ListClientGrantsRequestParameters`
**requestOptions:** `ClientGrantsClient.RequestOptions`
client.clientGrants.create({ ...params }) -> Management.CreateClientGrantResponseContent
#### 📝 Description
Create a client grant for a machine-to-machine login flow. To learn more, read Client Credential Flow.
#### 🔌 Usage
```typescript await client.clientGrants.create({ audience: "audience", }); ```
#### ⚙️ Parameters
**request:** `Management.CreateClientGrantRequestContent`
**requestOptions:** `ClientGrantsClient.RequestOptions`
client.clientGrants.get(id) -> Management.GetClientGrantResponseContent
#### 📝 Description
Retrieve a single client grant, including the scopes associated with the application/API pair.
#### 🔌 Usage
```typescript await client.clientGrants.get("id"); ```
#### ⚙️ Parameters
**id:** `string` — The ID of the client grant to retrieve.
**requestOptions:** `ClientGrantsClient.RequestOptions`
client.clientGrants.delete(id) -> void
#### 📝 Description
Delete the Client Credential Flow from your machine-to-machine application.
#### 🔌 Usage
```typescript await client.clientGrants.delete("id"); ```
#### ⚙️ Parameters
**id:** `string` — ID of the client grant to delete.
**requestOptions:** `ClientGrantsClient.RequestOptions`
client.clientGrants.update(id, { ...params }) -> Management.UpdateClientGrantResponseContent
#### 📝 Description
Update a client grant.
#### 🔌 Usage
```typescript await client.clientGrants.update("id"); ```
#### ⚙️ Parameters
**id:** `string` — ID of the client grant to update.
**request:** `Management.UpdateClientGrantRequestContent`
**requestOptions:** `ClientGrantsClient.RequestOptions`
## Clients
client.clients.list({ ...params }) -> core.Page<Management.Client, Management.ListClientsOffsetPaginatedResponseContent>
#### 📝 Description
Retrieve clients (applications and SSO integrations) matching provided filters. A list of fields to include or exclude may also be specified. For more information, read Applications in Auth0 and Single Sign-On.
  • The following can be retrieved with any scope: client_id, app_type, name, and description.
  • The following properties can only be retrieved with the read:clients or read:client_keys scope: callbacks, oidc_logout, allowed_origins, web_origins, tenant, global, config_route, callback_url_template, jwt_configuration, jwt_configuration.lifetime_in_seconds, jwt_configuration.secret_encoded, jwt_configuration.scopes, jwt_configuration.alg, api_type, logo_uri, allowed_clients, owners, custom_login_page, custom_login_page_off, sso, addons, form_template, custom_login_page_codeview, resource_servers, client_metadata, mobile, mobile.android, mobile.ios, allowed_logout_urls, token_endpoint_auth_method, is_first_party, oidc_conformant, is_token_endpoint_ip_header_trusted, initiate_login_uri, grant_types, refresh_token, refresh_token.rotation_type, refresh_token.expiration_type, refresh_token.leeway, refresh_token.token_lifetime, refresh_token.policies, organization_usage, organization_require_behavior.
  • The following properties can only be retrieved with the read:client_keys or read:client_credentials scope: encryption_key, encryption_key.pub, encryption_key.cert, client_secret, client_authentication_methods and signing_key.
#### 🔌 Usage
```typescript const pageableResponse = await client.clients.list({ fields: "fields", include_fields: true, page: 1, per_page: 1, include_totals: true, is_global: true, is_first_party: true, app_type: "app_type", external_client_id: "external_client_id", q: "q", }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.clients.list({ fields: "fields", include_fields: true, page: 1, per_page: 1, include_totals: true, is_global: true, is_first_party: true, app_type: "app_type", external_client_id: "external_client_id", q: "q", }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Management.ListClientsRequestParameters`
**requestOptions:** `ClientsClient.RequestOptions`
client.clients.create({ ...params }) -> Management.CreateClientResponseContent
#### 📝 Description
Create a new client (application or SSO integration). For more information, read Create Applications API Endpoints for Single Sign-On. Notes: - We recommend leaving the `client_secret` parameter unspecified to allow the generation of a safe secret. - 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.
SSO Integrations created via this endpoint will accept login requests and share user profile information.
#### 🔌 Usage
```typescript await client.clients.create({ name: "name", }); ```
#### ⚙️ Parameters
**request:** `Management.CreateClientRequestContent`
**requestOptions:** `ClientsClient.RequestOptions`
client.clients.previewCimdMetadata({ ...params }) -> Management.PreviewCimdMetadataResponseContent
#### 📝 Description
Fetches and validates a Client ID Metadata Document without creating a client. Returns the raw metadata and how it would be mapped to Auth0 client fields. This endpoint is useful for testing metadata URIs before creating CIMD clients.
#### 🔌 Usage
```typescript await client.clients.previewCimdMetadata({ external_client_id: "external_client_id", }); ```
#### ⚙️ Parameters
**request:** `Management.PreviewCimdMetadataRequestContent`
**requestOptions:** `ClientsClient.RequestOptions`
client.clients.registerCimdClient({ ...params }) -> Management.RegisterCimdClientResponseContent
#### 📝 Description
Idempotent registration for Client ID Metadata Document (CIMD) clients. Uses external_client_id as the unique identifier for upsert operations. **Create:** Returns 201 when a new client is created (requires \
#### 🔌 Usage
```typescript await client.clients.registerCimdClient({ external_client_id: "external_client_id", }); ```
#### ⚙️ Parameters
**request:** `Management.RegisterCimdClientRequestContent`
**requestOptions:** `ClientsClient.RequestOptions`
client.clients.get(id, { ...params }) -> Management.GetClientResponseContent
#### 📝 Description
Retrieve client details by ID. Clients are SSO connections or Applications linked with your Auth0 tenant. A list of fields to include or exclude may also be specified. For more information, read Applications in Auth0 and Single Sign-On.
  • The following properties can be retrieved with any of the scopes: client_id, app_type, name, and description.
  • The following properties can only be retrieved with the read:clients or read:client_keys scopes: callbacks, oidc_logout, allowed_origins, web_origins, tenant, global, config_route, callback_url_template, jwt_configuration, jwt_configuration.lifetime_in_seconds, jwt_configuration.secret_encoded, jwt_configuration.scopes, jwt_configuration.alg, api_type, logo_uri, allowed_clients, owners, custom_login_page, custom_login_page_off, sso, addons, form_template, custom_login_page_codeview, resource_servers, client_metadata, mobile, mobile.android, mobile.ios, allowed_logout_urls, token_endpoint_auth_method, is_first_party, oidc_conformant, is_token_endpoint_ip_header_trusted, initiate_login_uri, grant_types, refresh_token, refresh_token.rotation_type, refresh_token.expiration_type, refresh_token.leeway, refresh_token.token_lifetime, refresh_token.policies, organization_usage, organization_require_behavior.
  • The following properties can only be retrieved with the read:client_keys or read:client_credentials scopes: encryption_key, encryption_key.pub, encryption_key.cert, client_secret, client_authentication_methods and signing_key.
#### 🔌 Usage
```typescript await client.clients.get("id", { fields: "fields", include_fields: true, }); ```
#### ⚙️ Parameters
**id:** `string` — ID of the client to retrieve.
**request:** `Management.GetClientRequestParameters`
**requestOptions:** `ClientsClient.RequestOptions`
client.clients.delete(id) -> void
#### 📝 Description
Delete a client and related configuration (rules, connections, etc).
#### 🔌 Usage
```typescript await client.clients.delete("id"); ```
#### ⚙️ Parameters
**id:** `string` — ID of the client to delete.
**requestOptions:** `ClientsClient.RequestOptions`
client.clients.update(id, { ...params }) -> Management.UpdateClientResponseContent
#### 📝 Description
Updates a client's settings. For more information, read Applications in Auth0 and Single Sign-On. Notes: - The `client_secret` and `signing_key` attributes can only be updated with the `update:client_keys` scope. - 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, 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
```typescript await client.clients.update("id"); ```
#### ⚙️ Parameters
**id:** `string` — ID of the client to update.
**request:** `Management.UpdateClientRequestContent`
**requestOptions:** `ClientsClient.RequestOptions`
client.clients.rotateSecret(id) -> Management.RotateClientSecretResponseContent
#### 📝 Description
Rotate a client secret. This endpoint cannot be used with clients configured with Private Key JWT authentication method (client_authentication_methods configured with private_key_jwt). The generated secret is NOT base64 encoded. For more information, read Rotate Client Secrets.
#### 🔌 Usage
```typescript await client.clients.rotateSecret("id"); ```
#### ⚙️ Parameters
**id:** `string` — ID of the client that will rotate secrets.
**requestOptions:** `ClientsClient.RequestOptions`
## ConnectionProfiles
client.connectionProfiles.list({ ...params }) -> core.Page<Management.ConnectionProfile, Management.ListConnectionProfilesPaginatedResponseContent>
#### 📝 Description
Retrieve a list of Connection Profiles. This endpoint supports Checkpoint pagination.
#### 🔌 Usage
```typescript const pageableResponse = await client.connectionProfiles.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.connectionProfiles.list({ from: "from", take: 1, }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Management.ListConnectionProfileRequestParameters`
**requestOptions:** `ConnectionProfilesClient.RequestOptions`
client.connectionProfiles.create({ ...params }) -> Management.CreateConnectionProfileResponseContent
#### 📝 Description
Create a Connection Profile.
#### 🔌 Usage
```typescript await client.connectionProfiles.create({ name: "name", }); ```
#### ⚙️ Parameters
**request:** `Management.CreateConnectionProfileRequestContent`
**requestOptions:** `ConnectionProfilesClient.RequestOptions`
client.connectionProfiles.listTemplates() -> Management.ListConnectionProfileTemplateResponseContent
#### 📝 Description
Retrieve a list of Connection Profile Templates.
#### 🔌 Usage
```typescript await client.connectionProfiles.listTemplates(); ```
#### ⚙️ Parameters
**requestOptions:** `ConnectionProfilesClient.RequestOptions`
client.connectionProfiles.getTemplate(id) -> Management.GetConnectionProfileTemplateResponseContent
#### 📝 Description
Retrieve a Connection Profile Template.
#### 🔌 Usage
```typescript await client.connectionProfiles.getTemplate("id"); ```
#### ⚙️ Parameters
**id:** `string` — ID of the connection-profile-template to retrieve.
**requestOptions:** `ConnectionProfilesClient.RequestOptions`
client.connectionProfiles.get(id) -> Management.GetConnectionProfileResponseContent
#### 📝 Description
Retrieve details about a single Connection Profile specified by ID.
#### 🔌 Usage
```typescript await client.connectionProfiles.get("id"); ```
#### ⚙️ Parameters
**id:** `string` — ID of the connection-profile to retrieve.
**requestOptions:** `ConnectionProfilesClient.RequestOptions`
client.connectionProfiles.delete(id) -> void
#### 📝 Description
Delete a single Connection Profile specified by ID.
#### 🔌 Usage
```typescript await client.connectionProfiles.delete("id"); ```
#### ⚙️ Parameters
**id:** `string` — ID of the connection-profile to delete.
**requestOptions:** `ConnectionProfilesClient.RequestOptions`
client.connectionProfiles.update(id, { ...params }) -> Management.UpdateConnectionProfileResponseContent
#### 📝 Description
Update the details of a specific Connection Profile.
#### 🔌 Usage
```typescript await client.connectionProfiles.update("id"); ```
#### ⚙️ Parameters
**id:** `string` — ID of the connection profile to update.
**request:** `Management.UpdateConnectionProfileRequestContent`
**requestOptions:** `ConnectionProfilesClient.RequestOptions`
## Connections
client.connections.list({ ...params }) -> core.Page<Management.ConnectionForList, Management.ListConnectionsCheckpointPaginatedResponseContent>
#### 📝 Description
Retrieves detailed list of all connections that match the specified strategy. If no strategy is provided, all connections within your tenant are retrieved. This action can accept a list of fields to include or exclude from the resulting list of connections. This endpoint supports two types of pagination:
  • Offset pagination
  • Checkpoint pagination
Checkpoint pagination must be used if you need to retrieve more than 1000 connections.

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.
#### 🔌 Usage
```typescript const pageableResponse = await client.connections.list({ from: "from", take: 1, name: "name", 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.connections.list({ from: "from", take: 1, name: "name", fields: "fields", include_fields: true, }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Management.ListConnectionsQueryParameters`
**requestOptions:** `ConnectionsClient.RequestOptions`
client.connections.create({ ...params }) -> Management.CreateConnectionResponseContent
#### 📝 Description
Creates a new connection according to the JSON object received in body. Note: If a connection with the same name was recently deleted and had a large number of associated users, the deletion may still be processing. Creating a new connection with that name before the deletion completes may fail or produce unexpected results.
#### 🔌 Usage
```typescript await client.connections.create({ name: "name", strategy: "ad", }); ```
#### ⚙️ Parameters
**request:** `Management.CreateConnectionRequestContent`
**requestOptions:** `ConnectionsClient.RequestOptions`
client.connections.get(id, { ...params }) -> Management.GetConnectionResponseContent
#### 📝 Description
Retrieve details for a specified connection along with options that can be used for identity provider configuration.
#### 🔌 Usage
```typescript await client.connections.get("id", { fields: "fields", include_fields: true, }); ```
#### ⚙️ Parameters
**id:** `string` — The id of the connection to retrieve
**request:** `Management.GetConnectionRequestParameters`
**requestOptions:** `ConnectionsClient.RequestOptions`
client.connections.delete(id) -> void
#### 📝 Description
Removes a specific connection from your tenant. This action cannot be undone. Once removed, users can no longer use this connection to authenticate. Note: If your connection has a large amount of users associated with it, please be aware that this operation can be long running after the response is returned and may impact concurrent create connection requests, if they use an identical connection name.
#### 🔌 Usage
```typescript await client.connections.delete("id"); ```
#### ⚙️ Parameters
**id:** `string` — The id of the connection to delete
**requestOptions:** `ConnectionsClient.RequestOptions`
client.connections.update(id, { ...params }) -> Management.UpdateConnectionResponseContent
#### 📝 Description
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.
#### 🔌 Usage
```typescript await client.connections.update("id"); ```
#### ⚙️ Parameters
**id:** `string` — The id of the connection to update
**request:** `Management.UpdateConnectionRequestContent`
**requestOptions:** `ConnectionsClient.RequestOptions`
client.connections.checkStatus(id) -> void
#### 📝 Description
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
#### 🔌 Usage
```typescript await client.connections.checkStatus("id"); ```
#### ⚙️ Parameters
**id:** `string` — ID of the connection to check
**requestOptions:** `ConnectionsClient.RequestOptions`
## CustomDomains
client.customDomains.list({ ...params }) -> Management.ListCustomDomainsResponseContent
#### 📝 Description
Retrieve details on custom domains.
#### 🔌 Usage
```typescript await client.customDomains.list({ q: "q", fields: "fields", include_fields: true, sort: "sort", }); ```
#### ⚙️ Parameters
**request:** `Management.ListCustomDomainsRequestParameters`
**requestOptions:** `CustomDomainsClient.RequestOptions`
client.customDomains.create({ ...params }) -> Management.CreateCustomDomainResponseContent
#### 📝 Description
Create a new custom domain. Note: The custom domain will need to be verified before it will accept requests. 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
```typescript await client.customDomains.create({ domain: "domain", type: "auth0_managed_certs", }); ```
#### ⚙️ Parameters
**request:** `Management.CreateCustomDomainRequestContent`
**requestOptions:** `CustomDomainsClient.RequestOptions`
client.customDomains.getDefault() -> Management.GetDefaultDomainResponseContent
#### 📝 Description
Retrieve the tenant's default domain.
#### 🔌 Usage
```typescript await client.customDomains.getDefault(); ```
#### ⚙️ Parameters
**requestOptions:** `CustomDomainsClient.RequestOptions`
client.customDomains.setDefault({ ...params }) -> Management.UpdateDefaultDomainResponseContent
#### 📝 Description
Set the default custom domain for the tenant.
#### 🔌 Usage
```typescript await client.customDomains.setDefault({ domain: "domain", }); ```
#### ⚙️ Parameters
**request:** `Management.SetDefaultCustomDomainRequestContent`
**requestOptions:** `CustomDomainsClient.RequestOptions`
client.customDomains.get(id) -> Management.GetCustomDomainResponseContent
#### 📝 Description
Retrieve a custom domain configuration and status.
#### 🔌 Usage
```typescript await client.customDomains.get("id"); ```
#### ⚙️ Parameters
**id:** `string` — ID of the custom domain to retrieve.
**requestOptions:** `CustomDomainsClient.RequestOptions`
client.customDomains.delete(id) -> void
#### 📝 Description
Delete a custom domain and stop serving requests for it.
#### 🔌 Usage
```typescript await client.customDomains.delete("id"); ```
#### ⚙️ Parameters
**id:** `string` — ID of the custom domain to delete.
**requestOptions:** `CustomDomainsClient.RequestOptions`
client.customDomains.update(id, { ...params }) -> Management.UpdateCustomDomainResponseContent
#### 📝 Description
Update a custom domain. These are the attributes that can be updated: - custom_client_ip_header - tls_policy
Updating CUSTOM_CLIENT_IP_HEADER for a custom domain
To update the custom_client_ip_header for a domain, the body to send should be: 
{ "custom_client_ip_header": "cf-connecting-ip" }
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
```typescript await client.customDomains.update("id"); ```
#### ⚙️ Parameters
**id:** `string` — The id of the custom domain to update
**request:** `Management.UpdateCustomDomainRequestContent`
**requestOptions:** `CustomDomainsClient.RequestOptions`
client.customDomains.test(id) -> Management.TestCustomDomainResponseContent
#### 📝 Description
Run the test process on a custom domain.
#### 🔌 Usage
```typescript await client.customDomains.test("id"); ```
#### ⚙️ Parameters
**id:** `string` — ID of the custom domain to test.
**requestOptions:** `CustomDomainsClient.RequestOptions`
client.customDomains.verify(id) -> Management.VerifyCustomDomainResponseContent
#### 📝 Description
Run the verification process on a custom domain. Note: Check the status field to see its verification status. Once verification is complete, it may take up to 10 minutes before the custom domain can start accepting requests. For self_managed_certs, when the custom domain is verified for the first time, the response will also include the cname_api_key which you will need to configure your proxy. This key must be kept secret, and is used to validate the proxy requests. Learn more about verifying custom domains that use Auth0 Managed certificates. Learn more about verifying custom domains that use Self Managed certificates.
#### 🔌 Usage
```typescript await client.customDomains.verify("id"); ```
#### ⚙️ Parameters
**id:** `string` — ID of the custom domain to verify.
**requestOptions:** `CustomDomainsClient.RequestOptions`
## DeviceCredentials
client.deviceCredentials.list({ ...params }) -> core.Page<Management.DeviceCredential, Management.ListDeviceCredentialsOffsetPaginatedResponseContent>
#### 📝 Description
Retrieve device credential information (public_key, refresh_token, or rotating_refresh_token) associated with a specific user.
#### 🔌 Usage
```typescript const pageableResponse = await client.deviceCredentials.list({ page: 1, per_page: 1, include_totals: true, fields: "fields", include_fields: true, user_id: "user_id", client_id: "client_id", type: "public_key", }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.deviceCredentials.list({ page: 1, per_page: 1, include_totals: true, fields: "fields", include_fields: true, user_id: "user_id", client_id: "client_id", type: "public_key", }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Management.ListDeviceCredentialsRequestParameters`
**requestOptions:** `DeviceCredentialsClient.RequestOptions`
client.deviceCredentials.createPublicKey({ ...params }) -> Management.CreatePublicKeyDeviceCredentialResponseContent
#### 📝 Description
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.
#### 🔌 Usage
```typescript await client.deviceCredentials.createPublicKey({ device_name: "device_name", type: "public_key", value: "value", device_id: "device_id", }); ```
#### ⚙️ Parameters
**request:** `Management.CreatePublicKeyDeviceCredentialRequestContent`
**requestOptions:** `DeviceCredentialsClient.RequestOptions`
client.deviceCredentials.delete(id) -> void
#### 📝 Description
Permanently delete a device credential (such as a refresh token or public key) with the given ID.
#### 🔌 Usage
```typescript await client.deviceCredentials.delete("id"); ```
#### ⚙️ Parameters
**id:** `string` — ID of the credential to delete.
**requestOptions:** `DeviceCredentialsClient.RequestOptions`
## EmailTemplates
client.emailTemplates.create({ ...params }) -> Management.CreateEmailTemplateResponseContent
#### 📝 Description
Create an email template.
#### 🔌 Usage
```typescript await client.emailTemplates.create({ template: "verify_email", }); ```
#### ⚙️ Parameters
**request:** `Management.CreateEmailTemplateRequestContent`
**requestOptions:** `EmailTemplatesClient.RequestOptions`
client.emailTemplates.get(templateName) -> Management.GetEmailTemplateResponseContent
#### 📝 Description
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.
#### 🔌 Usage
```typescript await client.emailTemplates.get("verify_email"); ```
#### ⚙️ Parameters
**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:** `EmailTemplatesClient.RequestOptions`
client.emailTemplates.set(templateName, { ...params }) -> Management.SetEmailTemplateResponseContent
#### 📝 Description
Update an email template.
#### 🔌 Usage
```typescript await client.emailTemplates.set("verify_email", { template: "verify_email", }); ```
#### ⚙️ Parameters
**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`
**requestOptions:** `EmailTemplatesClient.RequestOptions`
client.emailTemplates.update(templateName, { ...params }) -> Management.UpdateEmailTemplateResponseContent
#### 📝 Description
Modify an email template.
#### 🔌 Usage
```typescript await client.emailTemplates.update("verify_email"); ```
#### ⚙️ Parameters
**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`
**requestOptions:** `EmailTemplatesClient.RequestOptions`
## EventStreams
client.eventStreams.list({ ...params }) -> core.Page<Management.EventStreamResponseContent, Management.ListEventStreamsResponseContent>
#### 🔌 Usage
```typescript const pageableResponse = await client.eventStreams.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.eventStreams.list({ from: "from", take: 1, }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Management.ListEventStreamsRequestParameters`
**requestOptions:** `EventStreamsClient.RequestOptions`
client.eventStreams.create({ ...params }) -> Management.CreateEventStreamResponseContent
#### 🔌 Usage
```typescript await client.eventStreams.create({ destination: { type: "webhook", configuration: { webhook_endpoint: "webhook_endpoint", webhook_authorization: { method: "basic", username: "username", }, }, }, }); ```
#### ⚙️ Parameters
**request:** `Management.EventStreamsCreateRequest`
**requestOptions:** `EventStreamsClient.RequestOptions`
client.eventStreams.get(id) -> Management.GetEventStreamResponseContent
#### 🔌 Usage
```typescript await client.eventStreams.get("id"); ```
#### ⚙️ Parameters
**id:** `string` — Unique identifier for the event stream.
**requestOptions:** `EventStreamsClient.RequestOptions`
client.eventStreams.delete(id) -> void
#### 🔌 Usage
```typescript await client.eventStreams.delete("id"); ```
#### ⚙️ Parameters
**id:** `string` — Unique identifier for the event stream.
**requestOptions:** `EventStreamsClient.RequestOptions`
client.eventStreams.update(id, { ...params }) -> Management.UpdateEventStreamResponseContent
#### 🔌 Usage
```typescript await client.eventStreams.update("id"); ```
#### ⚙️ Parameters
**id:** `string` — Unique identifier for the event stream.
**request:** `Management.UpdateEventStreamRequestContent`
**requestOptions:** `EventStreamsClient.RequestOptions`
client.eventStreams.test(id, { ...params }) -> Management.CreateEventStreamTestEventResponseContent
#### 🔌 Usage
```typescript await client.eventStreams.test("id", { event_type: "group.created", }); ```
#### ⚙️ Parameters
**id:** `string` — Unique identifier for the event stream.
**request:** `Management.CreateEventStreamTestEventRequestContent`
**requestOptions:** `EventStreamsClient.RequestOptions`
## Flows
client.flows.list({ ...params }) -> core.Page<Management.FlowSummary, Management.ListFlowsOffsetPaginatedResponseContent>
#### 🔌 Usage
```typescript const pageableResponse = await client.flows.list({ page: 1, per_page: 1, include_totals: true, synchronous: true, }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.flows.list({ page: 1, per_page: 1, include_totals: true, synchronous: true, }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Management.ListFlowsRequestParameters`
**requestOptions:** `FlowsClient.RequestOptions`
client.flows.create({ ...params }) -> Management.CreateFlowResponseContent
#### 🔌 Usage
```typescript await client.flows.create({ name: "name", }); ```
#### ⚙️ Parameters
**request:** `Management.CreateFlowRequestContent`
**requestOptions:** `FlowsClient.RequestOptions`
client.flows.get(id, { ...params }) -> Management.GetFlowResponseContent
#### 🔌 Usage
```typescript await client.flows.get("id"); ```
#### ⚙️ Parameters
**id:** `string` — Flow identifier
**request:** `Management.GetFlowRequestParameters`
**requestOptions:** `FlowsClient.RequestOptions`
client.flows.delete(id) -> void
#### 🔌 Usage
```typescript await client.flows.delete("id"); ```
#### ⚙️ Parameters
**id:** `string` — Flow id
**requestOptions:** `FlowsClient.RequestOptions`
client.flows.update(id, { ...params }) -> Management.UpdateFlowResponseContent
#### 🔌 Usage
```typescript await client.flows.update("id"); ```
#### ⚙️ Parameters
**id:** `string` — Flow identifier
**request:** `Management.UpdateFlowRequestContent`
**requestOptions:** `FlowsClient.RequestOptions`
## Forms
client.forms.list({ ...params }) -> core.Page<Management.FormSummary, Management.ListFormsOffsetPaginatedResponseContent>
#### 🔌 Usage
```typescript const pageableResponse = await client.forms.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.forms.list({ page: 1, per_page: 1, include_totals: true, }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Management.ListFormsRequestParameters`
**requestOptions:** `FormsClient.RequestOptions`
client.forms.create({ ...params }) -> Management.CreateFormResponseContent
#### 🔌 Usage
```typescript await client.forms.create({ name: "name", }); ```
#### ⚙️ Parameters
**request:** `Management.CreateFormRequestContent`
**requestOptions:** `FormsClient.RequestOptions`
client.forms.get(id, { ...params }) -> Management.GetFormResponseContent
#### 🔌 Usage
```typescript await client.forms.get("id"); ```
#### ⚙️ Parameters
**id:** `string` — The ID of the form to retrieve.
**request:** `Management.GetFormRequestParameters`
**requestOptions:** `FormsClient.RequestOptions`
client.forms.delete(id) -> void
#### 🔌 Usage
```typescript await client.forms.delete("id"); ```
#### ⚙️ Parameters
**id:** `string` — The ID of the form to delete.
**requestOptions:** `FormsClient.RequestOptions`
client.forms.update(id, { ...params }) -> Management.UpdateFormResponseContent
#### 🔌 Usage
```typescript await client.forms.update("id"); ```
#### ⚙️ Parameters
**id:** `string` — The ID of the form to update.
**request:** `Management.UpdateFormRequestContent`
**requestOptions:** `FormsClient.RequestOptions`
## UserGrants
client.userGrants.list({ ...params }) -> core.Page<Management.UserGrant, Management.ListUserGrantsOffsetPaginatedResponseContent>
#### 📝 Description
Retrieve the grants associated with your account.
#### 🔌 Usage
```typescript const pageableResponse = await client.userGrants.list({ per_page: 1, page: 1, include_totals: true, user_id: "user_id", client_id: "client_id", audience: "audience", }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.userGrants.list({ per_page: 1, page: 1, include_totals: true, user_id: "user_id", client_id: "client_id", audience: "audience", }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Management.ListUserGrantsRequestParameters`
**requestOptions:** `UserGrantsClient.RequestOptions`
client.userGrants.deleteByUserId({ ...params }) -> void
#### 📝 Description
Delete a grant associated with your account.
#### 🔌 Usage
```typescript await client.userGrants.deleteByUserId({ user_id: "user_id", }); ```
#### ⚙️ Parameters
**request:** `Management.DeleteUserGrantByUserIdRequestParameters`
**requestOptions:** `UserGrantsClient.RequestOptions`
client.userGrants.delete(id) -> void
#### 📝 Description
Delete a grant associated with your account.
#### 🔌 Usage
```typescript await client.userGrants.delete("id"); ```
#### ⚙️ Parameters
**id:** `string` — ID of the grant to delete.
**requestOptions:** `UserGrantsClient.RequestOptions`
## Groups
client.groups.list({ ...params }) -> core.Page<Management.Group, Management.ListGroupsPaginatedResponseContent>
#### 📝 Description
List all groups in your tenant.
#### 🔌 Usage
```typescript const pageableResponse = await client.groups.list({ connection_id: "connection_id", name: "name", external_id: "external_id", fields: "fields", include_fields: true, 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.groups.list({ connection_id: "connection_id", name: "name", external_id: "external_id", fields: "fields", include_fields: true, from: "from", take: 1, }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Management.ListGroupsRequestParameters`
**requestOptions:** `GroupsClient.RequestOptions`
client.groups.get(id) -> Management.GetGroupResponseContent
#### 📝 Description
Retrieve a group by its ID.
#### 🔌 Usage
```typescript await client.groups.get("id"); ```
#### ⚙️ Parameters
**id:** `string` — Unique identifier for the group (service-generated).
**requestOptions:** `GroupsClient.RequestOptions`
client.groups.delete(id) -> void
#### 📝 Description
Delete a group by its ID.
#### 🔌 Usage
```typescript await client.groups.delete("id"); ```
#### ⚙️ Parameters
**id:** `string` — Unique identifier for the group (service-generated).
**requestOptions:** `GroupsClient.RequestOptions`
## Hooks
client.hooks.list({ ...params }) -> core.Page<Management.Hook, Management.ListHooksOffsetPaginatedResponseContent>
#### 📝 Description
Retrieve all hooks. Accepts a list of fields to include or exclude in the result.
#### 🔌 Usage
```typescript const pageableResponse = await client.hooks.list({ page: 1, per_page: 1, include_totals: true, enabled: true, fields: "fields", triggerId: "credentials-exchange", }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.hooks.list({ page: 1, per_page: 1, include_totals: true, enabled: true, fields: "fields", triggerId: "credentials-exchange", }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Management.ListHooksRequestParameters`
**requestOptions:** `HooksClient.RequestOptions`
client.hooks.create({ ...params }) -> Management.CreateHookResponseContent
#### 📝 Description
Create a new hook.
#### 🔌 Usage
```typescript await client.hooks.create({ name: "name", script: "script", triggerId: "credentials-exchange", }); ```
#### ⚙️ Parameters
**request:** `Management.CreateHookRequestContent`
**requestOptions:** `HooksClient.RequestOptions`
client.hooks.get(id, { ...params }) -> Management.GetHookResponseContent
#### 📝 Description
Retrieve a hook by its ID. Accepts a list of fields to include in the result.
#### 🔌 Usage
```typescript await client.hooks.get("id", { fields: "fields", }); ```
#### ⚙️ Parameters
**id:** `string` — ID of the hook to retrieve.
**request:** `Management.GetHookRequestParameters`
**requestOptions:** `HooksClient.RequestOptions`
client.hooks.delete(id) -> void
#### 📝 Description
Delete a hook.
#### 🔌 Usage
```typescript await client.hooks.delete("id"); ```
#### ⚙️ Parameters
**id:** `string` — ID of the hook to delete.
**requestOptions:** `HooksClient.RequestOptions`
client.hooks.update(id, { ...params }) -> Management.UpdateHookResponseContent
#### 📝 Description
Update an existing hook.
#### 🔌 Usage
```typescript await client.hooks.update("id"); ```
#### ⚙️ Parameters
**id:** `string` — ID of the hook to update.
**request:** `Management.UpdateHookRequestContent`
**requestOptions:** `HooksClient.RequestOptions`
## Jobs
client.jobs.get(id) -> Management.GetJobResponseContent
#### 📝 Description
Retrieves a job. Useful to check its status.
#### 🔌 Usage
```typescript await client.jobs.get("id"); ```
#### ⚙️ Parameters
**id:** `string` — ID of the job.
**requestOptions:** `JobsClient.RequestOptions`
## LogStreams
client.logStreams.list() -> Management.LogStreamResponseSchema[]
#### 📝 Description
Retrieve details on log streams.
Sample Response
[{
	"id": "string",
	"name": "string",
	"type": "eventbridge",
	"status": "active|paused|suspended",
	"sink": {
		"awsAccountId": "string",
		"awsRegion": "string",
		"awsPartnerEventSource": "string"
	}
}, {
	"id": "string",
	"name": "string",
	"type": "http",
	"status": "active|paused|suspended",
	"sink": {
		"httpContentFormat": "JSONLINES|JSONARRAY",
		"httpContentType": "string",
		"httpEndpoint": "string",
		"httpAuthorization": "string"
	}
},
{
	"id": "string",
	"name": "string",
	"type": "eventgrid",
	"status": "active|paused|suspended",
	"sink": {
		"azureSubscriptionId": "string",
		"azureResourceGroup": "string",
		"azureRegion": "string",
		"azurePartnerTopic": "string"
	}
},
{
	"id": "string",
	"name": "string",
	"type": "splunk",
	"status": "active|paused|suspended",
	"sink": {
		"splunkDomain": "string",
		"splunkToken": "string",
		"splunkPort": "string",
		"splunkSecure": "boolean"
	}
},
{
	"id": "string",
	"name": "string",
	"type": "sumo",
	"status": "active|paused|suspended",
	"sink": {
		"sumoSourceAddress": "string",
	}
},
{
	"id": "string",
	"name": "string",
	"type": "datadog",
	"status": "active|paused|suspended",
	"sink": {
		"datadogRegion": "string",
		"datadogApiKey": "string"
	}
}]
#### 🔌 Usage
```typescript await client.logStreams.list(); ```
#### ⚙️ Parameters
**requestOptions:** `LogStreamsClient.RequestOptions`
client.logStreams.create({ ...params }) -> Management.CreateLogStreamResponseContent
#### 📝 Description
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: 
{
	"name": "string",
	"type": "http",
	"sink": {
		"httpEndpoint": "string",
		"httpContentType": "string",
		"httpContentFormat": "JSONLINES|JSONARRAY",
		"httpAuthorization": "string"
	}
}
Response: 
{
	"id": "string",
	"name": "string",
	"type": "http",
	"status": "active",
	"sink": {
		"httpEndpoint": "string",
		"httpContentType": "string",
		"httpContentFormat": "JSONLINES|JSONARRAY",
		"httpAuthorization": "string"
	}
}
Amazon EventBridge Stream
For an eventbridge Stream, the sink properties are listed in the payload below Request: 
{
	"name": "string",
	"type": "eventbridge",
	"sink": {
		"awsRegion": "string",
		"awsAccountId": "string"
	}
}
The response will include an additional field awsPartnerEventSource in the sink: 
{
	"id": "string",
	"name": "string",
	"type": "eventbridge",
	"status": "active",
	"sink": {
		"awsAccountId": "string",
		"awsRegion": "string",
		"awsPartnerEventSource": "string"
	}
}
Azure Event Grid Stream
For an Azure Event Grid Stream, the sink properties are listed in the payload below Request: 
{
	"name": "string",
	"type": "eventgrid",
	"sink": {
		"azureSubscriptionId": "string",
		"azureResourceGroup": "string",
		"azureRegion": "string"
	}
}
Response: 
{
	"id": "string",
	"name": "string",
	"type": "http",
	"status": "active",
	"sink": {
		"azureSubscriptionId": "string",
		"azureResourceGroup": "string",
		"azureRegion": "string",
		"azurePartnerTopic": "string"
	}
}
Datadog Stream
For a Datadog Stream, the sink properties are listed in the payload below Request: 
{
	"name": "string",
	"type": "datadog",
	"sink": {
		"datadogRegion": "string",
		"datadogApiKey": "string"
	}
}
Response: 
{
	"id": "string",
	"name": "string",
	"type": "datadog",
	"status": "active",
	"sink": {
		"datadogRegion": "string",
		"datadogApiKey": "string"
	}
}
Splunk Stream
For a Splunk Stream, the sink properties are listed in the payload below Request: 
{
	"name": "string",
	"type": "splunk",
	"sink": {
		"splunkDomain": "string",
		"splunkToken": "string",
		"splunkPort": "string",
		"splunkSecure": "boolean"
	}
}
Response: 
{
	"id": "string",
	"name": "string",
	"type": "splunk",
	"status": "active",
	"sink": {
		"splunkDomain": "string",
		"splunkToken": "string",
		"splunkPort": "string",
		"splunkSecure": "boolean"
	}
}
Sumo Logic Stream
For a Sumo Logic Stream, the sink properties are listed in the payload below Request: 
{
	"name": "string",
	"type": "sumo",
	"sink": {
		"sumoSourceAddress": "string",
	}
}
Response: 
{
	"id": "string",
	"name": "string",
	"type": "sumo",
	"status": "active",
	"sink": {
		"sumoSourceAddress": "string",
	}
}
#### 🔌 Usage
```typescript await client.logStreams.create({ type: "http", sink: { httpEndpoint: "httpEndpoint", }, }); ```
#### ⚙️ Parameters
**request:** `Management.CreateLogStreamRequestContent`
**requestOptions:** `LogStreamsClient.RequestOptions`
client.logStreams.get(id) -> Management.GetLogStreamResponseContent
#### 📝 Description
Retrieve a log stream configuration and status.
Sample responses
Amazon EventBridge Log Stream
{
	"id": "string",
	"name": "string",
	"type": "eventbridge",
	"status": "active|paused|suspended",
	"sink": {
		"awsAccountId": "string",
		"awsRegion": "string",
		"awsPartnerEventSource": "string"
	}
}
HTTP Log Stream
{
	"id": "string",
	"name": "string",
	"type": "http",
	"status": "active|paused|suspended",
	"sink": {
		"httpContentFormat": "JSONLINES|JSONARRAY",
		"httpContentType": "string",
		"httpEndpoint": "string",
		"httpAuthorization": "string"
	}
}
Datadog Log Stream
{
	"id": "string",
	"name": "string",
	"type": "datadog",
	"status": "active|paused|suspended",
	"sink": {
		"datadogRegion": "string",
		"datadogApiKey": "string"
	}

}
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"
      }
    }
Splunk Log Stream
{
	"id": "string",
	"name": "string",
	"type": "splunk",
	"status": "active|paused|suspended",
	"sink": {
		"splunkDomain": "string",
		"splunkToken": "string",
		"splunkPort": "string",
		"splunkSecure": "boolean"
	}
}
Sumo Logic Log Stream
{
	"id": "string",
	"name": "string",
	"type": "sumo",
	"status": "active|paused|suspended",
	"sink": {
		"sumoSourceAddress": "string",
	}
}
Status
The status of a log stream maybe any of the following: 1. active - Stream is currently enabled. 2. paused - Stream is currently user disabled and will not attempt log delivery. 3. suspended - Stream is currently disabled because of errors and will not attempt log delivery.
#### 🔌 Usage
```typescript await client.logStreams.get("id"); ```
#### ⚙️ Parameters
**id:** `string` — The id of the log stream to get
**requestOptions:** `LogStreamsClient.RequestOptions`
client.logStreams.delete(id) -> void
#### 📝 Description
Delete a log stream.
#### 🔌 Usage
```typescript await client.logStreams.delete("id"); ```
#### ⚙️ Parameters
**id:** `string` — The id of the log stream to delete
**requestOptions:** `LogStreamsClient.RequestOptions`
client.logStreams.update(id, { ...params }) -> Management.UpdateLogStreamResponseContent
#### 📝 Description
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"
}
Update the name of a log stream
{
	"name": "string"
}
Update the sink properties of a stream of type http
{
  "sink": {
    "httpEndpoint": "string",
    "httpContentType": "string",
    "httpContentFormat": "JSONARRAY|JSONLINES",
    "httpAuthorization": "string"
  }
}
Update the sink properties of a stream of type datadog
{
  "sink": {
		"datadogRegion": "string",
		"datadogApiKey": "string"
  }
}
Update the sink properties of a stream of type splunk
{
  "sink": {
    "splunkDomain": "string",
    "splunkToken": "string",
    "splunkPort": "string",
    "splunkSecure": "boolean"
  }
}
Update the sink properties of a stream of type sumo
{
  "sink": {
    "sumoSourceAddress": "string"
  }
}
#### 🔌 Usage
```typescript await client.logStreams.update("id"); ```
#### ⚙️ Parameters
**id:** `string` — The id of the log stream to get
**request:** `Management.UpdateLogStreamRequestContent`
**requestOptions:** `LogStreamsClient.RequestOptions`
## Logs
client.logs.list({ ...params }) -> core.Page<Management.Log, Management.ListLogOffsetPaginatedResponseContent>
#### 📝 Description
Retrieve log entries that match the specified search criteria (or all log entries if no criteria specified). Set custom search criteria using the q parameter, or search from a specific log ID ("search from checkpoint"). For more information on all possible event types, their respective acronyms, and descriptions, see Log Event Type Codes.
To set custom search criteria, use the following parameters:
  • q: Search Criteria using Query String Syntax
  • page: Page index of the results to return. First page is 0.
  • per_page: Number of results per page.
  • sort: Field to use for sorting appended with `:1` for ascending and `:-1` for descending. e.g. `date:-1`
  • fields: Comma-separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve all fields.
  • include_fields: Whether specified fields are to be included (true) or excluded (false).
  • include_totals: Return results inside an object that contains the total result count (true) or as a direct array of results (false, default). Deprecated: this field is deprecated and should be removed from use. See Search Engine V3 Breaking Changes
For more information on the list of fields that can be used in fields and sort, see Searchable Fields. Auth0 limits the number of logs you can return by search criteria to 100 logs per request. Furthermore, you may paginate only through 1,000 search results. If you exceed this threshold, please redefine your search or use the get logs by checkpoint method.
To search from a checkpoint log ID, use the following parameters:
  • from: Log Event ID from which to start retrieving logs. You can limit the number of logs returned using the take parameter. If you use from at the same time as q, from takes precedence and q is ignored.
  • take: Number of entries to retrieve when using the from parameter.
Important: When fetching logs from a checkpoint log ID, any parameter other than from and take will be ignored, and date ordering is not guaranteed.
#### 🔌 Usage
```typescript const pageableResponse = await client.logs.list({ page: 1, per_page: 1, sort: "sort", fields: "fields", include_fields: true, include_totals: true, search: "search", }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.logs.list({ page: 1, per_page: 1, sort: "sort", fields: "fields", include_fields: true, include_totals: true, search: "search", }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Management.ListLogsRequestParameters`
**requestOptions:** `LogsClient.RequestOptions`
client.logs.get(id) -> Management.GetLogResponseContent
#### 📝 Description
Retrieve an individual log event.
#### 🔌 Usage
```typescript await client.logs.get("id"); ```
#### ⚙️ Parameters
**id:** `string` — log_id of the log to retrieve.
**requestOptions:** `LogsClient.RequestOptions`
## NetworkAcls
client.networkAcls.list({ ...params }) -> core.Page<Management.NetworkAclsResponseContent, Management.ListNetworkAclsOffsetPaginatedResponseContent>
#### 📝 Description
Get all access control list entries for your client.
#### 🔌 Usage
```typescript const pageableResponse = await client.networkAcls.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.networkAcls.list({ page: 1, per_page: 1, include_totals: true, }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Management.ListNetworkAclsRequestParameters`
**requestOptions:** `NetworkAclsClient.RequestOptions`
client.networkAcls.create({ ...params }) -> void
#### 📝 Description
Create a new access control list for your client.
#### 🔌 Usage
```typescript await client.networkAcls.create({ description: "description", active: true, rule: { action: {}, scope: "management", }, }); ```
#### ⚙️ Parameters
**request:** `Management.CreateNetworkAclRequestContent`
**requestOptions:** `NetworkAclsClient.RequestOptions`
client.networkAcls.get(id) -> Management.GetNetworkAclsResponseContent
#### 📝 Description
Get a specific access control list entry for your client.
#### 🔌 Usage
```typescript await client.networkAcls.get("id"); ```
#### ⚙️ Parameters
**id:** `string` — The id of the access control list to retrieve.
**requestOptions:** `NetworkAclsClient.RequestOptions`
client.networkAcls.set(id, { ...params }) -> Management.SetNetworkAclsResponseContent
#### 📝 Description
Update existing access control list for your client.
#### 🔌 Usage
```typescript await client.networkAcls.set("id", { description: "description", active: true, rule: { action: {}, scope: "management", }, }); ```
#### ⚙️ Parameters
**id:** `string` — The id of the ACL to update.
**request:** `Management.SetNetworkAclRequestContent`
**requestOptions:** `NetworkAclsClient.RequestOptions`
client.networkAcls.delete(id) -> void
#### 📝 Description
Delete existing access control list for your client.
#### 🔌 Usage
```typescript await client.networkAcls.delete("id"); ```
#### ⚙️ Parameters
**id:** `string` — The id of the ACL to delete
**requestOptions:** `NetworkAclsClient.RequestOptions`
client.networkAcls.update(id, { ...params }) -> Management.UpdateNetworkAclResponseContent
#### 📝 Description
Update existing access control list for your client.
#### 🔌 Usage
```typescript await client.networkAcls.update("id"); ```
#### ⚙️ Parameters
**id:** `string` — The id of the ACL to update.
**request:** `Management.UpdateNetworkAclRequestContent`
**requestOptions:** `NetworkAclsClient.RequestOptions`
## Organizations
client.organizations.list({ ...params }) -> core.Page<Management.Organization, Management.ListOrganizationsPaginatedResponseContent>
#### 📝 Description
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
Checkpoint pagination must be used if you need to retrieve more than 1000 organizations.

Checkpoint Pagination

To search by checkpoint, use the following parameters:
  • from: Optional id from which to start selection.
  • take: The total number of entries to retrieve when using the from parameter. Defaults to 50.
Note: The first time you call this endpoint using checkpoint pagination, omit the from parameter. If there are more results, a next value is included in the response. You can use this for subsequent API calls. When next is no longer included in the response, no pages are remaining.
#### 🔌 Usage
```typescript const pageableResponse = await client.organizations.list({ from: "from", take: 1, sort: "sort", }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.organizations.list({ from: "from", take: 1, sort: "sort", }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Management.ListOrganizationsRequestParameters`
**requestOptions:** `OrganizationsClient.RequestOptions`
client.organizations.create({ ...params }) -> Management.CreateOrganizationResponseContent
#### 📝 Description
Create a new Organization within your tenant. To learn more about Organization settings, behavior, and configuration options, review Create Your First Organization.
#### 🔌 Usage
```typescript await client.organizations.create({ name: "name", }); ```
#### ⚙️ Parameters
**request:** `Management.CreateOrganizationRequestContent`
**requestOptions:** `OrganizationsClient.RequestOptions`
client.organizations.getByName(name) -> Management.GetOrganizationByNameResponseContent
#### 📝 Description
Retrieve details about a single Organization specified by name.
#### 🔌 Usage
```typescript await client.organizations.getByName("name"); ```
#### ⚙️ Parameters
**name:** `string` — name of the organization to retrieve.
**requestOptions:** `OrganizationsClient.RequestOptions`
client.organizations.get(id) -> Management.GetOrganizationResponseContent
#### 📝 Description
Retrieve details about a single Organization specified by ID.
#### 🔌 Usage
```typescript await client.organizations.get("id"); ```
#### ⚙️ Parameters
**id:** `string` — ID of the organization to retrieve.
**requestOptions:** `OrganizationsClient.RequestOptions`
client.organizations.delete(id) -> void
#### 📝 Description
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.
#### 🔌 Usage
```typescript await client.organizations.delete("id"); ```
#### ⚙️ Parameters
**id:** `string` — Organization identifier.
**requestOptions:** `OrganizationsClient.RequestOptions`
client.organizations.update(id, { ...params }) -> Management.UpdateOrganizationResponseContent
#### 📝 Description
Update the details of a specific Organization, such as name and display name, branding options, and metadata.
#### 🔌 Usage
```typescript await client.organizations.update("id"); ```
#### ⚙️ Parameters
**id:** `string` — ID of the organization to update.
**request:** `Management.UpdateOrganizationRequestContent`
**requestOptions:** `OrganizationsClient.RequestOptions`
## Prompts
client.prompts.getSettings() -> Management.GetSettingsResponseContent
#### 📝 Description
Retrieve details of the Universal Login configuration of your tenant. This includes the Identifier First Authentication and WebAuthn with Device Biometrics for MFA features.
#### 🔌 Usage
```typescript await client.prompts.getSettings(); ```
#### ⚙️ Parameters
**requestOptions:** `PromptsClient.RequestOptions`
client.prompts.updateSettings({ ...params }) -> Management.UpdateSettingsResponseContent
#### 📝 Description
Update the Universal Login configuration of your tenant. This includes the Identifier First Authentication and WebAuthn with Device Biometrics for MFA features.
#### 🔌 Usage
```typescript await client.prompts.updateSettings(); ```
#### ⚙️ Parameters
**request:** `Management.UpdateSettingsRequestContent`
**requestOptions:** `PromptsClient.RequestOptions`
## RefreshTokens
client.refreshTokens.list({ ...params }) -> core.Page<Management.RefreshTokenResponseContent, Management.GetRefreshTokensPaginatedResponseContent>
#### 📝 Description
Retrieve a paginated list of refresh tokens for a specific user, with optional filtering by client ID. Results are sorted by credential_id ascending.
#### 🔌 Usage
```typescript const pageableResponse = await client.refreshTokens.list({ user_id: "user_id", client_id: "client_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.refreshTokens.list({ user_id: "user_id", client_id: "client_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; ```
#### ⚙️ Parameters
**request:** `Management.GetRefreshTokensRequestParameters`
**requestOptions:** `RefreshTokensClient.RequestOptions`
client.refreshTokens.get(id) -> Management.GetRefreshTokenResponseContent
#### 📝 Description
Retrieve refresh token information.
#### 🔌 Usage
```typescript await client.refreshTokens.get("id"); ```
#### ⚙️ Parameters
**id:** `string` — ID refresh token to retrieve
**requestOptions:** `RefreshTokensClient.RequestOptions`
client.refreshTokens.delete(id) -> void
#### 📝 Description
Delete a refresh token by its ID.
#### 🔌 Usage
```typescript await client.refreshTokens.delete("id"); ```
#### ⚙️ Parameters
**id:** `string` — ID of the refresh token to delete.
**requestOptions:** `RefreshTokensClient.RequestOptions`
client.refreshTokens.update(id, { ...params }) -> Management.UpdateRefreshTokenResponseContent
#### 📝 Description
Update a refresh token by its ID.
#### 🔌 Usage
```typescript await client.refreshTokens.update("id"); ```
#### ⚙️ Parameters
**id:** `string` — ID of the refresh token to update.
**request:** `Management.UpdateRefreshTokenRequestContent`
**requestOptions:** `RefreshTokensClient.RequestOptions`
## ResourceServers
client.resourceServers.list({ ...params }) -> core.Page<Management.ResourceServer, Management.ListResourceServerOffsetPaginatedResponseContent>
#### 📝 Description
Retrieve details of all APIs associated with your tenant.
#### 🔌 Usage
```typescript const pageableResponse = await client.resourceServers.list({ page: 1, per_page: 1, include_totals: true, include_fields: true, }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.resourceServers.list({ page: 1, per_page: 1, include_totals: true, include_fields: true, }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Management.ListResourceServerRequestParameters`
**requestOptions:** `ResourceServersClient.RequestOptions`
client.resourceServers.create({ ...params }) -> Management.CreateResourceServerResponseContent
#### 📝 Description
Create a new API associated with your tenant. Note that all new APIs must be registered with Auth0. For more information, read APIs.
#### 🔌 Usage
```typescript await client.resourceServers.create({ identifier: "identifier", }); ```
#### ⚙️ Parameters
**request:** `Management.CreateResourceServerRequestContent`
**requestOptions:** `ResourceServersClient.RequestOptions`
client.resourceServers.get(id, { ...params }) -> Management.GetResourceServerResponseContent
#### 📝 Description
Retrieve API details with the given ID.
#### 🔌 Usage
```typescript await client.resourceServers.get("id", { include_fields: true, }); ```
#### ⚙️ Parameters
**id:** `string` — ID or audience of the resource server to retrieve.
**request:** `Management.GetResourceServerRequestParameters`
**requestOptions:** `ResourceServersClient.RequestOptions`
client.resourceServers.delete(id) -> void
#### 📝 Description
Delete an existing API by ID. For more information, read API Settings.
#### 🔌 Usage
```typescript await client.resourceServers.delete("id"); ```
#### ⚙️ Parameters
**id:** `string` — ID or the audience of the resource server to delete.
**requestOptions:** `ResourceServersClient.RequestOptions`
client.resourceServers.update(id, { ...params }) -> Management.UpdateResourceServerResponseContent
#### 📝 Description
Change an existing API setting by resource server ID. For more information, read API Settings.
#### 🔌 Usage
```typescript await client.resourceServers.update("id"); ```
#### ⚙️ Parameters
**id:** `string` — ID or audience of the resource server to update.
**request:** `Management.UpdateResourceServerRequestContent`
**requestOptions:** `ResourceServersClient.RequestOptions`
## Roles
client.roles.list({ ...params }) -> core.Page<Management.Role, Management.ListRolesOffsetPaginatedResponseContent>
#### 📝 Description
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.
#### 🔌 Usage
```typescript const pageableResponse = await client.roles.list({ per_page: 1, page: 1, include_totals: true, name_filter: "name_filter", }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.roles.list({ per_page: 1, page: 1, include_totals: true, name_filter: "name_filter", }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Management.ListRolesRequestParameters`
**requestOptions:** `RolesClient.RequestOptions`
client.roles.create({ ...params }) -> Management.CreateRoleResponseContent
#### 📝 Description
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.
#### 🔌 Usage
```typescript await client.roles.create({ name: "name", }); ```
#### ⚙️ Parameters
**request:** `Management.CreateRoleRequestContent`
**requestOptions:** `RolesClient.RequestOptions`
client.roles.get(id) -> Management.GetRoleResponseContent
#### 📝 Description
Retrieve details about a specific user role specified by ID.
#### 🔌 Usage
```typescript await client.roles.get("id"); ```
#### ⚙️ Parameters
**id:** `string` — ID of the role to retrieve.
**requestOptions:** `RolesClient.RequestOptions`
client.roles.delete(id) -> void
#### 📝 Description
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.
#### 🔌 Usage
```typescript await client.roles.delete("id"); ```
#### ⚙️ Parameters
**id:** `string` — ID of the role to delete.
**requestOptions:** `RolesClient.RequestOptions`
client.roles.update(id, { ...params }) -> Management.UpdateRoleResponseContent
#### 📝 Description
Modify the details of a specific user role specified by ID.
#### 🔌 Usage
```typescript await client.roles.update("id"); ```
#### ⚙️ Parameters
**id:** `string` — ID of the role to update.
**request:** `Management.UpdateRoleRequestContent`
**requestOptions:** `RolesClient.RequestOptions`
## Rules
client.rules.list({ ...params }) -> core.Page<Management.Rule, Management.ListRulesOffsetPaginatedResponseContent>
#### 📝 Description
Retrieve a filtered list of rules. Accepts a list of fields to include or exclude.
#### 🔌 Usage
```typescript const pageableResponse = await client.rules.list({ page: 1, per_page: 1, include_totals: true, enabled: true, 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.rules.list({ page: 1, per_page: 1, include_totals: true, enabled: true, fields: "fields", include_fields: true, }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Management.ListRulesRequestParameters`
**requestOptions:** `RulesClient.RequestOptions`
client.rules.create({ ...params }) -> Management.CreateRuleResponseContent
#### 📝 Description
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.
#### 🔌 Usage
```typescript await client.rules.create({ name: "name", script: "script", }); ```
#### ⚙️ Parameters
**request:** `Management.CreateRuleRequestContent`
**requestOptions:** `RulesClient.RequestOptions`
client.rules.get(id, { ...params }) -> Management.GetRuleResponseContent
#### 📝 Description
Retrieve rule details. Accepts a list of fields to include or exclude in the result.
#### 🔌 Usage
```typescript await client.rules.get("id", { fields: "fields", include_fields: true, }); ```
#### ⚙️ Parameters
**id:** `string` — ID of the rule to retrieve.
**request:** `Management.GetRuleRequestParameters`
**requestOptions:** `RulesClient.RequestOptions`
client.rules.delete(id) -> void
#### 📝 Description
Delete a rule.
#### 🔌 Usage
```typescript await client.rules.delete("id"); ```
#### ⚙️ Parameters
**id:** `string` — ID of the rule to delete.
**requestOptions:** `RulesClient.RequestOptions`
client.rules.update(id, { ...params }) -> Management.UpdateRuleResponseContent
#### 📝 Description
Update an existing rule.
#### 🔌 Usage
```typescript await client.rules.update("id"); ```
#### ⚙️ Parameters
**id:** `string` — ID of the rule to retrieve.
**request:** `Management.UpdateRuleRequestContent`
**requestOptions:** `RulesClient.RequestOptions`
## RulesConfigs
client.rulesConfigs.list() -> Management.RulesConfig[]
#### 📝 Description
Retrieve rules config variable keys. Note: For security, config variable values cannot be retrieved outside rule execution.
#### 🔌 Usage
```typescript await client.rulesConfigs.list(); ```
#### ⚙️ Parameters
**requestOptions:** `RulesConfigsClient.RequestOptions`
client.rulesConfigs.set(key, { ...params }) -> Management.SetRulesConfigResponseContent
#### 📝 Description
Sets a rules config variable.
#### 🔌 Usage
```typescript await client.rulesConfigs.set("key", { value: "value", }); ```
#### ⚙️ Parameters
**key:** `string` — Key of the rules config variable to set (max length: 127 characters).
**request:** `Management.SetRulesConfigRequestContent`
**requestOptions:** `RulesConfigsClient.RequestOptions`
client.rulesConfigs.delete(key) -> void
#### 📝 Description
Delete a rules config variable identified by its key.
#### 🔌 Usage
```typescript await client.rulesConfigs.delete("key"); ```
#### ⚙️ Parameters
**key:** `string` — Key of the rules config variable to delete.
**requestOptions:** `RulesConfigsClient.RequestOptions`
## SelfServiceProfiles
client.selfServiceProfiles.list({ ...params }) -> core.Page<Management.SelfServiceProfile, Management.ListSelfServiceProfilesPaginatedResponseContent>
#### 📝 Description
Retrieves self-service profiles.
#### 🔌 Usage
```typescript const pageableResponse = await client.selfServiceProfiles.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.selfServiceProfiles.list({ page: 1, per_page: 1, include_totals: true, }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Management.ListSelfServiceProfilesRequestParameters`
**requestOptions:** `SelfServiceProfilesClient.RequestOptions`
client.selfServiceProfiles.create({ ...params }) -> Management.CreateSelfServiceProfileResponseContent
#### 📝 Description
Creates a self-service profile.
#### 🔌 Usage
```typescript await client.selfServiceProfiles.create({ name: "name", }); ```
#### ⚙️ Parameters
**request:** `Management.CreateSelfServiceProfileRequestContent`
**requestOptions:** `SelfServiceProfilesClient.RequestOptions`
client.selfServiceProfiles.get(id) -> Management.GetSelfServiceProfileResponseContent
#### 📝 Description
Retrieves a self-service profile by Id.
#### 🔌 Usage
```typescript await client.selfServiceProfiles.get("id"); ```
#### ⚙️ Parameters
**id:** `string` — The id of the self-service profile to retrieve
**requestOptions:** `SelfServiceProfilesClient.RequestOptions`
client.selfServiceProfiles.delete(id) -> void
#### 📝 Description
Deletes a self-service profile by Id.
#### 🔌 Usage
```typescript await client.selfServiceProfiles.delete("id"); ```
#### ⚙️ Parameters
**id:** `string` — The id of the self-service profile to delete
**requestOptions:** `SelfServiceProfilesClient.RequestOptions`
client.selfServiceProfiles.update(id, { ...params }) -> Management.UpdateSelfServiceProfileResponseContent
#### 📝 Description
Updates a self-service profile.
#### 🔌 Usage
```typescript await client.selfServiceProfiles.update("id"); ```
#### ⚙️ Parameters
**id:** `string` — The id of the self-service profile to update
**request:** `Management.UpdateSelfServiceProfileRequestContent`
**requestOptions:** `SelfServiceProfilesClient.RequestOptions`
## Sessions
client.sessions.get(id) -> Management.GetSessionResponseContent
#### 📝 Description
Retrieve session information.
#### 🔌 Usage
```typescript await client.sessions.get("id"); ```
#### ⚙️ Parameters
**id:** `string` — ID of session to retrieve
**requestOptions:** `SessionsClient.RequestOptions`
client.sessions.delete(id) -> void
#### 📝 Description
Delete a session by ID.
#### 🔌 Usage
```typescript await client.sessions.delete("id"); ```
#### ⚙️ Parameters
**id:** `string` — ID of the session to delete.
**requestOptions:** `SessionsClient.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.
**request:** `Management.UpdateSessionRequestContent`
**requestOptions:** `SessionsClient.RequestOptions`
client.sessions.revoke(id) -> void
#### 📝 Description
Revokes a session by ID and all associated refresh tokens.
#### 🔌 Usage
```typescript await client.sessions.revoke("id"); ```
#### ⚙️ Parameters
**id:** `string` — ID of the session to revoke.
**requestOptions:** `SessionsClient.RequestOptions`
## Stats
client.stats.getActiveUsersCount() -> Management.GetActiveUsersCountStatsResponseContent
#### 📝 Description
Retrieve the number of active users that logged in during the last 30 days.
#### 🔌 Usage
```typescript await client.stats.getActiveUsersCount(); ```
#### ⚙️ Parameters
**requestOptions:** `StatsClient.RequestOptions`
client.stats.getDaily({ ...params }) -> Management.DailyStats[]
#### 📝 Description
Retrieve the number of logins, signups and breached-password detections (subscription required) that occurred each day within a specified date range.
#### 🔌 Usage
```typescript await client.stats.getDaily({ from: "from", to: "to", }); ```
#### ⚙️ Parameters
**request:** `Management.GetDailyStatsRequestParameters`
**requestOptions:** `StatsClient.RequestOptions`
## SupplementalSignals
client.supplementalSignals.get() -> Management.GetSupplementalSignalsResponseContent
#### 📝 Description
Get the supplemental signals configuration for a tenant.
#### 🔌 Usage
```typescript await client.supplementalSignals.get(); ```
#### ⚙️ Parameters
**requestOptions:** `SupplementalSignalsClient.RequestOptions`
client.supplementalSignals.patch({ ...params }) -> Management.PatchSupplementalSignalsResponseContent
#### 📝 Description
Update the supplemental signals configuration for a tenant.
#### 🔌 Usage
```typescript await client.supplementalSignals.patch({ akamai_enabled: true, }); ```
#### ⚙️ Parameters
**request:** `Management.UpdateSupplementalSignalsRequestContent`
**requestOptions:** `SupplementalSignalsClient.RequestOptions`
## Tickets
client.tickets.verifyEmail({ ...params }) -> Management.VerifyEmailTicketResponseContent
#### 📝 Description
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.
#### 🔌 Usage
```typescript await client.tickets.verifyEmail({ user_id: "user_id", }); ```
#### ⚙️ Parameters
**request:** `Management.VerifyEmailTicketRequestContent`
**requestOptions:** `TicketsClient.RequestOptions`
client.tickets.changePassword({ ...params }) -> Management.ChangePasswordTicketResponseContent
#### 📝 Description
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.
#### 🔌 Usage
```typescript await client.tickets.changePassword(); ```
#### ⚙️ Parameters
**request:** `Management.ChangePasswordTicketRequestContent`
**requestOptions:** `TicketsClient.RequestOptions`
## TokenExchangeProfiles
client.tokenExchangeProfiles.list({ ...params }) -> core.Page<Management.TokenExchangeProfileResponseContent, Management.ListTokenExchangeProfileResponseContent>
#### 📝 Description
Retrieve a list of all Token Exchange Profiles available in your tenant. By using this feature, you agree to the applicable Free Trial terms in Okta’s Master Subscription Agreement. It is your responsibility to securely validate the user’s subject_token. See User Guide for more details. 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.
#### 🔌 Usage
```typescript const pageableResponse = await client.tokenExchangeProfiles.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.tokenExchangeProfiles.list({ from: "from", take: 1, }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Management.TokenExchangeProfilesListRequest`
**requestOptions:** `TokenExchangeProfilesClient.RequestOptions`
client.tokenExchangeProfiles.create({ ...params }) -> Management.CreateTokenExchangeProfileResponseContent
#### 📝 Description
Create a new Token Exchange Profile within your tenant. By using this feature, you agree to the applicable Free Trial terms in Okta’s Master Subscription Agreement. It is your responsibility to securely validate the user’s subject_token. See User Guide for more details.
#### 🔌 Usage
```typescript await client.tokenExchangeProfiles.create({ name: "name", subject_token_type: "subject_token_type", action_id: "action_id", type: "custom_authentication", }); ```
#### ⚙️ Parameters
**request:** `Management.CreateTokenExchangeProfileRequestContent`
**requestOptions:** `TokenExchangeProfilesClient.RequestOptions`
client.tokenExchangeProfiles.get(id) -> Management.GetTokenExchangeProfileResponseContent
#### 📝 Description
Retrieve details about a single Token Exchange Profile specified by ID. By using this feature, you agree to the applicable Free Trial terms in Okta’s Master Subscription Agreement. It is your responsibility to securely validate the user’s subject_token. See User Guide for more details.
#### 🔌 Usage
```typescript await client.tokenExchangeProfiles.get("id"); ```
#### ⚙️ Parameters
**id:** `string` — ID of the Token Exchange Profile to retrieve.
**requestOptions:** `TokenExchangeProfilesClient.RequestOptions`
client.tokenExchangeProfiles.delete(id) -> void
#### 📝 Description
Delete a Token Exchange Profile within your tenant. By using this feature, you agree to the applicable Free Trial terms in Okta's Master Subscription Agreement. It is your responsibility to securely validate the user's subject_token. See User Guide for more details.
#### 🔌 Usage
```typescript await client.tokenExchangeProfiles.delete("id"); ```
#### ⚙️ Parameters
**id:** `string` — ID of the Token Exchange Profile to delete.
**requestOptions:** `TokenExchangeProfilesClient.RequestOptions`
client.tokenExchangeProfiles.update(id, { ...params }) -> void
#### 📝 Description
Update a Token Exchange Profile within your tenant. By using this feature, you agree to the applicable Free Trial terms in Okta's Master Subscription Agreement. It is your responsibility to securely validate the user's subject_token. See User Guide for more details.
#### 🔌 Usage
```typescript await client.tokenExchangeProfiles.update("id"); ```
#### ⚙️ Parameters
**id:** `string` — ID of the Token Exchange Profile to update.
**request:** `Management.UpdateTokenExchangeProfileRequestContent`
**requestOptions:** `TokenExchangeProfilesClient.RequestOptions`
## UserAttributeProfiles
client.userAttributeProfiles.list({ ...params }) -> core.Page<Management.UserAttributeProfile, Management.ListUserAttributeProfilesPaginatedResponseContent>
#### 📝 Description
Retrieve a list of User Attribute Profiles. This endpoint supports Checkpoint pagination.
#### 🔌 Usage
```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, }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Management.ListUserAttributeProfileRequestParameters`
**requestOptions:** `UserAttributeProfilesClient.RequestOptions`
client.userAttributeProfiles.create({ ...params }) -> Management.CreateUserAttributeProfileResponseContent
#### 📝 Description
Retrieve details about a single User Attribute Profile specified by ID.
#### 🔌 Usage
```typescript await client.userAttributeProfiles.create({ name: "name", user_attributes: { key: { description: "description", label: "label", profile_required: true, auth0_mapping: "auth0_mapping", }, }, }); ```
#### ⚙️ Parameters
**request:** `Management.CreateUserAttributeProfileRequestContent`
**requestOptions:** `UserAttributeProfilesClient.RequestOptions`
client.userAttributeProfiles.listTemplates() -> Management.ListUserAttributeProfileTemplateResponseContent
#### 📝 Description
Retrieve a list of User Attribute Profile Templates.
#### 🔌 Usage
```typescript await client.userAttributeProfiles.listTemplates(); ```
#### ⚙️ Parameters
**requestOptions:** `UserAttributeProfilesClient.RequestOptions`
client.userAttributeProfiles.getTemplate(id) -> Management.GetUserAttributeProfileTemplateResponseContent
#### 📝 Description
Retrieve a User Attribute Profile Template.
#### 🔌 Usage
```typescript await client.userAttributeProfiles.getTemplate("id"); ```
#### ⚙️ Parameters
**id:** `string` — ID of the user-attribute-profile-template to retrieve.
**requestOptions:** `UserAttributeProfilesClient.RequestOptions`
client.userAttributeProfiles.get(id) -> Management.GetUserAttributeProfileResponseContent
#### 📝 Description
Retrieve details about a single User Attribute Profile specified by ID.
#### 🔌 Usage
```typescript await client.userAttributeProfiles.get("id"); ```
#### ⚙️ Parameters
**id:** `string` — ID of the user-attribute-profile to retrieve.
**requestOptions:** `UserAttributeProfilesClient.RequestOptions`
client.userAttributeProfiles.delete(id) -> void
#### 📝 Description
Delete a single User Attribute Profile specified by ID.
#### 🔌 Usage
```typescript await client.userAttributeProfiles.delete("id"); ```
#### ⚙️ Parameters
**id:** `string` — ID of the user-attribute-profile to delete.
**requestOptions:** `UserAttributeProfilesClient.RequestOptions`
client.userAttributeProfiles.update(id, { ...params }) -> Management.UpdateUserAttributeProfileResponseContent
#### 📝 Description
Update the details of a specific User attribute profile, such as name, user_id and user_attributes.
#### 🔌 Usage
```typescript await client.userAttributeProfiles.update("id"); ```
#### ⚙️ Parameters
**id:** `string` — ID of the user attribute profile to update.
**request:** `Management.UpdateUserAttributeProfileRequestContent`
**requestOptions:** `UserAttributeProfilesClient.RequestOptions`
## UserBlocks
client.userBlocks.listByIdentifier({ ...params }) -> Management.ListUserBlocksByIdentifierResponseContent
#### 📝 Description
Retrieve details of all Brute-force Protection blocks for a user with the given identifier (username, phone number, or email).
#### 🔌 Usage
```typescript await client.userBlocks.listByIdentifier({ identifier: "identifier", consider_brute_force_enablement: true, }); ```
#### ⚙️ Parameters
**request:** `Management.ListUserBlocksByIdentifierRequestParameters`
**requestOptions:** `UserBlocksClient.RequestOptions`
client.userBlocks.deleteByIdentifier({ ...params }) -> void
#### 📝 Description
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.
#### 🔌 Usage
```typescript await client.userBlocks.deleteByIdentifier({ identifier: "identifier", }); ```
#### ⚙️ Parameters
**request:** `Management.DeleteUserBlocksByIdentifierRequestParameters`
**requestOptions:** `UserBlocksClient.RequestOptions`
client.userBlocks.list(id, { ...params }) -> Management.ListUserBlocksResponseContent
#### 📝 Description
Retrieve details of all Brute-force Protection blocks for the user with the given ID.
#### 🔌 Usage
```typescript await client.userBlocks.list("id", { consider_brute_force_enablement: true, }); ```
#### ⚙️ Parameters
**id:** `string` — user_id of the user blocks to retrieve.
**request:** `Management.ListUserBlocksRequestParameters`
**requestOptions:** `UserBlocksClient.RequestOptions`
client.userBlocks.delete(id) -> void
#### 📝 Description
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.
#### 🔌 Usage
```typescript await client.userBlocks.delete("id"); ```
#### ⚙️ Parameters
**id:** `string` — The user_id of the user to update.
**requestOptions:** `UserBlocksClient.RequestOptions`
## Users
client.users.list({ ...params }) -> core.Page<Management.UserResponseSchema, Management.ListUsersOffsetPaginatedResponseContent>
#### 📝 Description
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.
#### 🔌 Usage
```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(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Management.ListUsersRequestParameters`
**requestOptions:** `UsersClient.RequestOptions`
client.users.create({ ...params }) -> Management.CreateUserResponseContent
#### 📝 Description
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.
#### 🔌 Usage
```typescript await client.users.create({ connection: "connection", }); ```
#### ⚙️ Parameters
**request:** `Management.CreateUserRequestContent`
**requestOptions:** `UsersClient.RequestOptions`
client.users.listUsersByEmail({ ...params }) -> Management.UserResponseSchema[]
#### 📝 Description
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.
#### 🔌 Usage
```typescript await client.users.listUsersByEmail({ fields: "fields", include_fields: true, email: "email", }); ```
#### ⚙️ Parameters
**request:** `Management.ListUsersByEmailRequestParameters`
**requestOptions:** `UsersClient.RequestOptions`
client.users.get(id, { ...params }) -> Management.GetUserResponseContent
#### 📝 Description
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.
#### 🔌 Usage
```typescript await client.users.get("id", { fields: "fields", include_fields: true, }); ```
#### ⚙️ Parameters
**id:** `string` — ID of the user to retrieve.
**request:** `Management.GetUserRequestParameters`
**requestOptions:** `UsersClient.RequestOptions`
client.users.delete(id) -> void
#### 📝 Description
Delete a user by user ID. This action cannot be undone. For Auth0 Dashboard instructions, see Delete Users.
#### 🔌 Usage
```typescript await client.users.delete("id"); ```
#### ⚙️ Parameters
**id:** `string` — ID of the user to delete.
**requestOptions:** `UsersClient.RequestOptions`
client.users.update(id, { ...params }) -> Management.UpdateUserResponseContent
#### 📝 Description
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"
    }
  }
}
#### 🔌 Usage
```typescript await client.users.update("id"); ```
#### ⚙️ Parameters
**id:** `string` — ID of the user to update.
**request:** `Management.UpdateUserRequestContent`
**requestOptions:** `UsersClient.RequestOptions`
client.users.regenerateRecoveryCode(id) -> Management.RegenerateUsersRecoveryCodeResponseContent
#### 📝 Description
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.
#### 🔌 Usage
```typescript await client.users.regenerateRecoveryCode("id"); ```
#### ⚙️ Parameters
**id:** `string` — ID of the user to regenerate a multi-factor authentication recovery code for.
**requestOptions:** `UsersClient.RequestOptions`
client.users.revokeAccess(id, { ...params }) -> void
#### 📝 Description
Revokes selected resources related to a user (sessions, refresh tokens, ...).
#### 🔌 Usage
```typescript await client.users.revokeAccess("id"); ```
#### ⚙️ Parameters
**id:** `string` — ID of the user.
**request:** `Management.RevokeUserAccessRequestContent`
**requestOptions:** `UsersClient.RequestOptions`
## Actions Versions
client.actions.versions.list(actionId, { ...params }) -> core.Page<Management.ActionVersion, Management.ListActionVersionsPaginatedResponseContent>
#### 📝 Description
Retrieve all of an action's versions. An action version is created whenever an action is deployed. An action version is immutable, once created.
#### 🔌 Usage
```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(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**actionId:** `string` — The ID of the action.
**request:** `Management.ListActionVersionsRequestParameters`
**requestOptions:** `VersionsClient.RequestOptions`
client.actions.versions.get(actionId, id) -> Management.GetActionVersionResponseContent
#### 📝 Description
Retrieve a specific version of an action. An action version is created whenever an action is deployed. An action version is immutable, once created.
#### 🔌 Usage
```typescript await client.actions.versions.get("actionId", "id"); ```
#### ⚙️ Parameters
**actionId:** `string` — The ID of the action.
**id:** `string` — The ID of the action version.
**requestOptions:** `VersionsClient.RequestOptions`
client.actions.versions.deploy(actionId, id, { ...params }) -> Management.DeployActionVersionResponseContent
#### 📝 Description
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.
#### 🔌 Usage
```typescript await client.actions.versions.deploy("actionId", "id"); ```
#### ⚙️ Parameters
**actionId:** `string` — The ID of an action.
**id:** `string` — The ID of an action version.
**request:** `Management.DeployActionVersionRequestContent | null`
**requestOptions:** `VersionsClient.RequestOptions`
## Actions Executions
client.actions.executions.get(id) -> Management.GetActionExecutionResponseContent
#### 📝 Description
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.
#### 🔌 Usage
```typescript await client.actions.executions.get("id"); ```
#### ⚙️ Parameters
**id:** `string` — The ID of the execution to retrieve.
**requestOptions:** `ExecutionsClient.RequestOptions`
## Actions Modules
client.actions.modules.list({ ...params }) -> core.Page<Management.ActionModuleListItem, Management.GetActionModulesResponseContent>
#### 📝 Description
Retrieve a paginated list of all Actions Modules with optional filtering and totals.
#### 🔌 Usage
```typescript const pageableResponse = await client.actions.modules.list({ 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.modules.list({ page: 1, per_page: 1, }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Management.GetActionModulesRequestParameters`
**requestOptions:** `ModulesClient.RequestOptions`
client.actions.modules.create({ ...params }) -> Management.CreateActionModuleResponseContent
#### 📝 Description
Create a new Actions Module for reusable code across actions.
#### 🔌 Usage
```typescript await client.actions.modules.create({ name: "name", code: "code", }); ```
#### ⚙️ Parameters
**request:** `Management.CreateActionModuleRequestContent`
**requestOptions:** `ModulesClient.RequestOptions`
client.actions.modules.get(id) -> Management.GetActionModuleResponseContent
#### 📝 Description
Retrieve details of a specific Actions Module by its unique identifier.
#### 🔌 Usage
```typescript await client.actions.modules.get("id"); ```
#### ⚙️ Parameters
**id:** `string` — The ID of the action module to retrieve.
**requestOptions:** `ModulesClient.RequestOptions`
client.actions.modules.delete(id) -> void
#### 📝 Description
Permanently delete an Actions Module. This will fail if the module is still in use by any actions.
#### 🔌 Usage
```typescript await client.actions.modules.delete("id"); ```
#### ⚙️ Parameters
**id:** `string` — The ID of the Actions Module to delete.
**requestOptions:** `ModulesClient.RequestOptions`
client.actions.modules.update(id, { ...params }) -> Management.UpdateActionModuleResponseContent
#### 📝 Description
Update properties of an existing Actions Module, such as code, dependencies, or secrets.
#### 🔌 Usage
```typescript await client.actions.modules.update("id"); ```
#### ⚙️ Parameters
**id:** `string` — The ID of the action module to update.
**request:** `Management.UpdateActionModuleRequestContent`
**requestOptions:** `ModulesClient.RequestOptions`
client.actions.modules.listActions(id, { ...params }) -> core.Page<Management.ActionModuleAction, Management.GetActionModuleActionsResponseContent>
#### 📝 Description
Lists all actions that are using a specific Actions Module, showing which deployed action versions reference this Actions Module.
#### 🔌 Usage
```typescript const pageableResponse = await client.actions.modules.listActions("id", { 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.modules.listActions("id", { page: 1, per_page: 1, }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**id:** `string` — The unique ID of the module.
**request:** `Management.GetActionModuleActionsRequestParameters`
**requestOptions:** `ModulesClient.RequestOptions`
client.actions.modules.rollback(id, { ...params }) -> Management.RollbackActionModuleResponseContent
#### 📝 Description
Rolls back an Actions Module's draft to a previously created version. This action copies the code, dependencies, and secrets from the specified version into the current draft.
#### 🔌 Usage
```typescript await client.actions.modules.rollback("id", { module_version_id: "module_version_id", }); ```
#### ⚙️ Parameters
**id:** `string` — The unique ID of the module to roll back.
**request:** `Management.RollbackActionModuleRequestParameters`
**requestOptions:** `ModulesClient.RequestOptions`
## Actions Triggers
client.actions.triggers.list() -> Management.ListActionTriggersResponseContent
#### 📝 Description
Retrieve the set of triggers currently available within actions. A trigger is an extensibility point to which actions can be bound.
#### 🔌 Usage
```typescript await client.actions.triggers.list(); ```
#### ⚙️ Parameters
**requestOptions:** `TriggersClient.RequestOptions`
## Actions Modules Versions
client.actions.modules.versions.list(id, { ...params }) -> core.Page<Management.ActionModuleVersion, Management.GetActionModuleVersionsResponseContent>
#### 📝 Description
List all published versions of a specific Actions Module.
#### 🔌 Usage
```typescript const pageableResponse = await client.actions.modules.versions.list("id", { 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.modules.versions.list("id", { page: 1, per_page: 1, }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**id:** `string` — The unique ID of the module.
**request:** `Management.GetActionModuleVersionsRequestParameters`
**requestOptions:** `VersionsClient.RequestOptions`
client.actions.modules.versions.create(id) -> Management.CreateActionModuleVersionResponseContent
#### 📝 Description
Creates a new immutable version of an Actions Module from the current draft version. This publishes the draft as a new version that can be referenced by actions, while maintaining the existing draft for continued development.
#### 🔌 Usage
```typescript await client.actions.modules.versions.create("id"); ```
#### ⚙️ Parameters
**id:** `string` — The ID of the action module to create a version for.
**requestOptions:** `VersionsClient.RequestOptions`
client.actions.modules.versions.get(id, versionId) -> Management.GetActionModuleVersionResponseContent
#### 📝 Description
Retrieve the details of a specific, immutable version of an Actions Module.
#### 🔌 Usage
```typescript await client.actions.modules.versions.get("id", "versionId"); ```
#### ⚙️ Parameters
**id:** `string` — The unique ID of the module.
**versionId:** `string` — The unique ID of the module version to retrieve.
**requestOptions:** `VersionsClient.RequestOptions`
## Actions Triggers Bindings
client.actions.triggers.bindings.list(triggerId, { ...params }) -> core.Page<Management.ActionBinding, Management.ListActionBindingsPaginatedResponseContent>
#### 📝 Description
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.
#### 🔌 Usage
```typescript const pageableResponse = await client.actions.triggers.bindings.list("post-login", { 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("post-login", { page: 1, per_page: 1, }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**triggerId:** `Management.ActionTriggerTypeEnum` — An actions extensibility point.
**request:** `Management.ListActionTriggerBindingsRequestParameters`
**requestOptions:** `BindingsClient.RequestOptions`
client.actions.triggers.bindings.updateMany(triggerId, { ...params }) -> Management.UpdateActionBindingsResponseContent
#### 📝 Description
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.
#### 🔌 Usage
```typescript await client.actions.triggers.bindings.updateMany("post-login"); ```
#### ⚙️ Parameters
**triggerId:** `Management.ActionTriggerTypeEnum` — An actions extensibility point.
**request:** `Management.UpdateActionBindingsRequestContent`
**requestOptions:** `BindingsClient.RequestOptions`
## Anomaly Blocks
client.anomaly.blocks.checkIp(id) -> void
#### 📝 Description
Check if the given IP address is blocked via the Suspicious IP Throttling due to multiple suspicious attempts.
#### 🔌 Usage
```typescript await client.anomaly.blocks.checkIp("id"); ```
#### ⚙️ Parameters
**id:** `Management.AnomalyIpFormat` — IP address to check.
**requestOptions:** `BlocksClient.RequestOptions`
client.anomaly.blocks.unblockIp(id) -> void
#### 📝 Description
Remove a block imposed by Suspicious IP Throttling for the given IP address.
#### 🔌 Usage
```typescript await client.anomaly.blocks.unblockIp("id"); ```
#### ⚙️ Parameters
**id:** `Management.AnomalyIpFormat` — IP address to unblock.
**requestOptions:** `BlocksClient.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(); ```
#### ⚙️ Parameters
**requestOptions:** `BotDetectionClient.RequestOptions`
client.attackProtection.botDetection.update({ ...params }) -> Management.UpdateBotDetectionSettingsResponseContent
#### 📝 Description
Update the Bot Detection configuration of your tenant.
#### 🔌 Usage
```typescript await client.attackProtection.botDetection.update(); ```
#### ⚙️ Parameters
**request:** `Management.UpdateBotDetectionSettingsRequestContent`
**requestOptions:** `BotDetectionClient.RequestOptions`
## AttackProtection BreachedPasswordDetection
client.attackProtection.breachedPasswordDetection.get() -> Management.GetBreachedPasswordDetectionSettingsResponseContent
#### 📝 Description
Retrieve details of the Breached Password Detection configuration of your tenant.
#### 🔌 Usage
```typescript await client.attackProtection.breachedPasswordDetection.get(); ```
#### ⚙️ Parameters
**requestOptions:** `BreachedPasswordDetectionClient.RequestOptions`
client.attackProtection.breachedPasswordDetection.update({ ...params }) -> Management.UpdateBreachedPasswordDetectionSettingsResponseContent
#### 📝 Description
Update details of the Breached Password Detection configuration of your tenant.
#### 🔌 Usage
```typescript await client.attackProtection.breachedPasswordDetection.update(); ```
#### ⚙️ Parameters
**request:** `Management.UpdateBreachedPasswordDetectionSettingsRequestContent`
**requestOptions:** `BreachedPasswordDetectionClient.RequestOptions`
## AttackProtection BruteForceProtection
client.attackProtection.bruteForceProtection.get() -> Management.GetBruteForceSettingsResponseContent
#### 📝 Description
Retrieve details of the Brute-force Protection configuration of your tenant.
#### 🔌 Usage
```typescript await client.attackProtection.bruteForceProtection.get(); ```
#### ⚙️ Parameters
**requestOptions:** `BruteForceProtectionClient.RequestOptions`
client.attackProtection.bruteForceProtection.update({ ...params }) -> Management.UpdateBruteForceSettingsResponseContent
#### 📝 Description
Update the Brute-force Protection configuration of your tenant.
#### 🔌 Usage
```typescript await client.attackProtection.bruteForceProtection.update(); ```
#### ⚙️ Parameters
**request:** `Management.UpdateBruteForceSettingsRequestContent`
**requestOptions:** `BruteForceProtectionClient.RequestOptions`
## AttackProtection Captcha
client.attackProtection.captcha.get() -> Management.GetAttackProtectionCaptchaResponseContent
#### 📝 Description
Get the CAPTCHA configuration for your client.
#### 🔌 Usage
```typescript await client.attackProtection.captcha.get(); ```
#### ⚙️ Parameters
**requestOptions:** `CaptchaClient.RequestOptions`
client.attackProtection.captcha.update({ ...params }) -> Management.UpdateAttackProtectionCaptchaResponseContent
#### 📝 Description
Update existing CAPTCHA configuration for your client.
#### 🔌 Usage
```typescript await client.attackProtection.captcha.update(); ```
#### ⚙️ Parameters
**request:** `Management.UpdateAttackProtectionCaptchaRequestContent`
**requestOptions:** `CaptchaClient.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:** `SuspiciousIpThrottlingClient.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:** `SuspiciousIpThrottlingClient.RequestOptions`
## Branding Templates
client.branding.templates.getUniversalLogin() -> Management.GetUniversalLoginTemplateResponseContent
#### 🔌 Usage
```typescript await client.branding.templates.getUniversalLogin(); ```
#### ⚙️ Parameters
**requestOptions:** `TemplatesClient.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:** `TemplatesClient.RequestOptions`
client.branding.templates.deleteUniversalLogin() -> void
#### 🔌 Usage
```typescript await client.branding.templates.deleteUniversalLogin(); ```
#### ⚙️ Parameters
**requestOptions:** `TemplatesClient.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:** `ThemesClient.RequestOptions`
client.branding.themes.getDefault() -> Management.GetBrandingDefaultThemeResponseContent
#### 📝 Description
Retrieve default branding theme.
#### 🔌 Usage
```typescript await client.branding.themes.getDefault(); ```
#### ⚙️ Parameters
**requestOptions:** `ThemesClient.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:** `ThemesClient.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:** `ThemesClient.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:** `ThemesClient.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:** `ProvidersClient.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:** `ProvidersClient.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:** `ProvidersClient.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:** `ProvidersClient.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:** `ProvidersClient.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:** `ProvidersClient.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:** `TemplatesClient.RequestOptions`
client.branding.phone.templates.create({ ...params }) -> Management.CreatePhoneTemplateResponseContent
#### 🔌 Usage
```typescript await client.branding.phone.templates.create(); ```
#### ⚙️ Parameters
**request:** `Management.CreatePhoneTemplateRequestContent`
**requestOptions:** `TemplatesClient.RequestOptions`
client.branding.phone.templates.get(id) -> Management.GetPhoneTemplateResponseContent
#### 🔌 Usage
```typescript await client.branding.phone.templates.get("id"); ```
#### ⚙️ Parameters
**id:** `string`
**requestOptions:** `TemplatesClient.RequestOptions`
client.branding.phone.templates.delete(id) -> void
#### 🔌 Usage
```typescript await client.branding.phone.templates.delete("id"); ```
#### ⚙️ Parameters
**id:** `string`
**requestOptions:** `TemplatesClient.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:** `TemplatesClient.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:** `TemplatesClient.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:** `TemplatesClient.RequestOptions`
## ClientGrants Organizations
client.clientGrants.organizations.list(id, { ...params }) -> core.Page<Management.Organization, Management.ListClientGrantOrganizationsPaginatedResponseContent>
#### 🔌 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, }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**id:** `string` — ID of the client grant
**request:** `Management.ListClientGrantOrganizationsRequestParameters`
**requestOptions:** `OrganizationsClient.RequestOptions`
## Clients Credentials
client.clients.credentials.list(client_id) -> 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.
#### 🔌 Usage
```typescript await client.clients.credentials.list("client_id"); ```
#### ⚙️ Parameters
**client_id:** `string` — ID of the client.
**requestOptions:** `CredentialsClient.RequestOptions`
client.clients.credentials.create(client_id, { ...params }) -> Management.PostClientCredentialResponseContent
#### 📝 Description
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:
#### 🔌 Usage
```typescript await client.clients.credentials.create("client_id", { credential_type: "public_key", }); ```
#### ⚙️ Parameters
**client_id:** `string` — ID of the client.
**request:** `Management.PostClientCredentialRequestContent`
**requestOptions:** `CredentialsClient.RequestOptions`
client.clients.credentials.get(client_id, credential_id) -> 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
**client_id:** `string` — ID of the client.
**credential_id:** `string` — ID of the credential.
**requestOptions:** `CredentialsClient.RequestOptions`
client.clients.credentials.delete(client_id, credential_id) -> void
#### 📝 Description
Delete a client credential you previously created. May be enabled or disabled. For more information, read Client Credential Flow.
#### 🔌 Usage
```typescript await client.clients.credentials.delete("client_id", "credential_id"); ```
#### ⚙️ Parameters
**client_id:** `string` — ID of the client.
**credential_id:** `string` — ID of the credential to delete.
**requestOptions:** `CredentialsClient.RequestOptions`
client.clients.credentials.update(client_id, credential_id, { ...params }) -> Management.PatchClientCredentialResponseContent
#### 📝 Description
Change a client credential you previously created. May be enabled or disabled. For more information, read Client Credential Flow.
#### 🔌 Usage
```typescript await client.clients.credentials.update("client_id", "credential_id"); ```
#### ⚙️ Parameters
**client_id:** `string` — ID of the client.
**credential_id:** `string` — ID of the credential.
**request:** `Management.PatchClientCredentialRequestContent`
**requestOptions:** `CredentialsClient.RequestOptions`
## Clients Connections
client.clients.connections.get(id, { ...params }) -> core.Page<Management.ConnectionForList, Management.ListClientConnectionsResponseContent>
#### 📝 Description
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.
#### 🔌 Usage
```typescript 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; ```
#### ⚙️ Parameters
**id:** `string` — ID of the client for which to retrieve enabled connections.
**request:** `Management.ConnectionsGetRequest`
**requestOptions:** `ConnectionsClient.RequestOptions`
## Connections DirectoryProvisioning
client.connections.directoryProvisioning.list({ ...params }) -> core.Page<Management.DirectoryProvisioning, Management.ListDirectoryProvisioningsResponseContent>
#### 📝 Description
Retrieve a list of directory provisioning configurations of a tenant.
#### 🔌 Usage
```typescript const pageableResponse = await client.connections.directoryProvisioning.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.connections.directoryProvisioning.list({ from: "from", take: 1, }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Management.ListDirectoryProvisioningsRequestParameters`
**requestOptions:** `DirectoryProvisioningClient.RequestOptions`
client.connections.directoryProvisioning.get(id) -> Management.GetDirectoryProvisioningResponseContent
#### 📝 Description
Retrieve the directory provisioning configuration of a connection.
#### 🔌 Usage
```typescript await client.connections.directoryProvisioning.get("id"); ```
#### ⚙️ Parameters
**id:** `string` — The id of the connection to retrieve its directory provisioning configuration
**requestOptions:** `DirectoryProvisioningClient.RequestOptions`
client.connections.directoryProvisioning.create(id, { ...params }) -> Management.CreateDirectoryProvisioningResponseContent
#### 📝 Description
Create a directory provisioning configuration for a connection.
#### 🔌 Usage
```typescript await client.connections.directoryProvisioning.create("id"); ```
#### ⚙️ Parameters
**id:** `string` — The id of the connection to create its directory provisioning configuration
**request:** `Management.CreateDirectoryProvisioningRequestContent | null`
**requestOptions:** `DirectoryProvisioningClient.RequestOptions`
client.connections.directoryProvisioning.delete(id) -> void
#### 📝 Description
Delete the directory provisioning configuration of a connection.
#### 🔌 Usage
```typescript await client.connections.directoryProvisioning.delete("id"); ```
#### ⚙️ Parameters
**id:** `string` — The id of the connection to delete its directory provisioning configuration
**requestOptions:** `DirectoryProvisioningClient.RequestOptions`
client.connections.directoryProvisioning.update(id, { ...params }) -> Management.UpdateDirectoryProvisioningResponseContent
#### 📝 Description
Update the directory provisioning configuration of a connection.
#### 🔌 Usage
```typescript await client.connections.directoryProvisioning.update("id"); ```
#### ⚙️ Parameters
**id:** `string` — The id of the connection to create its directory provisioning configuration
**request:** `Management.UpdateDirectoryProvisioningRequestContent | null`
**requestOptions:** `DirectoryProvisioningClient.RequestOptions`
client.connections.directoryProvisioning.getDefaultMapping(id) -> Management.GetDirectoryProvisioningDefaultMappingResponseContent
#### 📝 Description
Retrieve the directory provisioning default attribute mapping of a connection.
#### 🔌 Usage
```typescript await client.connections.directoryProvisioning.getDefaultMapping("id"); ```
#### ⚙️ Parameters
**id:** `string` — The id of the connection to retrieve its directory provisioning configuration
**requestOptions:** `DirectoryProvisioningClient.RequestOptions`
client.connections.directoryProvisioning.listSynchronizedGroups(id, { ...params }) -> core.Page<Management.SynchronizedGroupPayload, Management.ListSynchronizedGroupsResponseContent>
#### 📝 Description
Retrieve the configured synchronized groups for a connection directory provisioning configuration.
#### 🔌 Usage
```typescript const pageableResponse = await client.connections.directoryProvisioning.listSynchronizedGroups("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.connections.directoryProvisioning.listSynchronizedGroups("id", { from: "from", take: 1, }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**id:** `string` — The id of the connection to list synchronized groups for.
**request:** `Management.ListSynchronizedGroupsRequestParameters`
**requestOptions:** `DirectoryProvisioningClient.RequestOptions`
client.connections.directoryProvisioning.set(id, { ...params }) -> void
#### 📝 Description
Create or replace the selected groups for a connection directory provisioning configuration.
#### 🔌 Usage
```typescript await client.connections.directoryProvisioning.set("id", { groups: [ { id: "id", }, ], }); ```
#### ⚙️ Parameters
**id:** `string` — The id of the connection to create or replace synchronized groups for
**request:** `Management.ReplaceSynchronizedGroupsRequestContent`
**requestOptions:** `DirectoryProvisioningClient.RequestOptions`
## Connections ScimConfiguration
client.connections.scimConfiguration.list({ ...params }) -> core.Page<Management.ScimConfiguration, Management.ListScimConfigurationsResponseContent>
#### 📝 Description
Retrieve a list of SCIM configurations of a tenant.
#### 🔌 Usage
```typescript const pageableResponse = await client.connections.scimConfiguration.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.connections.scimConfiguration.list({ from: "from", take: 1, }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Management.ListScimConfigurationsRequestParameters`
**requestOptions:** `ScimConfigurationClient.RequestOptions`
client.connections.scimConfiguration.get(id) -> Management.GetScimConfigurationResponseContent
#### 📝 Description
Retrieves a scim configuration by its connectionId.
#### 🔌 Usage
```typescript await client.connections.scimConfiguration.get("id"); ```
#### ⚙️ Parameters
**id:** `string` — The id of the connection to retrieve its SCIM configuration
**requestOptions:** `ScimConfigurationClient.RequestOptions`
client.connections.scimConfiguration.create(id, { ...params }) -> Management.CreateScimConfigurationResponseContent
#### 📝 Description
Create a scim configuration for a connection.
#### 🔌 Usage
```typescript await client.connections.scimConfiguration.create("id"); ```
#### ⚙️ Parameters
**id:** `string` — The id of the connection to create its SCIM configuration
**request:** `Management.CreateScimConfigurationRequestContent | null`
**requestOptions:** `ScimConfigurationClient.RequestOptions`
client.connections.scimConfiguration.delete(id) -> void
#### 📝 Description
Deletes a scim configuration by its connectionId.
#### 🔌 Usage
```typescript await client.connections.scimConfiguration.delete("id"); ```
#### ⚙️ Parameters
**id:** `string` — The id of the connection to delete its SCIM configuration
**requestOptions:** `ScimConfigurationClient.RequestOptions`
client.connections.scimConfiguration.update(id, { ...params }) -> Management.UpdateScimConfigurationResponseContent
#### 📝 Description
Update a scim configuration by its connectionId.
#### 🔌 Usage
```typescript await client.connections.scimConfiguration.update("id", { user_id_attribute: "user_id_attribute", mapping: [{}], }); ```
#### ⚙️ Parameters
**id:** `string` — The id of the connection to update its SCIM configuration
**request:** `Management.UpdateScimConfigurationRequestContent`
**requestOptions:** `ScimConfigurationClient.RequestOptions`
client.connections.scimConfiguration.getDefaultMapping(id) -> Management.GetScimConfigurationDefaultMappingResponseContent
#### 📝 Description
Retrieves a scim configuration's default mapping by its connectionId.
#### 🔌 Usage
```typescript await client.connections.scimConfiguration.getDefaultMapping("id"); ```
#### ⚙️ Parameters
**id:** `string` — The id of the connection to retrieve its default SCIM mapping
**requestOptions:** `ScimConfigurationClient.RequestOptions`
## Connections Clients
client.connections.clients.get(id, { ...params }) -> core.Page<Management.ConnectionEnabledClient, Management.GetConnectionEnabledClientsResponseContent>
#### 📝 Description
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.
#### 🔌 Usage
```typescript 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; ```
#### ⚙️ Parameters
**id:** `string` — The id of the connection for which enabled clients are to be retrieved
**request:** `Management.GetConnectionEnabledClientsRequestParameters`
**requestOptions:** `ClientsClient.RequestOptions`
client.connections.clients.update(id, { ...params }) -> void
#### 🔌 Usage
```typescript await client.connections.clients.update("id", [ { client_id: "client_id", status: true, }, ]); ```
#### ⚙️ Parameters
**id:** `string` — The id of the connection to modify
**request:** `Management.UpdateEnabledClientConnectionsRequestContent`
**requestOptions:** `ClientsClient.RequestOptions`
## Connections Keys
client.connections.keys.get(id) -> Management.ConnectionKey[]
#### 📝 Description
Gets the connection keys for the Okta or OIDC connection strategy.
#### 🔌 Usage
```typescript await client.connections.keys.get("id"); ```
#### ⚙️ Parameters
**id:** `string` — ID of the connection
**requestOptions:** `KeysClient.RequestOptions`
client.connections.keys.create(id, { ...params }) -> Management.PostConnectionsKeysResponseContent
#### 📝 Description
Provision initial connection keys for Okta or OIDC connection strategies. This endpoint allows you to create keys before configuring the connection to use Private Key JWT authentication, enabling zero-downtime transitions.
#### 🔌 Usage
```typescript await client.connections.keys.create("id"); ```
#### ⚙️ Parameters
**id:** `string` — ID of the connection
**request:** `Management.PostConnectionKeysRequestContent | null`
**requestOptions:** `KeysClient.RequestOptions`
client.connections.keys.rotate(id, { ...params }) -> Management.RotateConnectionsKeysResponseContent
#### 📝 Description
Rotates the connection keys for the Okta or OIDC connection strategies.
#### 🔌 Usage
```typescript await client.connections.keys.rotate("id"); ```
#### ⚙️ Parameters
**id:** `string` — ID of the connection
**request:** `Management.RotateConnectionKeysRequestContent | null`
**requestOptions:** `KeysClient.RequestOptions`
## Connections Users
client.connections.users.deleteByEmail(id, { ...params }) -> void
#### 📝 Description
Deletes a specified connection user by its email (you cannot delete all users from specific connection). Currently, only Database Connections are supported.
#### 🔌 Usage
```typescript await client.connections.users.deleteByEmail("id", { email: "email", }); ```
#### ⚙️ Parameters
**id:** `string` — The id of the connection (currently only database connections are supported)
**request:** `Management.DeleteConnectionUsersByEmailQueryParameters`
**requestOptions:** `UsersClient.RequestOptions`
## Connections DirectoryProvisioning Synchronizations
client.connections.directoryProvisioning.synchronizations.create(id) -> Management.CreateDirectorySynchronizationResponseContent
#### 📝 Description
Request an on-demand synchronization of the directory.
#### 🔌 Usage
```typescript await client.connections.directoryProvisioning.synchronizations.create("id"); ```
#### ⚙️ Parameters
**id:** `string` — The id of the connection to trigger synchronization for
**requestOptions:** `SynchronizationsClient.RequestOptions`
## Connections ScimConfiguration Tokens
client.connections.scimConfiguration.tokens.get(id) -> Management.GetScimTokensResponseContent
#### 📝 Description
Retrieves all scim tokens by its connection id.
#### 🔌 Usage
```typescript await client.connections.scimConfiguration.tokens.get("id"); ```
#### ⚙️ Parameters
**id:** `string` — The id of the connection to retrieve its SCIM configuration
**requestOptions:** `TokensClient.RequestOptions`
client.connections.scimConfiguration.tokens.create(id, { ...params }) -> Management.CreateScimTokenResponseContent
#### 📝 Description
Create a scim token for a scim client.
#### 🔌 Usage
```typescript await client.connections.scimConfiguration.tokens.create("id"); ```
#### ⚙️ Parameters
**id:** `string` — The id of the connection to create its SCIM token
**request:** `Management.CreateScimTokenRequestContent`
**requestOptions:** `TokensClient.RequestOptions`
client.connections.scimConfiguration.tokens.delete(id, tokenId) -> void
#### 📝 Description
Deletes a scim token by its connection id and tokenId.
#### 🔌 Usage
```typescript await client.connections.scimConfiguration.tokens.delete("id", "tokenId"); ```
#### ⚙️ Parameters
**id:** `string` — The connection id that owns the SCIM token to delete
**tokenId:** `string` — The id of the scim token to delete
**requestOptions:** `TokensClient.RequestOptions`
## Emails Provider
client.emails.provider.get({ ...params }) -> Management.GetEmailProviderResponseContent
#### 📝 Description
Retrieve details of the email provider configuration in your tenant. A list of fields to include or exclude may also be specified.
#### 🔌 Usage
```typescript await client.emails.provider.get({ fields: "fields", include_fields: true, }); ```
#### ⚙️ Parameters
**request:** `Management.GetEmailProviderRequestParameters`
**requestOptions:** `ProviderClient.RequestOptions`
client.emails.provider.create({ ...params }) -> Management.CreateEmailProviderResponseContent
#### 📝 Description
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_key
  • sendgrid 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.
#### 🔌 Usage
```typescript await client.emails.provider.create({ name: "mailgun", credentials: { api_key: "api_key", }, }); ```
#### ⚙️ Parameters
**request:** `Management.CreateEmailProviderRequestContent`
**requestOptions:** `ProviderClient.RequestOptions`
client.emails.provider.delete() -> void
#### 📝 Description
Delete the email provider.
#### 🔌 Usage
```typescript await client.emails.provider.delete(); ```
#### ⚙️ Parameters
**requestOptions:** `ProviderClient.RequestOptions`
client.emails.provider.update({ ...params }) -> Management.UpdateEmailProviderResponseContent
#### 📝 Description
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_key
  • sendgrid 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.
#### 🔌 Usage
```typescript await client.emails.provider.update(); ```
#### ⚙️ Parameters
**request:** `Management.UpdateEmailProviderRequestContent`
**requestOptions:** `ProviderClient.RequestOptions`
## EventStreams Deliveries
client.eventStreams.deliveries.list(id, { ...params }) -> Management.EventStreamDelivery[]
#### 🔌 Usage
```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, }); ```
#### ⚙️ Parameters
**id:** `string` — Unique identifier for the event stream.
**request:** `Management.ListEventStreamDeliveriesRequestParameters`
**requestOptions:** `DeliveriesClient.RequestOptions`
client.eventStreams.deliveries.getHistory(id, event_id) -> Management.GetEventStreamDeliveryHistoryResponseContent
#### 🔌 Usage
```typescript await client.eventStreams.deliveries.getHistory("id", "event_id"); ```
#### ⚙️ Parameters
**id:** `string` — Unique identifier for the event stream.
**event_id:** `string` — Unique identifier for the event
**requestOptions:** `DeliveriesClient.RequestOptions`
## EventStreams Redeliveries
client.eventStreams.redeliveries.create(id, { ...params }) -> Management.CreateEventStreamRedeliveryResponseContent
#### 🔌 Usage
```typescript await client.eventStreams.redeliveries.create("id"); ```
#### ⚙️ Parameters
**id:** `string` — Unique identifier for the event stream.
**request:** `Management.CreateEventStreamRedeliveryRequestContent`
**requestOptions:** `RedeliveriesClient.RequestOptions`
client.eventStreams.redeliveries.createById(id, event_id) -> void
#### 🔌 Usage
```typescript await client.eventStreams.redeliveries.createById("id", "event_id"); ```
#### ⚙️ Parameters
**id:** `string` — Unique identifier for the event stream.
**event_id:** `string` — Unique identifier for the event
**requestOptions:** `RedeliveriesClient.RequestOptions`
## Flows Executions
client.flows.executions.list(flow_id, { ...params }) -> core.Page<Management.FlowExecutionSummary, Management.ListFlowExecutionsPaginatedResponseContent>
#### 🔌 Usage
```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; ```
#### ⚙️ Parameters
**flow_id:** `string` — Flow id
**request:** `Management.ListFlowExecutionsRequestParameters`
**requestOptions:** `ExecutionsClient.RequestOptions`
client.flows.executions.get(flow_id, execution_id, { ...params }) -> Management.GetFlowExecutionResponseContent
#### 🔌 Usage
```typescript await client.flows.executions.get("flow_id", "execution_id"); ```
#### ⚙️ Parameters
**flow_id:** `string` — Flow id
**execution_id:** `string` — Flow execution id
**request:** `Management.GetFlowExecutionRequestParameters`
**requestOptions:** `ExecutionsClient.RequestOptions`
client.flows.executions.delete(flow_id, execution_id) -> void
#### 🔌 Usage
```typescript await client.flows.executions.delete("flow_id", "execution_id"); ```
#### ⚙️ Parameters
**flow_id:** `string` — Flows id
**execution_id:** `string` — Flow execution identifier
**requestOptions:** `ExecutionsClient.RequestOptions`
## Flows Vault Connections
client.flows.vault.connections.list({ ...params }) -> core.Page<Management.FlowsVaultConnectionSummary, Management.ListFlowsVaultConnectionsOffsetPaginatedResponseContent>
#### 🔌 Usage
```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, }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Management.ListFlowsVaultConnectionsRequestParameters`
**requestOptions:** `ConnectionsClient.RequestOptions`
client.flows.vault.connections.create({ ...params }) -> Management.CreateFlowsVaultConnectionResponseContent
#### 🔌 Usage
```typescript await client.flows.vault.connections.create({ name: "name", app_id: "ACTIVECAMPAIGN", setup: { type: "API_KEY", api_key: "api_key", base_url: "base_url", }, }); ```
#### ⚙️ Parameters
**request:** `Management.CreateFlowsVaultConnectionRequestContent`
**requestOptions:** `ConnectionsClient.RequestOptions`
client.flows.vault.connections.get(id) -> Management.GetFlowsVaultConnectionResponseContent
#### 🔌 Usage
```typescript await client.flows.vault.connections.get("id"); ```
#### ⚙️ Parameters
**id:** `string` — Flows Vault connection ID
**requestOptions:** `ConnectionsClient.RequestOptions`
client.flows.vault.connections.delete(id) -> void
#### 🔌 Usage
```typescript await client.flows.vault.connections.delete("id"); ```
#### ⚙️ Parameters
**id:** `string` — Vault connection id
**requestOptions:** `ConnectionsClient.RequestOptions`
client.flows.vault.connections.update(id, { ...params }) -> Management.UpdateFlowsVaultConnectionResponseContent
#### 🔌 Usage
```typescript await client.flows.vault.connections.update("id"); ```
#### ⚙️ Parameters
**id:** `string` — Flows Vault connection ID
**request:** `Management.UpdateFlowsVaultConnectionRequestContent`
**requestOptions:** `ConnectionsClient.RequestOptions`
## Groups Members
client.groups.members.get(id, { ...params }) -> core.Page<Management.GroupMember, Management.GetGroupMembersResponseContent>
#### 📝 Description
List all users that are a member of this group.
#### 🔌 Usage
```typescript const pageableResponse = await client.groups.members.get("id", { fields: "fields", include_fields: true, 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.groups.members.get("id", { fields: "fields", include_fields: true, from: "from", take: 1, }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**id:** `string` — Unique identifier for the group (service-generated).
**request:** `Management.GetGroupMembersRequestParameters`
**requestOptions:** `MembersClient.RequestOptions`
## Guardian Enrollments
client.guardian.enrollments.createTicket({ ...params }) -> Management.CreateGuardianEnrollmentTicketResponseContent
#### 📝 Description
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.
#### 🔌 Usage
```typescript await client.guardian.enrollments.createTicket({ user_id: "user_id", }); ```
#### ⚙️ Parameters
**request:** `Management.CreateGuardianEnrollmentTicketRequestContent`
**requestOptions:** `EnrollmentsClient.RequestOptions`
client.guardian.enrollments.get(id) -> Management.GetGuardianEnrollmentResponseContent
#### 📝 Description
Retrieve details, such as status and type, for a specific multi-factor authentication enrollment registered to a user account.
#### 🔌 Usage
```typescript await client.guardian.enrollments.get("id"); ```
#### ⚙️ Parameters
**id:** `string` — ID of the enrollment to be retrieve.
**requestOptions:** `EnrollmentsClient.RequestOptions`
client.guardian.enrollments.delete(id) -> void
#### 📝 Description
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.
#### 🔌 Usage
```typescript await client.guardian.enrollments.delete("id"); ```
#### ⚙️ Parameters
**id:** `string` — ID of the enrollment to be deleted.
**requestOptions:** `EnrollmentsClient.RequestOptions`
## Guardian Factors
client.guardian.factors.list() -> Management.GuardianFactor[]
#### 📝 Description
Retrieve details of all multi-factor authentication factors associated with your tenant.
#### 🔌 Usage
```typescript await client.guardian.factors.list(); ```
#### ⚙️ Parameters
**requestOptions:** `FactorsClient.RequestOptions`
client.guardian.factors.set(name, { ...params }) -> Management.SetGuardianFactorResponseContent
#### 📝 Description
Update the status (i.e., enabled or disabled) of a specific multi-factor authentication factor.
#### 🔌 Usage
```typescript await client.guardian.factors.set("push-notification", { enabled: true, }); ```
#### ⚙️ Parameters
**name:** `Management.GuardianFactorNameEnum` — Factor name. Can be `sms`, `push-notification`, `email`, `duo` `otp` `webauthn-roaming`, `webauthn-platform`, or `recovery-code`.
**request:** `Management.SetGuardianFactorRequestContent`
**requestOptions:** `FactorsClient.RequestOptions`
## Guardian Policies
client.guardian.policies.list() -> Management.ListGuardianPoliciesResponseContent
#### 📝 Description
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.
#### 🔌 Usage
```typescript await client.guardian.policies.list(); ```
#### ⚙️ Parameters
**requestOptions:** `PoliciesClient.RequestOptions`
client.guardian.policies.set({ ...params }) -> Management.SetGuardianPoliciesResponseContent
#### 📝 Description
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.
#### 🔌 Usage
```typescript await client.guardian.policies.set(["all-applications"]); ```
#### ⚙️ Parameters
**request:** `Management.SetGuardianPoliciesRequestContent`
**requestOptions:** `PoliciesClient.RequestOptions`
## Guardian Factors Phone
client.guardian.factors.phone.getMessageTypes() -> Management.GetGuardianFactorPhoneMessageTypesResponseContent
#### 📝 Description
Retrieve list of phone-type MFA factors (i.e., sms and voice) that are enabled for your tenant.
#### 🔌 Usage
```typescript await client.guardian.factors.phone.getMessageTypes(); ```
#### ⚙️ Parameters
**requestOptions:** `PhoneClient.RequestOptions`
client.guardian.factors.phone.setMessageTypes({ ...params }) -> Management.SetGuardianFactorPhoneMessageTypesResponseContent
#### 📝 Description
Replace the list of phone-type MFA factors (i.e., sms and voice) that are enabled for your tenant.
#### 🔌 Usage
```typescript await client.guardian.factors.phone.setMessageTypes({ message_types: ["sms"], }); ```
#### ⚙️ Parameters
**request:** `Management.SetGuardianFactorPhoneMessageTypesRequestContent`
**requestOptions:** `PhoneClient.RequestOptions`
client.guardian.factors.phone.getTwilioProvider() -> Management.GetGuardianFactorsProviderPhoneTwilioResponseContent
#### 📝 Description
Retrieve configuration details for a Twilio phone provider that has been set up in your tenant. To learn more, review Configure SMS and Voice Notifications for MFA.
#### 🔌 Usage
```typescript await client.guardian.factors.phone.getTwilioProvider(); ```
#### ⚙️ Parameters
**requestOptions:** `PhoneClient.RequestOptions`
client.guardian.factors.phone.setTwilioProvider({ ...params }) -> Management.SetGuardianFactorsProviderPhoneTwilioResponseContent
#### 📝 Description
Update the configuration of a Twilio phone provider that has been set up in your tenant. To learn more, review Configure SMS and Voice Notifications for MFA.
#### 🔌 Usage
```typescript await client.guardian.factors.phone.setTwilioProvider(); ```
#### ⚙️ Parameters
**request:** `Management.SetGuardianFactorsProviderPhoneTwilioRequestContent`
**requestOptions:** `PhoneClient.RequestOptions`
client.guardian.factors.phone.getSelectedProvider() -> Management.GetGuardianFactorsProviderPhoneResponseContent
#### 📝 Description
Retrieve details of the multi-factor authentication phone provider configured for your tenant.
#### 🔌 Usage
```typescript await client.guardian.factors.phone.getSelectedProvider(); ```
#### ⚙️ Parameters
**requestOptions:** `PhoneClient.RequestOptions`
client.guardian.factors.phone.setProvider({ ...params }) -> Management.SetGuardianFactorsProviderPhoneResponseContent
#### 🔌 Usage
```typescript await client.guardian.factors.phone.setProvider({ provider: "auth0", }); ```
#### ⚙️ Parameters
**request:** `Management.SetGuardianFactorsProviderPhoneRequestContent`
**requestOptions:** `PhoneClient.RequestOptions`
client.guardian.factors.phone.getTemplates() -> Management.GetGuardianFactorPhoneTemplatesResponseContent
#### 📝 Description
Retrieve details of the multi-factor authentication enrollment and verification templates for phone-type factors available in your tenant.
#### 🔌 Usage
```typescript await client.guardian.factors.phone.getTemplates(); ```
#### ⚙️ Parameters
**requestOptions:** `PhoneClient.RequestOptions`
client.guardian.factors.phone.setTemplates({ ...params }) -> Management.SetGuardianFactorPhoneTemplatesResponseContent
#### 📝 Description
Customize the messages sent to complete phone enrollment and verification (subscription required).
#### 🔌 Usage
```typescript await client.guardian.factors.phone.setTemplates({ enrollment_message: "enrollment_message", verification_message: "verification_message", }); ```
#### ⚙️ Parameters
**request:** `Management.SetGuardianFactorPhoneTemplatesRequestContent`
**requestOptions:** `PhoneClient.RequestOptions`
## Guardian Factors PushNotification
client.guardian.factors.pushNotification.getApnsProvider() -> Management.GetGuardianFactorsProviderApnsResponseContent
#### 📝 Description
Retrieve configuration details for the multi-factor authentication APNS provider associated with your tenant.
#### 🔌 Usage
```typescript await client.guardian.factors.pushNotification.getApnsProvider(); ```
#### ⚙️ Parameters
**requestOptions:** `PushNotificationClient.RequestOptions`
client.guardian.factors.pushNotification.setApnsProvider({ ...params }) -> Management.SetGuardianFactorsProviderPushNotificationApnsResponseContent
#### 📝 Description
Overwrite all configuration details of the multi-factor authentication APNS provider associated with your tenant.
#### 🔌 Usage
```typescript await client.guardian.factors.pushNotification.setApnsProvider(); ```
#### ⚙️ Parameters
**request:** `Management.SetGuardianFactorsProviderPushNotificationApnsRequestContent`
**requestOptions:** `PushNotificationClient.RequestOptions`
client.guardian.factors.pushNotification.updateApnsProvider({ ...params }) -> Management.UpdateGuardianFactorsProviderPushNotificationApnsResponseContent
#### 📝 Description
Modify configuration details of the multi-factor authentication APNS provider associated with your tenant.
#### 🔌 Usage
```typescript await client.guardian.factors.pushNotification.updateApnsProvider(); ```
#### ⚙️ Parameters
**request:** `Management.UpdateGuardianFactorsProviderPushNotificationApnsRequestContent`
**requestOptions:** `PushNotificationClient.RequestOptions`
client.guardian.factors.pushNotification.setFcmProvider({ ...params }) -> Management.SetGuardianFactorsProviderPushNotificationFcmResponseContent
#### 📝 Description
Overwrite all configuration details of the multi-factor authentication FCM provider associated with your tenant.
#### 🔌 Usage
```typescript await client.guardian.factors.pushNotification.setFcmProvider(); ```
#### ⚙️ Parameters
**request:** `Management.SetGuardianFactorsProviderPushNotificationFcmRequestContent`
**requestOptions:** `PushNotificationClient.RequestOptions`
client.guardian.factors.pushNotification.updateFcmProvider({ ...params }) -> Management.UpdateGuardianFactorsProviderPushNotificationFcmResponseContent
#### 📝 Description
Modify configuration details of the multi-factor authentication FCM provider associated with your tenant.
#### 🔌 Usage
```typescript await client.guardian.factors.pushNotification.updateFcmProvider(); ```
#### ⚙️ Parameters
**request:** `Management.UpdateGuardianFactorsProviderPushNotificationFcmRequestContent`
**requestOptions:** `PushNotificationClient.RequestOptions`
client.guardian.factors.pushNotification.setFcmv1Provider({ ...params }) -> Management.SetGuardianFactorsProviderPushNotificationFcmv1ResponseContent
#### 📝 Description
Overwrite all configuration details of the multi-factor authentication FCMV1 provider associated with your tenant.
#### 🔌 Usage
```typescript await client.guardian.factors.pushNotification.setFcmv1Provider(); ```
#### ⚙️ Parameters
**request:** `Management.SetGuardianFactorsProviderPushNotificationFcmv1RequestContent`
**requestOptions:** `PushNotificationClient.RequestOptions`
client.guardian.factors.pushNotification.updateFcmv1Provider({ ...params }) -> Management.UpdateGuardianFactorsProviderPushNotificationFcmv1ResponseContent
#### 📝 Description
Modify configuration details of the multi-factor authentication FCMV1 provider associated with your tenant.
#### 🔌 Usage
```typescript await client.guardian.factors.pushNotification.updateFcmv1Provider(); ```
#### ⚙️ Parameters
**request:** `Management.UpdateGuardianFactorsProviderPushNotificationFcmv1RequestContent`
**requestOptions:** `PushNotificationClient.RequestOptions`
client.guardian.factors.pushNotification.getSnsProvider() -> Management.GetGuardianFactorsProviderSnsResponseContent
#### 📝 Description
Retrieve configuration details for an AWS SNS push notification provider that has been enabled for MFA. To learn more, review Configure Push Notifications for MFA.
#### 🔌 Usage
```typescript await client.guardian.factors.pushNotification.getSnsProvider(); ```
#### ⚙️ Parameters
**requestOptions:** `PushNotificationClient.RequestOptions`
client.guardian.factors.pushNotification.setSnsProvider({ ...params }) -> Management.SetGuardianFactorsProviderPushNotificationSnsResponseContent
#### 📝 Description
Configure the AWS SNS push notification provider configuration (subscription required).
#### 🔌 Usage
```typescript await client.guardian.factors.pushNotification.setSnsProvider(); ```
#### ⚙️ Parameters
**request:** `Management.SetGuardianFactorsProviderPushNotificationSnsRequestContent`
**requestOptions:** `PushNotificationClient.RequestOptions`
client.guardian.factors.pushNotification.updateSnsProvider({ ...params }) -> Management.UpdateGuardianFactorsProviderPushNotificationSnsResponseContent
#### 📝 Description
Configure the AWS SNS push notification provider configuration (subscription required).
#### 🔌 Usage
```typescript await client.guardian.factors.pushNotification.updateSnsProvider(); ```
#### ⚙️ Parameters
**request:** `Management.UpdateGuardianFactorsProviderPushNotificationSnsRequestContent`
**requestOptions:** `PushNotificationClient.RequestOptions`
client.guardian.factors.pushNotification.getSelectedProvider() -> Management.GetGuardianFactorsProviderPushNotificationResponseContent
#### 📝 Description
Modify the push notification provider configured for your tenant. For more information, review Configure Push Notifications for MFA.
#### 🔌 Usage
```typescript await client.guardian.factors.pushNotification.getSelectedProvider(); ```
#### ⚙️ Parameters
**requestOptions:** `PushNotificationClient.RequestOptions`
client.guardian.factors.pushNotification.setProvider({ ...params }) -> Management.SetGuardianFactorsProviderPushNotificationResponseContent
#### 📝 Description
Modify the push notification provider configured for your tenant. For more information, review Configure Push Notifications for MFA.
#### 🔌 Usage
```typescript await client.guardian.factors.pushNotification.setProvider({ provider: "guardian", }); ```
#### ⚙️ Parameters
**request:** `Management.SetGuardianFactorsProviderPushNotificationRequestContent`
**requestOptions:** `PushNotificationClient.RequestOptions`
## Guardian Factors Sms
client.guardian.factors.sms.getTwilioProvider() -> Management.GetGuardianFactorsProviderSmsTwilioResponseContent
#### 📝 Description
Retrieve the Twilio SMS provider configuration (subscription required). A new endpoint is available to retrieve the Twilio configuration related to phone factors (phone Twilio configuration). It has the same payload as this one. Please use it instead.
#### 🔌 Usage
```typescript await client.guardian.factors.sms.getTwilioProvider(); ```
#### ⚙️ Parameters
**requestOptions:** `SmsClient.RequestOptions`
client.guardian.factors.sms.setTwilioProvider({ ...params }) -> Management.SetGuardianFactorsProviderSmsTwilioResponseContent
#### 📝 Description
This endpoint has been deprecated. To complete this action, use the Update Twilio phone configuration endpoint. Previous functionality: Update the Twilio SMS provider configuration.
#### 🔌 Usage
```typescript await client.guardian.factors.sms.setTwilioProvider(); ```
#### ⚙️ Parameters
**request:** `Management.SetGuardianFactorsProviderSmsTwilioRequestContent`
**requestOptions:** `SmsClient.RequestOptions`
client.guardian.factors.sms.getSelectedProvider() -> Management.GetGuardianFactorsProviderSmsResponseContent
#### 📝 Description
This endpoint has been deprecated. To complete this action, use the Retrieve phone configuration endpoint instead. Previous functionality: Retrieve details for the multi-factor authentication SMS provider configured for your tenant.
#### 🔌 Usage
```typescript await client.guardian.factors.sms.getSelectedProvider(); ```
#### ⚙️ Parameters
**requestOptions:** `SmsClient.RequestOptions`
client.guardian.factors.sms.setProvider({ ...params }) -> Management.SetGuardianFactorsProviderSmsResponseContent
#### 📝 Description
This endpoint has been deprecated. To complete this action, use the Update phone configuration endpoint instead. Previous functionality: Update the multi-factor authentication SMS provider configuration in your tenant.
#### 🔌 Usage
```typescript await client.guardian.factors.sms.setProvider({ provider: "auth0", }); ```
#### ⚙️ Parameters
**request:** `Management.SetGuardianFactorsProviderSmsRequestContent`
**requestOptions:** `SmsClient.RequestOptions`
client.guardian.factors.sms.getTemplates() -> Management.GetGuardianFactorSmsTemplatesResponseContent
#### 📝 Description
This endpoint has been deprecated. To complete this action, use the Retrieve enrollment and verification phone templates endpoint instead. Previous function: Retrieve details of SMS enrollment and verification templates configured for your tenant.
#### 🔌 Usage
```typescript await client.guardian.factors.sms.getTemplates(); ```
#### ⚙️ Parameters
**requestOptions:** `SmsClient.RequestOptions`
client.guardian.factors.sms.setTemplates({ ...params }) -> Management.SetGuardianFactorSmsTemplatesResponseContent
#### 📝 Description
This endpoint has been deprecated. To complete this action, use the Update enrollment and verification phone templates endpoint instead. Previous functionality: Customize the messages sent to complete SMS enrollment and verification.
#### 🔌 Usage
```typescript await client.guardian.factors.sms.setTemplates({ enrollment_message: "enrollment_message", verification_message: "verification_message", }); ```
#### ⚙️ Parameters
**request:** `Management.SetGuardianFactorSmsTemplatesRequestContent`
**requestOptions:** `SmsClient.RequestOptions`
## Guardian Factors Duo Settings
client.guardian.factors.duo.settings.get() -> Management.GetGuardianFactorDuoSettingsResponseContent
#### 📝 Description
Retrieves the DUO account and factor configuration.
#### 🔌 Usage
```typescript await client.guardian.factors.duo.settings.get(); ```
#### ⚙️ Parameters
**requestOptions:** `SettingsClient.RequestOptions`
client.guardian.factors.duo.settings.set({ ...params }) -> Management.SetGuardianFactorDuoSettingsResponseContent
#### 📝 Description
Set the DUO account configuration and other properties specific to this factor.
#### 🔌 Usage
```typescript await client.guardian.factors.duo.settings.set(); ```
#### ⚙️ Parameters
**request:** `Management.SetGuardianFactorDuoSettingsRequestContent`
**requestOptions:** `SettingsClient.RequestOptions`
client.guardian.factors.duo.settings.update({ ...params }) -> Management.UpdateGuardianFactorDuoSettingsResponseContent
#### 🔌 Usage
```typescript await client.guardian.factors.duo.settings.update(); ```
#### ⚙️ Parameters
**request:** `Management.UpdateGuardianFactorDuoSettingsRequestContent`
**requestOptions:** `SettingsClient.RequestOptions`
## Hooks Secrets
client.hooks.secrets.get(id) -> Management.GetHookSecretResponseContent
#### 📝 Description
Retrieve a hook's secrets by the ID of the hook.
#### 🔌 Usage
```typescript await client.hooks.secrets.get("id"); ```
#### ⚙️ Parameters
**id:** `string` — ID of the hook to retrieve secrets from.
**requestOptions:** `SecretsClient.RequestOptions`
client.hooks.secrets.create(id, { ...params }) -> void
#### 📝 Description
Add one or more secrets to an existing hook. Accepts an object of key-value pairs, where the key is the name of the secret. A hook can have a maximum of 20 secrets.
#### 🔌 Usage
```typescript await client.hooks.secrets.create("id", { key: "value", }); ```
#### ⚙️ Parameters
**id:** `string` — The id of the hook to retrieve
**request:** `Management.CreateHookSecretRequestContent`
**requestOptions:** `SecretsClient.RequestOptions`
client.hooks.secrets.delete(id, { ...params }) -> void
#### 📝 Description
Delete one or more existing secrets for a given hook. Accepts an array of secret names to delete.
#### 🔌 Usage
```typescript await client.hooks.secrets.delete("id", ["string"]); ```
#### ⚙️ Parameters
**id:** `string` — ID of the hook whose secrets to delete.
**request:** `Management.DeleteHookSecretRequestContent`
**requestOptions:** `SecretsClient.RequestOptions`
client.hooks.secrets.update(id, { ...params }) -> void
#### 📝 Description
Update one or more existing secrets for an existing hook. Accepts an object of key-value pairs, where the key is the name of the existing secret.
#### 🔌 Usage
```typescript await client.hooks.secrets.update("id", { key: "value", }); ```
#### ⚙️ Parameters
**id:** `string` — ID of the hook whose secrets to update.
**request:** `Management.UpdateHookSecretRequestContent`
**requestOptions:** `SecretsClient.RequestOptions`
## Jobs UsersExports
client.jobs.usersExports.create({ ...params }) -> Management.CreateExportUsersResponseContent
#### 📝 Description
Export all users to a file via a long-running job.
#### 🔌 Usage
```typescript await client.jobs.usersExports.create(); ```
#### ⚙️ Parameters
**request:** `Management.CreateExportUsersRequestContent`
**requestOptions:** `UsersExportsClient.RequestOptions`
## Jobs UsersImports
client.jobs.usersImports.create({ ...params }) -> Management.CreateImportUsersResponseContent
#### 📝 Description
Import users from a formatted file into a connection via a long-running job. When importing users, with or without upsert, the `email_verified` is set to `false` when the email address is added or updated. Users must verify their email address. To avoid this behavior, set `email_verified` to `true` in the imported data.
#### 🔌 Usage
```typescript await client.jobs.usersImports.create({ users: fs.createReadStream("/path/to/your/file"), connection_id: "connection_id", }); ```
#### ⚙️ Parameters
**request:** `Management.CreateImportUsersRequestContent`
**requestOptions:** `UsersImportsClient.RequestOptions`
## Jobs VerificationEmail
client.jobs.verificationEmail.create({ ...params }) -> Management.CreateVerificationEmailResponseContent
#### 📝 Description
Send an email to the specified user that asks them to click a link to verify their email address. Note: You must have the `Status` toggle enabled for the verification email template for the email to be sent.
#### 🔌 Usage
```typescript await client.jobs.verificationEmail.create({ user_id: "user_id", }); ```
#### ⚙️ Parameters
**request:** `Management.CreateVerificationEmailRequestContent`
**requestOptions:** `VerificationEmailClient.RequestOptions`
## Jobs Errors
client.jobs.errors.get(id) -> Management.ErrorsGetResponse
#### 📝 Description
Retrieve error details of a failed job.
#### 🔌 Usage
```typescript await client.jobs.errors.get("id"); ```
#### ⚙️ Parameters
**id:** `string` — ID of the job.
**requestOptions:** `ErrorsClient.RequestOptions`
## Keys CustomSigning
client.keys.customSigning.get() -> Management.GetCustomSigningKeysResponseContent
#### 📝 Description
Get entire jwks representation of custom signing keys.
#### 🔌 Usage
```typescript await client.keys.customSigning.get(); ```
#### ⚙️ Parameters
**requestOptions:** `CustomSigningClient.RequestOptions`
client.keys.customSigning.set({ ...params }) -> Management.SetCustomSigningKeysResponseContent
#### 📝 Description
Create or replace entire jwks representation of custom signing keys.
#### 🔌 Usage
```typescript await client.keys.customSigning.set({ keys: [ { kty: "EC", }, ], }); ```
#### ⚙️ Parameters
**request:** `Management.SetCustomSigningKeysRequestContent`
**requestOptions:** `CustomSigningClient.RequestOptions`
client.keys.customSigning.delete() -> void
#### 📝 Description
Delete entire jwks representation of custom signing keys.
#### 🔌 Usage
```typescript await client.keys.customSigning.delete(); ```
#### ⚙️ Parameters
**requestOptions:** `CustomSigningClient.RequestOptions`
## Keys Encryption
client.keys.encryption.list({ ...params }) -> core.Page<Management.EncryptionKey, Management.ListEncryptionKeyOffsetPaginatedResponseContent>
#### 📝 Description
Retrieve details of all the encryption keys associated with your tenant.
#### 🔌 Usage
```typescript const pageableResponse = await client.keys.encryption.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.keys.encryption.list({ page: 1, per_page: 1, include_totals: true, }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Management.ListEncryptionKeysRequestParameters`
**requestOptions:** `EncryptionClient.RequestOptions`
client.keys.encryption.create({ ...params }) -> Management.CreateEncryptionKeyResponseContent
#### 📝 Description
Create the new, pre-activated encryption key, without the key material.
#### 🔌 Usage
```typescript await client.keys.encryption.create({ type: "customer-provided-root-key", }); ```
#### ⚙️ Parameters
**request:** `Management.CreateEncryptionKeyRequestContent`
**requestOptions:** `EncryptionClient.RequestOptions`
client.keys.encryption.rekey() -> void
#### 📝 Description
Perform rekeying operation on the key hierarchy.
#### 🔌 Usage
```typescript await client.keys.encryption.rekey(); ```
#### ⚙️ Parameters
**requestOptions:** `EncryptionClient.RequestOptions`
client.keys.encryption.get(kid) -> Management.GetEncryptionKeyResponseContent
#### 📝 Description
Retrieve details of the encryption key with the given ID.
#### 🔌 Usage
```typescript await client.keys.encryption.get("kid"); ```
#### ⚙️ Parameters
**kid:** `string` — Encryption key ID
**requestOptions:** `EncryptionClient.RequestOptions`
client.keys.encryption.import(kid, { ...params }) -> Management.ImportEncryptionKeyResponseContent
#### 📝 Description
Import wrapped key material and activate encryption key.
#### 🔌 Usage
```typescript await client.keys.encryption.import("kid", { wrapped_key: "wrapped_key", }); ```
#### ⚙️ Parameters
**kid:** `string` — Encryption key ID
**request:** `Management.ImportEncryptionKeyRequestContent`
**requestOptions:** `EncryptionClient.RequestOptions`
client.keys.encryption.delete(kid) -> void
#### 📝 Description
Delete the custom provided encryption key with the given ID and move back to using native encryption key.
#### 🔌 Usage
```typescript await client.keys.encryption.delete("kid"); ```
#### ⚙️ Parameters
**kid:** `string` — Encryption key ID
**requestOptions:** `EncryptionClient.RequestOptions`
client.keys.encryption.createPublicWrappingKey(kid) -> Management.CreateEncryptionKeyPublicWrappingResponseContent
#### 📝 Description
Create the public wrapping key to wrap your own encryption key material.
#### 🔌 Usage
```typescript await client.keys.encryption.createPublicWrappingKey("kid"); ```
#### ⚙️ Parameters
**kid:** `string` — Encryption key ID
**requestOptions:** `EncryptionClient.RequestOptions`
## Keys Signing
client.keys.signing.list() -> Management.SigningKeys[]
#### 📝 Description
Retrieve details of all the application signing keys associated with your tenant.
#### 🔌 Usage
```typescript await client.keys.signing.list(); ```
#### ⚙️ Parameters
**requestOptions:** `SigningClient.RequestOptions`
client.keys.signing.rotate() -> Management.RotateSigningKeysResponseContent
#### 📝 Description
Rotate the application signing key of your tenant.
#### 🔌 Usage
```typescript await client.keys.signing.rotate(); ```
#### ⚙️ Parameters
**requestOptions:** `SigningClient.RequestOptions`
client.keys.signing.get(kid) -> Management.GetSigningKeysResponseContent
#### 📝 Description
Retrieve details of the application signing key with the given ID.
#### 🔌 Usage
```typescript await client.keys.signing.get("kid"); ```
#### ⚙️ Parameters
**kid:** `string` — Key id of the key to retrieve
**requestOptions:** `SigningClient.RequestOptions`
client.keys.signing.revoke(kid) -> Management.RevokedSigningKeysResponseContent
#### 📝 Description
Revoke the application signing key with the given ID.
#### 🔌 Usage
```typescript await client.keys.signing.revoke("kid"); ```
#### ⚙️ Parameters
**kid:** `string` — Key id of the key to revoke
**requestOptions:** `SigningClient.RequestOptions`
## Organizations ClientGrants
client.organizations.clientGrants.list(id, { ...params }) -> core.Page<Management.OrganizationClientGrant, Management.ListOrganizationClientGrantsOffsetPaginatedResponseContent>
#### 🔌 Usage
```typescript const pageableResponse = await client.organizations.clientGrants.list("id", { audience: "audience", client_id: "client_id", 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.organizations.clientGrants.list("id", { audience: "audience", client_id: "client_id", page: 1, per_page: 1, include_totals: true, }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**id:** `string` — Organization identifier.
**request:** `Management.ListOrganizationClientGrantsRequestParameters`
**requestOptions:** `ClientGrantsClient.RequestOptions`
client.organizations.clientGrants.create(id, { ...params }) -> Management.AssociateOrganizationClientGrantResponseContent
#### 🔌 Usage
```typescript await client.organizations.clientGrants.create("id", { grant_id: "grant_id", }); ```
#### ⚙️ Parameters
**id:** `string` — Organization identifier.
**request:** `Management.AssociateOrganizationClientGrantRequestContent`
**requestOptions:** `ClientGrantsClient.RequestOptions`
client.organizations.clientGrants.delete(id, grant_id) -> void
#### 🔌 Usage
```typescript await client.organizations.clientGrants.delete("id", "grant_id"); ```
#### ⚙️ Parameters
**id:** `string` — Organization identifier.
**grant_id:** `string` — The Client Grant ID to remove from the organization
**requestOptions:** `ClientGrantsClient.RequestOptions`
## Organizations Connections
client.organizations.connections.list(id, { ...params }) -> core.Page<Management.OrganizationAllConnectionPost, Management.ListOrganizationAllConnectionsOffsetPaginatedResponseContent>
#### 🔌 Usage
```typescript const pageableResponse = await client.organizations.connections.list("id", { page: 1, per_page: 1, include_totals: true, is_enabled: true, }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.organizations.connections.list("id", { page: 1, per_page: 1, include_totals: true, is_enabled: true, }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**id:** `string` — Organization identifier.
**request:** `Management.ListOrganizationAllConnectionsRequestParameters`
**requestOptions:** `ConnectionsClient.RequestOptions`
client.organizations.connections.create(id, { ...params }) -> Management.CreateOrganizationAllConnectionResponseContent
#### 🔌 Usage
```typescript await client.organizations.connections.create("id", { connection_id: "connection_id", }); ```
#### ⚙️ Parameters
**id:** `string` — Organization identifier.
**request:** `Management.CreateOrganizationAllConnectionRequestParameters`
**requestOptions:** `ConnectionsClient.RequestOptions`
client.organizations.connections.get(id, connection_id) -> Management.GetOrganizationAllConnectionResponseContent
#### 🔌 Usage
```typescript await client.organizations.connections.get("id", "connection_id"); ```
#### ⚙️ Parameters
**id:** `string` — Organization identifier.
**connection_id:** `string` — Connection identifier.
**requestOptions:** `ConnectionsClient.RequestOptions`
client.organizations.connections.delete(id, connection_id) -> void
#### 🔌 Usage
```typescript await client.organizations.connections.delete("id", "connection_id"); ```
#### ⚙️ Parameters
**id:** `string` — Organization identifier.
**connection_id:** `string` — Connection identifier.
**requestOptions:** `ConnectionsClient.RequestOptions`
client.organizations.connections.update(id, connection_id, { ...params }) -> Management.UpdateOrganizationAllConnectionResponseContent
#### 🔌 Usage
```typescript await client.organizations.connections.update("id", "connection_id"); ```
#### ⚙️ Parameters
**id:** `string` — Organization identifier.
**connection_id:** `string` — Connection identifier.
**request:** `Management.UpdateOrganizationConnectionRequestParameters`
**requestOptions:** `ConnectionsClient.RequestOptions`
## Organizations DiscoveryDomains
client.organizations.discoveryDomains.list(id, { ...params }) -> core.Page<Management.OrganizationDiscoveryDomain, Management.ListOrganizationDiscoveryDomainsResponseContent>
#### 📝 Description
Retrieve list of all organization discovery domains associated with the specified organization. This endpoint is subject to eventual consistency; newly created, updated, or deleted discovery domains may not immediately appear in the response.
#### 🔌 Usage
```typescript const pageableResponse = await client.organizations.discoveryDomains.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.organizations.discoveryDomains.list("id", { from: "from", take: 1, }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**id:** `string` — ID of the organization.
**request:** `Management.ListOrganizationDiscoveryDomainsRequestParameters`
**requestOptions:** `DiscoveryDomainsClient.RequestOptions`
client.organizations.discoveryDomains.create(id, { ...params }) -> Management.CreateOrganizationDiscoveryDomainResponseContent
#### 📝 Description
Create a new discovery domain for an organization.
#### 🔌 Usage
```typescript await client.organizations.discoveryDomains.create("id", { domain: "domain", }); ```
#### ⚙️ Parameters
**id:** `string` — ID of the organization.
**request:** `Management.CreateOrganizationDiscoveryDomainRequestContent`
**requestOptions:** `DiscoveryDomainsClient.RequestOptions`
client.organizations.discoveryDomains.getByName(id, discovery_domain) -> Management.GetOrganizationDiscoveryDomainByNameResponseContent
#### 📝 Description
Retrieve details about a single organization discovery domain specified by domain name. This endpoint is subject to eventual consistency; newly created, updated, or deleted discovery domains may not immediately appear in the response.
#### 🔌 Usage
```typescript await client.organizations.discoveryDomains.getByName("id", "discovery_domain"); ```
#### ⚙️ Parameters
**id:** `string` — ID of the organization.
**discovery_domain:** `string` — Domain name of the discovery domain.
**requestOptions:** `DiscoveryDomainsClient.RequestOptions`
client.organizations.discoveryDomains.get(id, discovery_domain_id) -> Management.GetOrganizationDiscoveryDomainResponseContent
#### 📝 Description
Retrieve details about a single organization discovery domain specified by ID. This endpoint is subject to eventual consistency; newly created, updated, or deleted discovery domains may not immediately appear in the response.
#### 🔌 Usage
```typescript await client.organizations.discoveryDomains.get("id", "discovery_domain_id"); ```
#### ⚙️ Parameters
**id:** `string` — ID of the organization.
**discovery_domain_id:** `string` — ID of the discovery domain.
**requestOptions:** `DiscoveryDomainsClient.RequestOptions`
client.organizations.discoveryDomains.delete(id, discovery_domain_id) -> void
#### 📝 Description
Remove a discovery domain from an organization. This action cannot be undone.
#### 🔌 Usage
```typescript await client.organizations.discoveryDomains.delete("id", "discovery_domain_id"); ```
#### ⚙️ Parameters
**id:** `string` — ID of the organization.
**discovery_domain_id:** `string` — ID of the discovery domain.
**requestOptions:** `DiscoveryDomainsClient.RequestOptions`
client.organizations.discoveryDomains.update(id, discovery_domain_id, { ...params }) -> Management.UpdateOrganizationDiscoveryDomainResponseContent
#### 📝 Description
Update the verification status and/or use_for_organization_discovery for an organization discovery domain. The status field must be either pending or verified. The use_for_organization_discovery field can be true or false (default: true).
#### 🔌 Usage
```typescript await client.organizations.discoveryDomains.update("id", "discovery_domain_id"); ```
#### ⚙️ Parameters
**id:** `string` — ID of the organization.
**discovery_domain_id:** `string` — ID of the discovery domain to update.
**request:** `Management.UpdateOrganizationDiscoveryDomainRequestContent`
**requestOptions:** `DiscoveryDomainsClient.RequestOptions`
## Organizations EnabledConnections
client.organizations.enabledConnections.list(id, { ...params }) -> core.Page<Management.OrganizationConnection, Management.ListOrganizationConnectionsOffsetPaginatedResponseContent>
#### 📝 Description
Retrieve details about a specific connection currently enabled for an Organization. Information returned includes details such as connection ID, name, strategy, and whether the connection automatically grants membership upon login.
#### 🔌 Usage
```typescript const pageableResponse = await client.organizations.enabledConnections.list("id", { 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.organizations.enabledConnections.list("id", { page: 1, per_page: 1, include_totals: true, }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**id:** `string` — Organization identifier.
**request:** `Management.ListOrganizationConnectionsRequestParameters`
**requestOptions:** `EnabledConnectionsClient.RequestOptions`
client.organizations.enabledConnections.add(id, { ...params }) -> Management.AddOrganizationConnectionResponseContent
#### 📝 Description
Enable a specific connection for a given Organization. To enable a connection, it must already exist within your tenant; connections cannot be created through this action. Connections represent the relationship between Auth0 and a source of users. Available types of connections include database, enterprise, and social.
#### 🔌 Usage
```typescript await client.organizations.enabledConnections.add("id", { connection_id: "connection_id", }); ```
#### ⚙️ Parameters
**id:** `string` — Organization identifier.
**request:** `Management.AddOrganizationConnectionRequestContent`
**requestOptions:** `EnabledConnectionsClient.RequestOptions`
client.organizations.enabledConnections.get(id, connectionId) -> Management.GetOrganizationConnectionResponseContent
#### 📝 Description
Retrieve details about a specific connection currently enabled for an Organization. Information returned includes details such as connection ID, name, strategy, and whether the connection automatically grants membership upon login.
#### 🔌 Usage
```typescript await client.organizations.enabledConnections.get("id", "connectionId"); ```
#### ⚙️ Parameters
**id:** `string` — Organization identifier.
**connectionId:** `string` — Connection identifier.
**requestOptions:** `EnabledConnectionsClient.RequestOptions`
client.organizations.enabledConnections.delete(id, connectionId) -> void
#### 📝 Description
Disable a specific connection for an Organization. Once disabled, Organization members can no longer use that connection to authenticate. Note: This action does not remove the connection from your tenant.
#### 🔌 Usage
```typescript await client.organizations.enabledConnections.delete("id", "connectionId"); ```
#### ⚙️ Parameters
**id:** `string` — Organization identifier.
**connectionId:** `string` — Connection identifier.
**requestOptions:** `EnabledConnectionsClient.RequestOptions`
client.organizations.enabledConnections.update(id, connectionId, { ...params }) -> Management.UpdateOrganizationConnectionResponseContent
#### 📝 Description
Modify the details of a specific connection currently enabled for an Organization.
#### 🔌 Usage
```typescript await client.organizations.enabledConnections.update("id", "connectionId"); ```
#### ⚙️ Parameters
**id:** `string` — Organization identifier.
**connectionId:** `string` — Connection identifier.
**request:** `Management.UpdateOrganizationConnectionRequestContent`
**requestOptions:** `EnabledConnectionsClient.RequestOptions`
## Organizations Invitations
client.organizations.invitations.list(id, { ...params }) -> core.Page<Management.OrganizationInvitation, Management.ListOrganizationInvitationsOffsetPaginatedResponseContent>
#### 📝 Description
Retrieve a detailed list of invitations sent to users for a specific Organization. The list includes details such as inviter and invitee information, invitation URLs, and dates of creation and expiration. To learn more about Organization invitations, review Invite Organization Members.
#### 🔌 Usage
```typescript const pageableResponse = await client.organizations.invitations.list("id", { page: 1, per_page: 1, include_totals: true, fields: "fields", include_fields: true, sort: "sort", }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.organizations.invitations.list("id", { page: 1, per_page: 1, include_totals: true, fields: "fields", include_fields: true, sort: "sort", }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**id:** `string` — Organization identifier.
**request:** `Management.ListOrganizationInvitationsRequestParameters`
**requestOptions:** `InvitationsClient.RequestOptions`
client.organizations.invitations.create(id, { ...params }) -> Management.CreateOrganizationInvitationResponseContent
#### 📝 Description
Create a user invitation for a specific Organization. Upon creation, the listed user receives an email inviting them to join the Organization. To learn more about Organization invitations, review Invite Organization Members.
#### 🔌 Usage
```typescript await client.organizations.invitations.create("id", { inviter: { name: "name", }, invitee: { email: "email", }, client_id: "client_id", }); ```
#### ⚙️ Parameters
**id:** `string` — Organization identifier.
**request:** `Management.CreateOrganizationInvitationRequestContent`
**requestOptions:** `InvitationsClient.RequestOptions`
client.organizations.invitations.get(id, invitation_id, { ...params }) -> Management.GetOrganizationInvitationResponseContent
#### 🔌 Usage
```typescript await client.organizations.invitations.get("id", "invitation_id", { fields: "fields", include_fields: true, }); ```
#### ⚙️ Parameters
**id:** `string` — Organization identifier.
**invitation_id:** `string` — The id of the user invitation.
**request:** `Management.GetOrganizationInvitationRequestParameters`
**requestOptions:** `InvitationsClient.RequestOptions`
client.organizations.invitations.delete(id, invitation_id) -> void
#### 🔌 Usage
```typescript await client.organizations.invitations.delete("id", "invitation_id"); ```
#### ⚙️ Parameters
**id:** `string` — Organization identifier.
**invitation_id:** `string` — The id of the user invitation.
**requestOptions:** `InvitationsClient.RequestOptions`
## Organizations Members
client.organizations.members.list(id, { ...params }) -> core.Page<Management.OrganizationMember, Management.ListOrganizationMembersPaginatedResponseContent>
#### 📝 Description
List organization members. This endpoint is subject to eventual consistency. New users may not be immediately included in the response and deleted users may not be immediately removed from it.
  • Use the fields parameter to optionally define the specific member details retrieved. If fields is left blank, all fields (except roles) are returned.
  • Member roles are not sent by default. Use 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.
This endpoint supports two types of pagination: - Offset pagination - Checkpoint pagination Checkpoint pagination must be used if you need to retrieve more than 1000 organization members.

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, you should omit the 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.
#### 🔌 Usage
```typescript const pageableResponse = await client.organizations.members.list("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.organizations.members.list("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; ```
#### ⚙️ Parameters
**id:** `string` — Organization identifier.
**request:** `Management.ListOrganizationMembersRequestParameters`
**requestOptions:** `MembersClient.RequestOptions`
client.organizations.members.create(id, { ...params }) -> void
#### 📝 Description
Set one or more existing users as members of a specific Organization. To add a user to an Organization through this action, the user must already exist in your tenant. If a user does not yet exist, you can invite them to create an account, manually create them through the Auth0 Dashboard, or use the Management API.
#### 🔌 Usage
```typescript await client.organizations.members.create("id", { members: ["members"], }); ```
#### ⚙️ Parameters
**id:** `string` — Organization identifier.
**request:** `Management.CreateOrganizationMemberRequestContent`
**requestOptions:** `MembersClient.RequestOptions`
client.organizations.members.delete(id, { ...params }) -> void
#### 🔌 Usage
```typescript await client.organizations.members.delete("id", { members: ["members"], }); ```
#### ⚙️ Parameters
**id:** `string` — Organization identifier.
**request:** `Management.DeleteOrganizationMembersRequestContent`
**requestOptions:** `MembersClient.RequestOptions`
## Organizations Members Roles
client.organizations.members.roles.list(id, user_id, { ...params }) -> core.Page<Management.Role, Management.ListOrganizationMemberRolesOffsetPaginatedResponseContent>
#### 📝 Description
Retrieve detailed list of roles assigned to a given user within the context of a specific Organization. Users can be members of multiple Organizations with unique roles assigned for each membership. This action only returns the roles associated with the specified Organization; any roles assigned to the user within other Organizations are not included.
#### 🔌 Usage
```typescript const pageableResponse = await client.organizations.members.roles.list("id", "user_id", { 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.organizations.members.roles.list("id", "user_id", { page: 1, per_page: 1, include_totals: true, }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**id:** `string` — Organization identifier.
**user_id:** `string` — ID of the user to associate roles with.
**request:** `Management.ListOrganizationMemberRolesRequestParameters`
**requestOptions:** `RolesClient.RequestOptions`
client.organizations.members.roles.assign(id, user_id, { ...params }) -> void
#### 📝 Description
Assign one or more roles to a user to determine their access for a specific Organization. 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.
#### 🔌 Usage
```typescript await client.organizations.members.roles.assign("id", "user_id", { roles: ["roles"], }); ```
#### ⚙️ Parameters
**id:** `string` — Organization identifier.
**user_id:** `string` — ID of the user to associate roles with.
**request:** `Management.AssignOrganizationMemberRolesRequestContent`
**requestOptions:** `RolesClient.RequestOptions`
client.organizations.members.roles.delete(id, user_id, { ...params }) -> void
#### 📝 Description
Remove one or more Organization-specific roles from a given user. Users can be members of multiple Organizations with unique roles assigned for each membership. This action removes roles from a user in relation to the specified Organization. Roles assigned to the user within a different Organization cannot be managed in the same call.
#### 🔌 Usage
```typescript await client.organizations.members.roles.delete("id", "user_id", { roles: ["roles"], }); ```
#### ⚙️ Parameters
**id:** `string` — Organization identifier.
**user_id:** `string` — User ID of the organization member to remove roles from.
**request:** `Management.DeleteOrganizationMemberRolesRequestContent`
**requestOptions:** `RolesClient.RequestOptions`
## Prompts Rendering
client.prompts.rendering.list({ ...params }) -> core.Page<Management.ListAculsResponseContentItem, Management.ListAculsOffsetPaginatedResponseContent>
#### 📝 Description
Get render setting configurations for all screens.
#### 🔌 Usage
```typescript const pageableResponse = await client.prompts.rendering.list({ fields: "fields", include_fields: true, page: 1, per_page: 1, include_totals: true, prompt: "prompt", screen: "screen", rendering_mode: "advanced", }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.prompts.rendering.list({ fields: "fields", include_fields: true, page: 1, per_page: 1, include_totals: true, prompt: "prompt", screen: "screen", rendering_mode: "advanced", }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Management.ListAculsRequestParameters`
**requestOptions:** `RenderingClient.RequestOptions`
client.prompts.rendering.bulkUpdate({ ...params }) -> Management.BulkUpdateAculResponseContent
#### 📝 Description
Learn more about configuring render settings for advanced customization.
#### 🔌 Usage
```typescript await client.prompts.rendering.bulkUpdate({ configs: [ { prompt: "login", screen: "login", }, ], }); ```
#### ⚙️ Parameters
**request:** `Management.BulkUpdateAculRequestContent`
**requestOptions:** `RenderingClient.RequestOptions`
client.prompts.rendering.get(prompt, screen) -> Management.GetAculResponseContent
#### 📝 Description
Get render settings for a screen.
#### 🔌 Usage
```typescript await client.prompts.rendering.get("login", "login"); ```
#### ⚙️ Parameters
**prompt:** `Management.PromptGroupNameEnum` — Name of the prompt
**screen:** `Management.ScreenGroupNameEnum` — Name of the screen
**requestOptions:** `RenderingClient.RequestOptions`
client.prompts.rendering.update(prompt, screen, { ...params }) -> Management.UpdateAculResponseContent
#### 📝 Description
Learn more about configuring render settings for advanced customization.
#### 🔌 Usage
```typescript await client.prompts.rendering.update("login", "login"); ```
#### ⚙️ Parameters
**prompt:** `Management.PromptGroupNameEnum` — Name of the prompt
**screen:** `Management.ScreenGroupNameEnum` — Name of the screen
**request:** `Management.UpdateAculRequestContent`
**requestOptions:** `RenderingClient.RequestOptions`
## Prompts CustomText
client.prompts.customText.get(prompt, language) -> Management.GetCustomTextsByLanguageResponseContent
#### 📝 Description
Retrieve custom text for a specific prompt and language.
#### 🔌 Usage
```typescript await client.prompts.customText.get("login", "am"); ```
#### ⚙️ Parameters
**prompt:** `Management.PromptGroupNameEnum` — Name of the prompt.
**language:** `Management.PromptLanguageEnum` — Language to update.
**requestOptions:** `CustomTextClient.RequestOptions`
client.prompts.customText.set(prompt, language, { ...params }) -> void
#### 📝 Description
Set custom text for a specific prompt. Existing texts will be overwritten.
#### 🔌 Usage
```typescript await client.prompts.customText.set("login", "am", { key: "value", }); ```
#### ⚙️ Parameters
**prompt:** `Management.PromptGroupNameEnum` — Name of the prompt.
**language:** `Management.PromptLanguageEnum` — Language to update.
**request:** `Management.SetsCustomTextsByLanguageRequestContent`
**requestOptions:** `CustomTextClient.RequestOptions`
## Prompts Partials
client.prompts.partials.get(prompt) -> Management.GetPartialsResponseContent
#### 📝 Description
Get template partials for a prompt
#### 🔌 Usage
```typescript await client.prompts.partials.get("login"); ```
#### ⚙️ Parameters
**prompt:** `Management.PartialGroupsEnum` — Name of the prompt.
**requestOptions:** `PartialsClient.RequestOptions`
client.prompts.partials.set(prompt, { ...params }) -> void
#### 📝 Description
Set template partials for a prompt
#### 🔌 Usage
```typescript await client.prompts.partials.set("login", { key: "value", }); ```
#### ⚙️ Parameters
**prompt:** `Management.PartialGroupsEnum` — Name of the prompt.
**request:** `Management.SetPartialsRequestContent`
**requestOptions:** `PartialsClient.RequestOptions`
## RiskAssessments Settings
client.riskAssessments.settings.get() -> Management.GetRiskAssessmentsSettingsResponseContent
#### 📝 Description
Gets the tenant settings for risk assessments
#### 🔌 Usage
```typescript await client.riskAssessments.settings.get(); ```
#### ⚙️ Parameters
**requestOptions:** `SettingsClient.RequestOptions`
client.riskAssessments.settings.update({ ...params }) -> Management.UpdateRiskAssessmentsSettingsResponseContent
#### 📝 Description
Updates the tenant settings for risk assessments
#### 🔌 Usage
```typescript await client.riskAssessments.settings.update({ enabled: true, }); ```
#### ⚙️ Parameters
**request:** `Management.UpdateRiskAssessmentsSettingsRequestContent`
**requestOptions:** `SettingsClient.RequestOptions`
## RiskAssessments Settings NewDevice
client.riskAssessments.settings.newDevice.get() -> Management.GetRiskAssessmentsSettingsNewDeviceResponseContent
#### 📝 Description
Gets the risk assessment settings for the new device assessor
#### 🔌 Usage
```typescript await client.riskAssessments.settings.newDevice.get(); ```
#### ⚙️ Parameters
**requestOptions:** `NewDeviceClient.RequestOptions`
client.riskAssessments.settings.newDevice.update({ ...params }) -> Management.UpdateRiskAssessmentsSettingsNewDeviceResponseContent
#### 📝 Description
Updates the risk assessment settings for the new device assessor
#### 🔌 Usage
```typescript await client.riskAssessments.settings.newDevice.update({ remember_for: 1, }); ```
#### ⚙️ Parameters
**request:** `Management.UpdateRiskAssessmentsSettingsNewDeviceRequestContent`
**requestOptions:** `NewDeviceClient.RequestOptions`
## Roles Permissions
client.roles.permissions.list(id, { ...params }) -> core.Page<Management.PermissionsResponsePayload, Management.ListRolePermissionsOffsetPaginatedResponseContent>
#### 📝 Description
Retrieve detailed list (name, description, resource server) of permissions granted by a specified user role.
#### 🔌 Usage
```typescript const pageableResponse = await client.roles.permissions.list("id", { per_page: 1, 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.roles.permissions.list("id", { per_page: 1, page: 1, include_totals: true, }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**id:** `string` — ID of the role to list granted permissions.
**request:** `Management.ListRolePermissionsRequestParameters`
**requestOptions:** `PermissionsClient.RequestOptions`
client.roles.permissions.add(id, { ...params }) -> void
#### 📝 Description
Add one or more permissions to a specified user role.
#### 🔌 Usage
```typescript await client.roles.permissions.add("id", { permissions: [ { resource_server_identifier: "resource_server_identifier", permission_name: "permission_name", }, ], }); ```
#### ⚙️ Parameters
**id:** `string` — ID of the role to add permissions to.
**request:** `Management.AddRolePermissionsRequestContent`
**requestOptions:** `PermissionsClient.RequestOptions`
client.roles.permissions.delete(id, { ...params }) -> void
#### 📝 Description
Remove one or more permissions from a specified user role.
#### 🔌 Usage
```typescript await client.roles.permissions.delete("id", { permissions: [ { resource_server_identifier: "resource_server_identifier", permission_name: "permission_name", }, ], }); ```
#### ⚙️ Parameters
**id:** `string` — ID of the role to remove permissions from.
**request:** `Management.DeleteRolePermissionsRequestContent`
**requestOptions:** `PermissionsClient.RequestOptions`
## Roles Users
client.roles.users.list(id, { ...params }) -> core.Page<Management.RoleUser, Management.ListRoleUsersPaginatedResponseContent>
#### 📝 Description
Retrieve list of users associated with a specific role. For Dashboard instructions, review View Users Assigned to Roles. This endpoint supports two types of pagination:
  • Offset pagination
  • Checkpoint pagination
Checkpoint pagination must be used if you need to retrieve more than 1000 organization members.

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.
#### 🔌 Usage
```typescript const pageableResponse = await client.roles.users.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.roles.users.list("id", { from: "from", take: 1, }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**id:** `string` — ID of the role to retrieve a list of users associated with.
**request:** `Management.ListRoleUsersRequestParameters`
**requestOptions:** `UsersClient.RequestOptions`
client.roles.users.assign(id, { ...params }) -> void
#### 📝 Description
Assign one or more users to an existing user role. To learn more, review Role-Based Access Control. Note: New roles cannot be created through this action.
#### 🔌 Usage
```typescript await client.roles.users.assign("id", { users: ["users"], }); ```
#### ⚙️ Parameters
**id:** `string` — ID of the role to assign users to.
**request:** `Management.AssignRoleUsersRequestContent`
**requestOptions:** `UsersClient.RequestOptions`
## SelfServiceProfiles CustomText
client.selfServiceProfiles.customText.list(id, language, page) -> Management.ListSelfServiceProfileCustomTextResponseContent
#### 📝 Description
Retrieves text customizations for a given self-service profile, language and Self Service SSO Flow page.
#### 🔌 Usage
```typescript await client.selfServiceProfiles.customText.list("id", "en", "get-started"); ```
#### ⚙️ Parameters
**id:** `string` — The id of the self-service profile.
**language:** `Management.SelfServiceProfileCustomTextLanguageEnum` — The language of the custom text.
**page:** `Management.SelfServiceProfileCustomTextPageEnum` — The page where the custom text is shown.
**requestOptions:** `CustomTextClient.RequestOptions`
client.selfServiceProfiles.customText.set(id, language, page, { ...params }) -> Management.SetSelfServiceProfileCustomTextResponseContent
#### 📝 Description
Updates text customizations for a given self-service profile, language and Self Service SSO Flow page.
#### 🔌 Usage
```typescript await client.selfServiceProfiles.customText.set("id", "en", "get-started", { key: "value", }); ```
#### ⚙️ Parameters
**id:** `string` — The id of the self-service profile.
**language:** `Management.SelfServiceProfileCustomTextLanguageEnum` — The language of the custom text.
**page:** `Management.SelfServiceProfileCustomTextPageEnum` — The page where the custom text is shown.
**request:** `Management.SetSelfServiceProfileCustomTextRequestContent`
**requestOptions:** `CustomTextClient.RequestOptions`
## SelfServiceProfiles SsoTicket
client.selfServiceProfiles.ssoTicket.create(id, { ...params }) -> Management.CreateSelfServiceProfileSsoTicketResponseContent
#### 📝 Description
Creates an SSO access ticket to initiate the Self Service SSO Flow using a self-service profile.
#### 🔌 Usage
```typescript await client.selfServiceProfiles.ssoTicket.create("id"); ```
#### ⚙️ Parameters
**id:** `string` — The id of the self-service profile to retrieve
**request:** `Management.CreateSelfServiceProfileSsoTicketRequestContent`
**requestOptions:** `SsoTicketClient.RequestOptions`
client.selfServiceProfiles.ssoTicket.revoke(profileId, id) -> void
#### 📝 Description
Revokes an SSO access ticket and invalidates associated sessions. The ticket will no longer be accepted to initiate a Self-Service SSO session. If any users have already started a session through this ticket, their session will be terminated. Clients should expect a `202 Accepted` response upon successful processing, indicating that the request has been acknowledged and that the revocation is underway but may not be fully completed at the time of response. If the specified ticket does not exist, a `202 Accepted` response is also returned, signaling that no further action is required. Clients should treat these `202` responses as an acknowledgment that the request has been accepted and is in progress, even if the ticket was not found.
#### 🔌 Usage
```typescript await client.selfServiceProfiles.ssoTicket.revoke("profileId", "id"); ```
#### ⚙️ Parameters
**profileId:** `string` — The id of the self-service profile
**id:** `string` — The id of the ticket to revoke
**requestOptions:** `SsoTicketClient.RequestOptions`
## Tenants Settings
client.tenants.settings.get({ ...params }) -> Management.GetTenantSettingsResponseContent
#### 📝 Description
Retrieve tenant settings. A list of fields to include or exclude may also be specified.
#### 🔌 Usage
```typescript await client.tenants.settings.get({ fields: "fields", include_fields: true, }); ```
#### ⚙️ Parameters
**request:** `Management.GetTenantSettingsRequestParameters`
**requestOptions:** `SettingsClient.RequestOptions`
client.tenants.settings.update({ ...params }) -> Management.UpdateTenantSettingsResponseContent
#### 📝 Description
Update settings for a tenant.
#### 🔌 Usage
```typescript await client.tenants.settings.update(); ```
#### ⚙️ Parameters
**request:** `Management.UpdateTenantSettingsRequestContent`
**requestOptions:** `SettingsClient.RequestOptions`
## Users AuthenticationMethods
client.users.authenticationMethods.list(id, { ...params }) -> core.Page<Management.UserAuthenticationMethod, Management.ListUserAuthenticationMethodsOffsetPaginatedResponseContent>
#### 📝 Description
Retrieve detailed list of authentication methods associated with a specified user.
#### 🔌 Usage
```typescript const pageableResponse = await client.users.authenticationMethods.list("id", { 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.users.authenticationMethods.list("id", { page: 1, per_page: 1, include_totals: true, }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**id:** `string` — The ID of the user in question.
**request:** `Management.ListUserAuthenticationMethodsRequestParameters`
**requestOptions:** `AuthenticationMethodsClient.RequestOptions`
client.users.authenticationMethods.create(id, { ...params }) -> Management.CreateUserAuthenticationMethodResponseContent
#### 📝 Description
Create an authentication method. Authentication methods created via this endpoint will be auto confirmed and should already have verification completed.
#### 🔌 Usage
```typescript await client.users.authenticationMethods.create("id", { type: "phone", }); ```
#### ⚙️ Parameters
**id:** `string` — The ID of the user to whom the new authentication method will be assigned.
**request:** `Management.CreateUserAuthenticationMethodRequestContent`
**requestOptions:** `AuthenticationMethodsClient.RequestOptions`
client.users.authenticationMethods.set(id, { ...params }) -> Management.SetUserAuthenticationMethodResponseContent[]
#### 📝 Description
Replace the specified user authentication methods with supplied values. Note: Authentication methods supplied through this action do not iterate on existing methods. Instead, any methods passed will overwrite the user’s existing settings.
#### 🔌 Usage
```typescript await client.users.authenticationMethods.set("id", [ { type: "phone", }, ]); ```
#### ⚙️ Parameters
**id:** `string` — The ID of the user in question.
**request:** `Management.SetUserAuthenticationMethodsRequestContent`
**requestOptions:** `AuthenticationMethodsClient.RequestOptions`
client.users.authenticationMethods.deleteAll(id) -> void
#### 📝 Description
Remove all authentication methods (i.e., enrolled MFA factors) from the specified user account. This action cannot be undone.
#### 🔌 Usage
```typescript await client.users.authenticationMethods.deleteAll("id"); ```
#### ⚙️ Parameters
**id:** `string` — The ID of the user in question.
**requestOptions:** `AuthenticationMethodsClient.RequestOptions`
client.users.authenticationMethods.get(id, authentication_method_id) -> Management.GetUserAuthenticationMethodResponseContent
#### 🔌 Usage
```typescript await client.users.authenticationMethods.get("id", "authentication_method_id"); ```
#### ⚙️ Parameters
**id:** `string` — The ID of the user in question.
**authentication_method_id:** `string` — The ID of the authentication methods in question.
**requestOptions:** `AuthenticationMethodsClient.RequestOptions`
client.users.authenticationMethods.delete(id, authentication_method_id) -> void
#### 📝 Description
Remove the authentication method with the given ID from the specified user. For more information, review Manage Authentication Methods with Management API.
#### 🔌 Usage
```typescript await client.users.authenticationMethods.delete("id", "authentication_method_id"); ```
#### ⚙️ Parameters
**id:** `string` — The ID of the user in question.
**authentication_method_id:** `string` — The ID of the authentication method to delete.
**requestOptions:** `AuthenticationMethodsClient.RequestOptions`
client.users.authenticationMethods.update(id, authentication_method_id, { ...params }) -> Management.UpdateUserAuthenticationMethodResponseContent
#### 📝 Description
Modify the authentication method with the given ID from the specified user. For more information, review Manage Authentication Methods with Management API.
#### 🔌 Usage
```typescript await client.users.authenticationMethods.update("id", "authentication_method_id"); ```
#### ⚙️ Parameters
**id:** `string` — The ID of the user in question.
**authentication_method_id:** `string` — The ID of the authentication method to update.
**request:** `Management.UpdateUserAuthenticationMethodRequestContent`
**requestOptions:** `AuthenticationMethodsClient.RequestOptions`
## Users Authenticators
client.users.authenticators.deleteAll(id) -> void
#### 📝 Description
Remove all authenticators registered to a given user ID, such as OTP, email, phone, and push-notification. This action cannot be undone. For more information, review Manage Authentication Methods with Management API.
#### 🔌 Usage
```typescript await client.users.authenticators.deleteAll("id"); ```
#### ⚙️ Parameters
**id:** `string` — ID of the user to delete.
**requestOptions:** `AuthenticatorsClient.RequestOptions`
## Users ConnectedAccounts
client.users.connectedAccounts.list(id, { ...params }) -> core.Page<Management.ConnectedAccount, Management.ListUserConnectedAccountsResponseContent>
#### 📝 Description
Retrieve all connected accounts associated with the user.
#### 🔌 Usage
```typescript const pageableResponse = await client.users.connectedAccounts.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.users.connectedAccounts.list("id", { from: "from", take: 1, }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**id:** `string` — ID of the user to list connected accounts for.
**request:** `Management.GetUserConnectedAccountsRequestParameters`
**requestOptions:** `ConnectedAccountsClient.RequestOptions`
## Users Enrollments
client.users.enrollments.get(id) -> Management.UsersEnrollment[]
#### 📝 Description
Retrieve the first multi-factor authentication enrollment that a specific user has confirmed.
#### 🔌 Usage
```typescript await client.users.enrollments.get("id"); ```
#### ⚙️ Parameters
**id:** `string` — ID of the user to list enrollments for.
**requestOptions:** `EnrollmentsClient.RequestOptions`
## Users FederatedConnectionsTokensets
client.users.federatedConnectionsTokensets.list(id) -> Management.FederatedConnectionTokenSet[]
#### 📝 Description
List active federated connections tokensets for a provided user
#### 🔌 Usage
```typescript await client.users.federatedConnectionsTokensets.list("id"); ```
#### ⚙️ Parameters
**id:** `string` — User identifier
**requestOptions:** `FederatedConnectionsTokensetsClient.RequestOptions`
client.users.federatedConnectionsTokensets.delete(id, tokenset_id) -> void
#### 🔌 Usage
```typescript await client.users.federatedConnectionsTokensets.delete("id", "tokenset_id"); ```
#### ⚙️ Parameters
**id:** `string` — Id of the user that owns the tokenset
**tokenset_id:** `string` — The tokenset id
**requestOptions:** `FederatedConnectionsTokensetsClient.RequestOptions`
## Users Groups
client.users.groups.get(id, { ...params }) -> core.Page<Management.UserGroupsResponseSchema, Management.GetUserGroupsPaginatedResponseContent>
#### 📝 Description
List all groups to which this user belongs.
#### 🔌 Usage
```typescript const pageableResponse = await client.users.groups.get("id", { fields: "fields", include_fields: true, 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.users.groups.get("id", { fields: "fields", include_fields: true, from: "from", take: 1, }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**id:** `string` — ID of the user to list groups for.
**request:** `Management.GetUserGroupsRequestParameters`
**requestOptions:** `GroupsClient.RequestOptions`
## Users Identities
client.users.identities.link(id, { ...params }) -> Management.UserIdentity[]
#### 📝 Description
Link two user accounts together forming a primary and secondary relationship. On successful linking, the endpoint returns the new array of the primary account identities. Note: There are two ways of invoking the endpoint:
  • With the authenticated primary account's JWT in the Authorization header, which has the update:current_user_identities scope: 
          POST /api/v2/users/PRIMARY_ACCOUNT_USER_ID/identities
      Authorization: "Bearer PRIMARY_ACCOUNT_JWT"
      {
        "link_with": "SECONDARY_ACCOUNT_JWT"
      }
    In this case, only the link_with param is required in the body, which also contains the JWT obtained upon the secondary account's authentication.
  • With a token generated by the API V2 containing the update:users scope: 
        POST /api/v2/users/PRIMARY_ACCOUNT_USER_ID/identities
    Authorization: "Bearer YOUR_API_V2_TOKEN"
    {
      "provider": "SECONDARY_ACCOUNT_PROVIDER",
      "connection_id": "SECONDARY_ACCOUNT_CONNECTION_ID(OPTIONAL)",
      "user_id": "SECONDARY_ACCOUNT_USER_ID"
    }
    In this case you need to send provider and user_id in the body. Optionally you can also send the connection_id param which is suitable for identifying a particular database connection for the 'auth0' provider.
#### 🔌 Usage
```typescript await client.users.identities.link("id"); ```
#### ⚙️ Parameters
**id:** `string` — ID of the primary user account to link a second user account to.
**request:** `Management.LinkUserIdentityRequestContent`
**requestOptions:** `IdentitiesClient.RequestOptions`
client.users.identities.delete(id, provider, user_id) -> Management.DeleteUserIdentityResponseContent
#### 📝 Description
Unlink a specific secondary account from a target user. This action requires the ID of both the target user and the secondary account. Unlinking the secondary account removes it from the identities array of the target user and creates a new standalone profile for the secondary account. To learn more, review Unlink User Accounts.
#### 🔌 Usage
```typescript await client.users.identities.delete("id", "ad", "user_id"); ```
#### ⚙️ Parameters
**id:** `string` — ID of the primary user account.
**provider:** `Management.UserIdentityProviderEnum` — Identity provider name of the secondary linked account (e.g. `google-oauth2`).
**user_id:** `string` — ID of the secondary linked account (e.g. `123456789081523216417` part after the `|` in `google-oauth2|123456789081523216417`).
**requestOptions:** `IdentitiesClient.RequestOptions`
## Users Logs
client.users.logs.list(id, { ...params }) -> core.Page<Management.Log, Management.UserListLogOffsetPaginatedResponseContent>
#### 📝 Description
Retrieve log events for a specific user. Note: For more information on all possible event types, their respective acronyms and descriptions, see Log Event Type Codes. For more information on the list of fields that can be used in `sort`, see Searchable Fields. Auth0 limits the number of logs you can return by search criteria to 100 logs per request. Furthermore, you may only paginate through up to 1,000 search results. If you exceed this threshold, please redefine your search.
#### 🔌 Usage
```typescript const pageableResponse = await client.users.logs.list("id", { page: 1, per_page: 1, sort: "sort", include_totals: true, }); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.users.logs.list("id", { page: 1, per_page: 1, sort: "sort", include_totals: true, }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**id:** `string` — ID of the user of the logs to retrieve
**request:** `Management.ListUserLogsRequestParameters`
**requestOptions:** `LogsClient.RequestOptions`
## Users Multifactor
client.users.multifactor.invalidateRememberBrowser(id) -> void
#### 📝 Description
Invalidate all remembered browsers across all authentication factors for a user.
#### 🔌 Usage
```typescript await client.users.multifactor.invalidateRememberBrowser("id"); ```
#### ⚙️ Parameters
**id:** `string` — ID of the user to invalidate all remembered browsers and authentication factors for.
**requestOptions:** `MultifactorClient.RequestOptions`
client.users.multifactor.deleteProvider(id, provider) -> void
#### 📝 Description
Remove a multifactor authentication configuration from a user's account. This forces the user to manually reconfigure the multi-factor provider.
#### 🔌 Usage
```typescript await client.users.multifactor.deleteProvider("id", "duo"); ```
#### ⚙️ Parameters
**id:** `string` — ID of the user to remove a multifactor configuration from.
**provider:** `Management.UserMultifactorProviderEnum` — The multi-factor provider. Supported values 'duo' or 'google-authenticator'
**requestOptions:** `MultifactorClient.RequestOptions`
## Users Organizations
client.users.organizations.list(id, { ...params }) -> core.Page<Management.Organization, Management.ListUserOrganizationsOffsetPaginatedResponseContent>
#### 📝 Description
Retrieve list of the specified user's current Organization memberships. User must be specified by user ID. For more information, review Auth0 Organizations.
#### 🔌 Usage
```typescript const pageableResponse = await client.users.organizations.list("id", { 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.users.organizations.list("id", { page: 1, per_page: 1, include_totals: true, }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**id:** `string` — ID of the user to retrieve the organizations for.
**request:** `Management.ListUserOrganizationsRequestParameters`
**requestOptions:** `OrganizationsClient.RequestOptions`
## Users Permissions
client.users.permissions.list(id, { ...params }) -> core.Page<Management.UserPermissionSchema, Management.ListUserPermissionsOffsetPaginatedResponseContent>
#### 📝 Description
Retrieve all permissions associated with the user.
#### 🔌 Usage
```typescript const pageableResponse = await client.users.permissions.list("id", { per_page: 1, 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.users.permissions.list("id", { per_page: 1, page: 1, include_totals: true, }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**id:** `string` — ID of the user to retrieve the permissions for.
**request:** `Management.ListUserPermissionsRequestParameters`
**requestOptions:** `PermissionsClient.RequestOptions`
client.users.permissions.create(id, { ...params }) -> void
#### 📝 Description
Assign permissions to a user.
#### 🔌 Usage
```typescript await client.users.permissions.create("id", { permissions: [ { resource_server_identifier: "resource_server_identifier", permission_name: "permission_name", }, ], }); ```
#### ⚙️ Parameters
**id:** `string` — ID of the user to assign permissions to.
**request:** `Management.CreateUserPermissionsRequestContent`
**requestOptions:** `PermissionsClient.RequestOptions`
client.users.permissions.delete(id, { ...params }) -> void
#### 📝 Description
Remove permissions from a user.
#### 🔌 Usage
```typescript await client.users.permissions.delete("id", { permissions: [ { resource_server_identifier: "resource_server_identifier", permission_name: "permission_name", }, ], }); ```
#### ⚙️ Parameters
**id:** `string` — ID of the user to remove permissions from.
**request:** `Management.DeleteUserPermissionsRequestContent`
**requestOptions:** `PermissionsClient.RequestOptions`
## Users RiskAssessments
client.users.riskAssessments.clear(id, { ...params }) -> void
#### 📝 Description
Clear risk assessment assessors for a specific user
#### 🔌 Usage
```typescript await client.users.riskAssessments.clear("id", { connection: "connection", assessors: ["new-device"], }); ```
#### ⚙️ Parameters
**id:** `string` — ID of the user to clear assessors for.
**request:** `Management.ClearAssessorsRequestContent`
**requestOptions:** `RiskAssessmentsClient.RequestOptions`
## Users Roles
client.users.roles.list(id, { ...params }) -> core.Page<Management.Role, Management.ListUserRolesOffsetPaginatedResponseContent>
#### 📝 Description
Retrieve detailed list of all user roles currently assigned to a user. Note: This action retrieves all roles assigned to a user in the context of your whole tenant. To retrieve Organization-specific roles, use the following endpoint: Get user roles assigned to an Organization member.
#### 🔌 Usage
```typescript const pageableResponse = await client.users.roles.list("id", { per_page: 1, 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.users.roles.list("id", { per_page: 1, page: 1, include_totals: true, }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**id:** `string` — ID of the user to list roles for.
**request:** `Management.ListUserRolesRequestParameters`
**requestOptions:** `RolesClient.RequestOptions`
client.users.roles.assign(id, { ...params }) -> void
#### 📝 Description
Assign one or more existing user roles to a user. For more information, review Role-Based Access Control. Note: New roles cannot be created through this action. Additionally, this action is used to assign roles to a user in the context of your whole tenant. To assign roles in the context of a specific Organization, use the following endpoint: Assign user roles to an Organization member.
#### 🔌 Usage
```typescript await client.users.roles.assign("id", { roles: ["roles"], }); ```
#### ⚙️ Parameters
**id:** `string` — ID of the user to associate roles with.
**request:** `Management.AssignUserRolesRequestContent`
**requestOptions:** `RolesClient.RequestOptions`
client.users.roles.delete(id, { ...params }) -> void
#### 📝 Description
Remove one or more specified user roles assigned to a user. Note: This action removes a role from a user in the context of your whole tenant. If you want to unassign a role from a user in the context of a specific Organization, use the following endpoint: Delete user roles from an Organization member.
#### 🔌 Usage
```typescript await client.users.roles.delete("id", { roles: ["roles"], }); ```
#### ⚙️ Parameters
**id:** `string` — ID of the user to remove roles from.
**request:** `Management.DeleteUserRolesRequestContent`
**requestOptions:** `RolesClient.RequestOptions`
## Users RefreshToken
client.users.refreshToken.list(user_id, { ...params }) -> core.Page<Management.RefreshTokenResponseContent, Management.ListRefreshTokensPaginatedResponseContent>
#### 📝 Description
Retrieve details for a user's refresh tokens.
#### 🔌 Usage
```typescript const pageableResponse = await client.users.refreshToken.list("user_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.users.refreshToken.list("user_id", { from: "from", take: 1, }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**user_id:** `string` — ID of the user to get refresh tokens for
**request:** `Management.ListRefreshTokensRequestParameters`
**requestOptions:** `RefreshTokenClient.RequestOptions`
client.users.refreshToken.delete(user_id) -> void
#### 📝 Description
Delete all refresh tokens for a user.
#### 🔌 Usage
```typescript await client.users.refreshToken.delete("user_id"); ```
#### ⚙️ Parameters
**user_id:** `string` — ID of the user to get remove refresh tokens for
**requestOptions:** `RefreshTokenClient.RequestOptions`
## Users Sessions
client.users.sessions.list(user_id, { ...params }) -> core.Page<Management.SessionResponseContent, Management.ListUserSessionsPaginatedResponseContent>
#### 📝 Description
Retrieve details for a user's sessions.
#### 🔌 Usage
```typescript const pageableResponse = await client.users.sessions.list("user_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.users.sessions.list("user_id", { from: "from", take: 1, }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**user_id:** `string` — ID of the user to get sessions for
**request:** `Management.ListUserSessionsRequestParameters`
**requestOptions:** `SessionsClient.RequestOptions`
client.users.sessions.delete(user_id) -> void
#### 📝 Description
Delete all sessions for a user.
#### 🔌 Usage
```typescript await client.users.sessions.delete("user_id"); ```
#### ⚙️ Parameters
**user_id:** `string` — ID of the user to get sessions for
**requestOptions:** `SessionsClient.RequestOptions`
## VerifiableCredentials Verification Templates
client.verifiableCredentials.verification.templates.list({ ...params }) -> core.Page<Management.VerifiableCredentialTemplateResponse, Management.ListVerifiableCredentialTemplatesPaginatedResponseContent>
#### 📝 Description
List a verifiable credential templates.
#### 🔌 Usage
```typescript const pageableResponse = await client.verifiableCredentials.verification.templates.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.verifiableCredentials.verification.templates.list({ from: "from", take: 1, }); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```
#### ⚙️ Parameters
**request:** `Management.ListVerifiableCredentialTemplatesRequestParameters`
**requestOptions:** `TemplatesClient.RequestOptions`
client.verifiableCredentials.verification.templates.create({ ...params }) -> Management.CreateVerifiableCredentialTemplateResponseContent
#### 📝 Description
Create a verifiable credential template.
#### 🔌 Usage
```typescript await client.verifiableCredentials.verification.templates.create({ name: "name", type: "type", dialect: "dialect", presentation: { "org.iso.18013.5.1.mDL": { "org.iso.18013.5.1": {}, }, }, well_known_trusted_issuers: "well_known_trusted_issuers", }); ```
#### ⚙️ Parameters
**request:** `Management.CreateVerifiableCredentialTemplateRequestContent`
**requestOptions:** `TemplatesClient.RequestOptions`
client.verifiableCredentials.verification.templates.get(id) -> Management.GetVerifiableCredentialTemplateResponseContent
#### 📝 Description
Get a verifiable credential template.
#### 🔌 Usage
```typescript await client.verifiableCredentials.verification.templates.get("id"); ```
#### ⚙️ Parameters
**id:** `string` — ID of the template to retrieve.
**requestOptions:** `TemplatesClient.RequestOptions`
client.verifiableCredentials.verification.templates.delete(id) -> void
#### 📝 Description
Delete a verifiable credential template.
#### 🔌 Usage
```typescript await client.verifiableCredentials.verification.templates.delete("id"); ```
#### ⚙️ Parameters
**id:** `string` — ID of the template to retrieve.
**requestOptions:** `TemplatesClient.RequestOptions`
client.verifiableCredentials.verification.templates.update(id, { ...params }) -> Management.UpdateVerifiableCredentialTemplateResponseContent
#### 📝 Description
Update a verifiable credential template.
#### 🔌 Usage
```typescript await client.verifiableCredentials.verification.templates.update("id"); ```
#### ⚙️ Parameters
**id:** `string` — ID of the template to retrieve.
**request:** `Management.UpdateVerifiableCredentialTemplateRequestContent`
**requestOptions:** `TemplatesClient.RequestOptions`