create:clients scope).
+Update: Returns 200 when an existing client is updated (requires update:clients scope).
+
+This endpoint automatically:
+
+from: Optional id from which to start selection.take: The total amount of entries to retrieve when using the from parameter. Defaults to 50.from parameter. If there are more results, a next value is included in the response. You can use this for subsequent API calls. When next is no longer included in the response, no pages are remaining.
+**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.
body.
+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.
+**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.
options parameter, the entire options object is overriden. To avoid partial data or other issues, ensure all parameters are present when using this option.
+**Note**: If you use the `options` parameter, the entire `options` object is overridden. To avoid partial data or other issues, ensure all parameters are present when using this option.
ID. 200 OK http status code response is returned when the connection is online, otherwise a 404 status code is returned along with an error message
+Retrieves the status of an ad/ldap connection referenced by its `ID`. `200 OK` http status code response is returned when the connection is online, otherwise a `404` status code is returned along with an error message
custom_client_ip_header for a domain, the body to
+**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" }tls_policy for a domain, the body to send should be:
-{ "tls_policy": "recommended" }compatible TLS policy is no longer supported.
+- The `compatible` TLS policy is no longer supported.
@@ -3115,12 +3131,12 @@ await client.customDomains.test("id");
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.
+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.
+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.
+[Learn more](https://auth0.com/docs/custom-domains#step-2-verify-ownership) about verifying custom domains that use Auth0 Managed certificates.
+[Learn more](https://auth0.com/docs/custom-domains/self-managed-certificates#step-2-verify-ownership) about verifying custom domains that use Self Managed certificates.
@@ -3185,7 +3201,7 @@ await client.customDomains.verify("id");
public_key, refresh_token, or rotating_refresh_token) associated with a specific user.
+Retrieve device credential information (`public_key`, `refresh_token`, or `rotating_refresh_token`) associated with a specific user.
user_id. Device Credentials APIs are designed for ad-hoc administrative use only and paging is by default enabled for GET requests.
+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.
+When refresh token rotation is enabled, the endpoint becomes consistent. For more information, read [Signing Keys](https://auth0.com/docs/get-started/tenant-settings/signing-keys).
q parameter, or search from a specific log ID ("search from checkpoint").
+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.
+For more information on all possible event types, their respective acronyms, and descriptions, see [Log Event Type Codes](https://auth0.com/docs/logs/log-event-type-codes).
-fields and sort, see Searchable Fields.
+For more information on the list of fields that can be used in `fields` and `sort`, see [Searchable Fields](https://auth0.com/docs/logs/log-search-query-syntax#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.
+Auth0 [limits the number of logs](https://auth0.com/docs/logs/retrieve-log-events-using-mgmt-api#limitations) 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](https://auth0.com/docs/logs/retrieve-log-events-using-mgmt-api#retrieve-logs-by-checkpoint).
-take parameter. If you use from at the same time as q, from takes precedence and q is ignored.from parameter.from and take will be ignored, and date ordering is not guaranteed.
+**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.
@@ -6980,23 +6993,19 @@ Retrieve detailed list of all Organizations available in your tenant. For more i
This endpoint supports two types of pagination:
-from: Optional id from which to start selection.take: The total number of entries to retrieve when using the from parameter. Defaults to 50.from parameter. If there are more results, a next value is included in the response. You can use this for subsequent API calls. When next is no longer included in the response, no pages are remaining.
+**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.
@@ -7079,7 +7088,7 @@ const response = page.response;
client.refreshTokens.list({ ...params }) -> core.Page<Management.RefreshTokenResponseContent, Management.GetRefreshTokensPaginatedResponseContent>client.rateLimitPolicies.list({ ...params }) -> core.Page<Management.RateLimitPolicy, Management.ListRateLimitPoliciesPaginatedResponseContent>client.refreshTokens.revoke({ ...params }) -> voidclient.rateLimitPolicies.create({ ...params }) -> Management.CreateRateLimitPolicyResponseContentclient.refreshTokens.get(id) -> Management.GetRefreshTokenResponseContentclient.rateLimitPolicies.get(id) -> Management.GetRateLimitPolicyResponseContentclient.refreshTokens.delete(id) -> voidclient.rateLimitPolicies.delete(id) -> voidclient.refreshTokens.update(id, { ...params }) -> Management.UpdateRefreshTokenResponseContentclient.rateLimitPolicies.update(id, { ...params }) -> Management.UpdateRateLimitPolicyResponseContentclient.resourceServers.list({ ...params }) -> core.Page<Management.ResourceServer, Management.ListResourceServerOffsetPaginatedResponseContent>client.refreshTokens.list({ ...params }) -> core.Page<Management.RefreshTokenResponseContent, Management.GetRefreshTokensPaginatedResponseContent>client.resourceServers.create({ ...params }) -> Management.CreateResourceServerResponseContentclient.refreshTokens.revoke({ ...params }) -> voidclient.resourceServers.get(id, { ...params }) -> Management.GetResourceServerResponseContentclient.refreshTokens.get(id) -> Management.GetRefreshTokenResponseContentclient.resourceServers.delete(id) -> voidclient.refreshTokens.delete(id) -> voidclient.resourceServers.update(id, { ...params }) -> Management.UpdateResourceServerResponseContentclient.refreshTokens.update(id, { ...params }) -> Management.UpdateRefreshTokenResponseContentclient.roles.list({ ...params }) -> core.Page<Management.Role, Management.ListRolesOffsetPaginatedResponseContent>client.resourceServers.list({ ...params }) -> core.Page<Management.ResourceServer, Management.ListResourceServerOffsetPaginatedResponseContent>client.roles.create({ ...params }) -> Management.CreateRoleResponseContentclient.resourceServers.create({ ...params }) -> Management.CreateResourceServerResponseContentclient.roles.get(id) -> Management.GetRoleResponseContentclient.resourceServers.get(id, { ...params }) -> Management.GetResourceServerResponseContentclient.roles.delete(id) -> voidclient.resourceServers.delete(id) -> voidclient.roles.update(id, { ...params }) -> Management.UpdateRoleResponseContentclient.resourceServers.update(id, { ...params }) -> Management.UpdateResourceServerResponseContentclient.rules.list({ ...params }) -> core.Page<Management.Rule, Management.ListRulesOffsetPaginatedResponseContent>client.roles.list({ ...params }) -> core.Page<Management.Role, Management.ListRolesOffsetPaginatedResponseContent>client.rules.create({ ...params }) -> Management.CreateRuleResponseContentclient.roles.create({ ...params }) -> Management.CreateRoleResponseContentlogin_success can change the rule's function signature to have user omitted.
+**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.
login_success<
-
```typescript
-await client.rules.create({
+await client.roles.create({
name: "name",
- script: "script",
});
```
@@ -8719,7 +8657,7 @@ await client.rules.create({
-
-**request:** `Management.CreateRuleRequestContent`
+**request:** `Management.CreateRoleRequestContent`
@@ -8727,7 +8665,7 @@ await client.rules.create({
-
-**requestOptions:** `RulesClient.RequestOptions`
+**requestOptions:** `RolesClient.RequestOptions`
@@ -8738,7 +8676,7 @@ await client.rules.create({
client.rules.get(id, { ...params }) -> Management.GetRuleResponseContentclient.roles.get(id) -> Management.GetRoleResponseContentclient.rules.delete(id) -> voidclient.roles.delete(id) -> voidclient.rules.update(id, { ...params }) -> Management.UpdateRuleResponseContentclient.roles.update(id, { ...params }) -> Management.UpdateRoleResponseContentclient.rulesConfigs.list() -> Management.RulesConfig[]client.rules.list({ ...params }) -> core.Page<Management.Rule, Management.ListRulesOffsetPaginatedResponseContent>client.rulesConfigs.set(key, { ...params }) -> Management.SetRulesConfigResponseContentclient.rules.create({ ...params }) -> Management.CreateRuleResponseContentclient.rulesConfigs.delete(key) -> voidclient.rules.get(id, { ...params }) -> Management.GetRuleResponseContentclient.selfServiceProfiles.list({ ...params }) -> core.Page<Management.SelfServiceProfile, Management.ListSelfServiceProfilesPaginatedResponseContent>client.rules.delete(id) -> voidclient.selfServiceProfiles.create({ ...params }) -> Management.CreateSelfServiceProfileResponseContentclient.rules.update(id, { ...params }) -> Management.UpdateRuleResponseContentclient.selfServiceProfiles.get(id) -> Management.GetSelfServiceProfileResponseContentclient.rulesConfigs.list() -> Management.RulesConfig[]client.selfServiceProfiles.delete(id) -> voidclient.rulesConfigs.set(key, { ...params }) -> Management.SetRulesConfigResponseContentclient.selfServiceProfiles.update(id, { ...params }) -> Management.UpdateSelfServiceProfileResponseContentclient.rulesConfigs.delete(key) -> voidclient.sessions.get(id) -> Management.GetSessionResponseContentclient.selfServiceProfiles.list({ ...params }) -> core.Page<Management.SelfServiceProfile, Management.ListSelfServiceProfilesPaginatedResponseContent>client.sessions.delete(id) -> voidclient.selfServiceProfiles.create({ ...params }) -> Management.CreateSelfServiceProfileResponseContentclient.sessions.update(id, { ...params }) -> Management.UpdateSessionResponseContentclient.selfServiceProfiles.get(id) -> Management.GetSelfServiceProfileResponseContentclient.sessions.revoke(id) -> voidclient.selfServiceProfiles.delete(id) -> voidclient.stats.getActiveUsersCount() -> Management.GetActiveUsersCountStatsResponseContentclient.selfServiceProfiles.update(id, { ...params }) -> Management.UpdateSelfServiceProfileResponseContentclient.stats.getDaily({ ...params }) -> Management.DailyStats[]client.sessions.get(id) -> Management.GetSessionResponseContentclient.supplementalSignals.get() -> Management.GetSupplementalSignalsResponseContentclient.sessions.delete(id) -> voidclient.supplementalSignals.patch({ ...params }) -> Management.PatchSupplementalSignalsResponseContentclient.sessions.update(id, { ...params }) -> Management.UpdateSessionResponseContentclient.tickets.verifyEmail({ ...params }) -> Management.VerifyEmailTicketResponseContentclient.sessions.revoke(id) -> voidclient.tickets.changePassword({ ...params }) -> Management.ChangePasswordTicketResponseContentclient.stats.getActiveUsersCount() -> Management.GetActiveUsersCountStatsResponseContentclient.tokenExchangeProfiles.list({ ...params }) -> core.Page<Management.TokenExchangeProfileResponseContent, Management.ListTokenExchangeProfileResponseContent>client.stats.getDaily({ ...params }) -> Management.DailyStats[]from: Optional id from which to start selection.take: The total amount of entries to retrieve when using the from parameter. Defaults to 50.from parameter. If there are more results, a next value is included in the response. You can use this for subsequent API calls. When next is no longer included in the response, no pages are remaining.
+Retrieve the number of logins, signups and breached-password detections (subscription required) that occurred each day within a specified date range.
client.tokenExchangeProfiles.create({ ...params }) -> Management.CreateTokenExchangeProfileResponseContentclient.supplementalSignals.get() -> Management.GetSupplementalSignalsResponseContentclient.tokenExchangeProfiles.get(id) -> Management.GetTokenExchangeProfileResponseContentclient.supplementalSignals.patch({ ...params }) -> Management.PatchSupplementalSignalsResponseContentclient.tokenExchangeProfiles.delete(id) -> voidclient.tickets.verifyEmail({ ...params }) -> Management.VerifyEmailTicketResponseContentclient.tokenExchangeProfiles.update(id, { ...params }) -> voidclient.tickets.changePassword({ ...params }) -> Management.ChangePasswordTicketResponseContentclient.userAttributeProfiles.list({ ...params }) -> core.Page<Management.UserAttributeProfile, Management.ListUserAttributeProfilesPaginatedResponseContent>client.tokenExchangeProfiles.list({ ...params }) -> core.Page<Management.TokenExchangeProfileResponseContent, Management.ListTokenExchangeProfileResponseContent>from: Optional id from which to start selection.take: The total amount of entries to retrieve when using the from parameter. Defaults to 50.from parameter. If there are more results, a next value is included in the response. You can use this for subsequent API calls. When next is no longer included in the response, no pages are remaining.
client.userAttributeProfiles.create({ ...params }) -> Management.CreateUserAttributeProfileResponseContentclient.tokenExchangeProfiles.create({ ...params }) -> Management.CreateTokenExchangeProfileResponseContentclient.userAttributeProfiles.listTemplates() -> Management.ListUserAttributeProfileTemplateResponseContentclient.tokenExchangeProfiles.get(id) -> Management.GetTokenExchangeProfileResponseContentclient.userAttributeProfiles.getTemplate(id) -> Management.GetUserAttributeProfileTemplateResponseContentclient.tokenExchangeProfiles.delete(id) -> voidclient.userAttributeProfiles.get(id) -> Management.GetUserAttributeProfileResponseContentclient.tokenExchangeProfiles.update(id, { ...params }) -> voidclient.userAttributeProfiles.delete(id) -> voidclient.userAttributeProfiles.list({ ...params }) -> core.Page<Management.UserAttributeProfile, Management.ListUserAttributeProfilesPaginatedResponseContent>client.userAttributeProfiles.update(id, { ...params }) -> Management.UpdateUserAttributeProfileResponseContentclient.userAttributeProfiles.create({ ...params }) -> Management.CreateUserAttributeProfileResponseContentclient.userBlocks.listByIdentifier({ ...params }) -> Management.ListUserBlocksByIdentifierResponseContentclient.userAttributeProfiles.listTemplates() -> Management.ListUserAttributeProfileTemplateResponseContentclient.userBlocks.deleteByIdentifier({ ...params }) -> voidclient.userAttributeProfiles.getTemplate(id) -> Management.GetUserAttributeProfileTemplateResponseContentclient.userBlocks.list(id, { ...params }) -> Management.ListUserBlocksResponseContentclient.userAttributeProfiles.get(id) -> Management.GetUserAttributeProfileResponseContentclient.userBlocks.delete(id) -> voidclient.userAttributeProfiles.delete(id) -> voidclient.users.list({ ...params }) -> core.Page<Management.UserResponseSchema, Management.ListUsersOffsetPaginatedResponseContent>client.userAttributeProfiles.update(id, { ...params }) -> Management.UpdateUserAttributeProfileResponseContentq 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.
+Update the details of a specific User attribute profile, such as name, user_id and user_attributes.
client.users.create({ ...params }) -> Management.CreateUserResponseContentclient.userBlocks.listByIdentifier({ ...params }) -> Management.ListUserBlocksByIdentifierResponseContentconnection is required but other parameters such as email and password are dependent upon the type of connection.
+Retrieve details of all [Brute-force Protection](https://auth0.com/docs/secure/attack-protection/brute-force-protection) blocks for a user with the given identifier (username, phone number, or email).
connection is required but other parameters such as ema
-
```typescript
-await client.users.create({
- connection: "connection",
+await client.userBlocks.listByIdentifier({
+ identifier: "identifier",
+ consider_brute_force_enablement: true,
});
```
@@ -11398,7 +11308,7 @@ await client.users.create({
-
-**request:** `Management.CreateUserRequestContent`
+**request:** `Management.ListUserBlocksByIdentifierRequestParameters`
@@ -11406,7 +11316,7 @@ await client.users.create({
-
-**requestOptions:** `UsersClient.RequestOptions`
+**requestOptions:** `UserBlocksClient.RequestOptions`
@@ -11417,7 +11327,7 @@ await client.users.create({
client.users.listUsersByEmail({ ...params }) -> Management.UserResponseSchema[]client.userBlocks.deleteByIdentifier({ ...params }) -> voidclient.users.get(id, { ...params }) -> Management.GetUserResponseContentclient.userBlocks.list(id, { ...params }) -> Management.ListUserBlocksResponseContentclient.users.delete(id) -> voidclient.userBlocks.delete(id) -> voidclient.users.update(id, { ...params }) -> Management.UpdateUserResponseContentclient.users.list({ ...params }) -> core.Page<Management.UserResponseSchema, Management.ListUsersOffsetPaginatedResponseContent>user_metadata and app_metadata). These properties are merged instead of being replaced but be careful, the merge only occurs on the first level.email, email_verified, phone_number, phone_verified, username or password of a secondary identity, you need to specify the connection property too.email or phone_number you can specify, optionally, the client_id property.email_verified is not supported for enterprise and passwordless sms connections.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.null as the value.{ "email_verified": true }user_metadata:
-{ "user_metadata" : { "profileCode": 1479 } }addresses the body to send should be:
+- 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
-{ "user_metadata" : { "addresses": {"work_address": "100 Industrial Way"} }}user_metadata property:{
-"user_metadata": {
-"profileCode": 1479,
-"addresses": { "work_address": "100 Industrial Way" }
-}
-}"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"
- }
- }
-}user_metadata property:
+Auth0 limits the number of users you can return. If you exceed this threshold, please redefine your search, use the [export job](https://auth0.com/docs/api/management/v2#!/Jobs/post_users_exports), or the [User Import / Export](https://auth0.com/docs/extensions/user-import-export) extension.
-{
- "user_metadata": {
- "profileCode": 1479,
- "addresses": {
- "work_address": "100 Industrial Way",
- "home_address": "742 Evergreen Terrace"
- }
- }
-}user_metadata proper
client.users.regenerateRecoveryCode(id) -> Management.RegenerateUsersRecoveryCodeResponseContentclient.users.create({ ...params }) -> Management.CreateUserResponseContentclient.users.revokeAccess(id, { ...params }) -> voidclient.users.listUsersByEmail({ ...params }) -> Management.UserResponseSchema[]client.actions.versions.list(actionId, { ...params }) -> core.Page<Management.ActionVersion, Management.ListActionVersionsPaginatedResponseContent>client.users.get(id, { ...params }) -> Management.GetUserResponseContentclient.actions.versions.get(actionId, id) -> Management.GetActionVersionResponseContentclient.users.delete(id) -> voidclient.actions.versions.deploy(actionId, id, { ...params }) -> Management.DeployActionVersionResponseContentclient.users.update(id, { ...params }) -> Management.UpdateUserResponseContentclient.actions.executions.get(id) -> Management.GetActionExecutionResponseContentclient.users.regenerateRecoveryCode(id) -> Management.RegenerateUsersRecoveryCodeResponseContentclient.actions.modules.list({ ...params }) -> core.Page<Management.ActionModuleListItem, Management.GetActionModulesResponseContent>client.users.revokeAccess(id, { ...params }) -> voidclient.actions.modules.create({ ...params }) -> Management.CreateActionModuleResponseContentclient.actions.versions.list(actionId, { ...params }) -> core.Page<Management.ActionVersion, Management.ListActionVersionsPaginatedResponseContent>client.actions.modules.get(id) -> Management.GetActionModuleResponseContentclient.actions.versions.get(actionId, id) -> Management.GetActionVersionResponseContentclient.actions.modules.delete(id) -> voidclient.actions.versions.deploy(actionId, id, { ...params }) -> Management.DeployActionVersionResponseContentclient.actions.modules.update(id, { ...params }) -> Management.UpdateActionModuleResponseContentclient.actions.executions.get(id) -> Management.GetActionExecutionResponseContentclient.actions.modules.listActions(id, { ...params }) -> core.Page<Management.ActionModuleAction, Management.GetActionModuleActionsResponseContent>client.actions.modules.list({ ...params }) -> core.Page<Management.ActionModuleListItem, Management.GetActionModulesResponseContent>client.actions.modules.rollback(id, { ...params }) -> Management.RollbackActionModuleResponseContentclient.actions.modules.create({ ...params }) -> Management.CreateActionModuleResponseContentclient.actions.triggers.list() -> Management.ListActionTriggersResponseContentclient.actions.modules.versions.list(id, { ...params }) -> core.Page<Management.ActionModuleVersion, Management.GetActionModuleVersionsResponseContent>client.actions.modules.get(id) -> Management.GetActionModuleResponseContentclient.actions.modules.versions.create(id) -> Management.CreateActionModuleVersionResponseContentclient.actions.modules.delete(id) -> voidclient.actions.modules.versions.get(id, versionId) -> Management.GetActionModuleVersionResponseContentclient.actions.modules.update(id, { ...params }) -> Management.UpdateActionModuleResponseContentclient.actions.triggers.bindings.list(triggerId, { ...params }) -> core.Page<Management.ActionBinding, Management.ListActionBindingsPaginatedResponseContent>client.actions.modules.listActions(id, { ...params }) -> core.Page<Management.ActionModuleAction, Management.GetActionModuleActionsResponseContent>client.actions.triggers.bindings.updateMany(triggerId, { ...params }) -> Management.UpdateActionBindingsResponseContentclient.actions.modules.rollback(id, { ...params }) -> Management.RollbackActionModuleResponseContentclient.anomaly.blocks.checkIp(id) -> voidclient.actions.triggers.list() -> Management.ListActionTriggersResponseContentclient.anomaly.blocks.unblockIp(id) -> voidclient.actions.modules.versions.list(id, { ...params }) -> core.Page<Management.ActionModuleVersion, Management.GetActionModuleVersionsResponseContent>client.attackProtection.botDetection.get() -> Management.GetBotDetectionSettingsResponseContentclient.actions.modules.versions.create(id) -> Management.CreateActionModuleVersionResponseContentclient.attackProtection.botDetection.update({ ...params }) -> Management.UpdateBotDetectionSettingsResponseContentclient.actions.modules.versions.get(id, versionId) -> Management.GetActionModuleVersionResponseContentclient.attackProtection.breachedPasswordDetection.get() -> Management.GetBreachedPasswordDetectionSettingsResponseContentclient.actions.triggers.bindings.list(triggerId, { ...params }) -> core.Page<Management.ActionBinding, Management.ListActionBindingsPaginatedResponseContent>client.attackProtection.breachedPasswordDetection.update({ ...params }) -> Management.UpdateBreachedPasswordDetectionSettingsResponseContentclient.actions.triggers.bindings.updateMany(triggerId, { ...params }) -> Management.UpdateActionBindingsResponseContentclient.attackProtection.bruteForceProtection.get() -> Management.GetBruteForceSettingsResponseContentclient.anomaly.blocks.checkIp(id) -> voidclient.attackProtection.bruteForceProtection.update({ ...params }) -> Management.UpdateBruteForceSettingsResponseContentclient.anomaly.blocks.unblockIp(id) -> voidclient.attackProtection.captcha.get() -> Management.GetAttackProtectionCaptchaResponseContentclient.attackProtection.botDetection.get() -> Management.GetBotDetectionSettingsResponseContentclient.attackProtection.captcha.update({ ...params }) -> Management.UpdateAttackProtectionCaptchaResponseContentclient.attackProtection.botDetection.update({ ...params }) -> Management.UpdateBotDetectionSettingsResponseContentclient.attackProtection.suspiciousIpThrottling.get() -> Management.GetSuspiciousIpThrottlingSettingsResponseContentclient.attackProtection.breachedPasswordDetection.get() -> Management.GetBreachedPasswordDetectionSettingsResponseContentclient.attackProtection.suspiciousIpThrottling.update({ ...params }) -> Management.UpdateSuspiciousIpThrottlingSettingsResponseContentclient.attackProtection.breachedPasswordDetection.update({ ...params }) -> Management.UpdateBreachedPasswordDetectionSettingsResponseContentclient.attackProtection.bruteForceProtection.get() -> Management.GetBruteForceSettingsResponseContentclient.branding.templates.getUniversalLogin() -> Management.GetUniversalLoginTemplateResponseContentclient.branding.templates.updateUniversalLogin({ ...params }) -> voidclient.attackProtection.bruteForceProtection.update({ ...params }) -> Management.UpdateBruteForceSettingsResponseContentWhen 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>"
-}
-
+Update the Brute-force Protection configuration of your tenant.
-
- 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>
-
client.branding.templates.deleteUniversalLogin() -> voidclient.attackProtection.captcha.get() -> Management.GetAttackProtectionCaptchaResponseContentclient.branding.themes.create({ ...params }) -> Management.CreateBrandingThemeResponseContentclient.attackProtection.captcha.update({ ...params }) -> Management.UpdateAttackProtectionCaptchaResponseContentclient.branding.themes.getDefault() -> Management.GetBrandingDefaultThemeResponseContentclient.attackProtection.suspiciousIpThrottling.get() -> Management.GetSuspiciousIpThrottlingSettingsResponseContentclient.branding.themes.get(themeId) -> Management.GetBrandingThemeResponseContentclient.attackProtection.suspiciousIpThrottling.update({ ...params }) -> Management.UpdateSuspiciousIpThrottlingSettingsResponseContentclient.branding.themes.delete(themeId) -> voidclient.branding.templates.getUniversalLogin() -> Management.GetUniversalLoginTemplateResponseContentclient.branding.templates.updateUniversalLogin({ ...params }) -> voidclient.branding.themes.update(themeId, { ...params }) -> Management.UpdateBrandingThemeResponseContentclient.branding.templates.deleteUniversalLogin() -> voidclient.branding.themes.create({ ...params }) -> Management.CreateBrandingThemeResponseContentclient.branding.phone.providers.list({ ...params }) -> Management.ListBrandingPhoneProvidersResponseContentclient.branding.themes.getDefault() -> Management.GetBrandingDefaultThemeResponseContentclient.branding.themes.get(themeId) -> Management.GetBrandingThemeResponseContentcredentials object requires different properties depending on the phone provider (which is specified using the name property).
+Retrieve branding theme.
credentials object requires different properties depending on t
client.branding.phone.providers.get(id) -> Management.GetBrandingPhoneProviderResponseContentclient.branding.themes.delete(themeId) -> voidclient.branding.phone.providers.delete(id) -> voidclient.branding.themes.update(themeId, { ...params }) -> Management.UpdateBrandingThemeResponseContentclient.branding.phone.providers.update(id, { ...params }) -> Management.UpdateBrandingPhoneProviderResponseContentclient.branding.phone.providers.list({ ...params }) -> Management.ListBrandingPhoneProvidersResponseContentcredentials object requires different properties depending on the phone provider (which is specified using the name property).
+Retrieve a list of phone providers details set for a Tenant. A list of fields to include or exclude may also be specified.
credentials object requires different properties depending on t
client.branding.phone.providers.test(id, { ...params }) -> Management.CreatePhoneProviderSendTestResponseContentclient.branding.phone.providers.create({ ...params }) -> Management.CreateBrandingPhoneProviderResponseContentcredentials object requires different properties depending on the phone provider (which is specified using the name property).
client.branding.phone.providers.get(id) -> Management.GetBrandingPhoneProviderResponseContentclient.branding.phone.templates.list({ ...params }) -> Management.ListPhoneTemplatesResponseContentclient.branding.phone.templates.create({ ...params }) -> Management.CreatePhoneTemplateResponseContentclient.branding.phone.providers.delete(id) -> voidclient.branding.phone.templates.get(id) -> Management.GetPhoneTemplateResponseContentclient.branding.phone.providers.update(id, { ...params }) -> Management.UpdateBrandingPhoneProviderResponseContentcredentials object requires different properties depending on the phone provider (which is specified using the name property).
+
+client.branding.phone.templates.delete(id) -> voidclient.branding.phone.providers.test(id, { ...params }) -> Management.CreatePhoneProviderSendTestResponseContentclient.branding.phone.templates.list({ ...params }) -> Management.ListPhoneTemplatesResponseContentclient.branding.phone.templates.create({ ...params }) -> Management.CreatePhoneTemplateResponseContentclient.branding.phone.templates.get(id) -> Management.GetPhoneTemplateResponseContentclient.branding.phone.templates.delete(id) -> voidconnectionId.
+Retrieves a scim configuration by its `connectionId`.
connectionId.
+Deletes a scim configuration by its `connectionId`.
connectionId.
+Update a scim configuration by its `connectionId`.
connectionId.
+Retrieves a scim configuration's default mapping by its `connectionId`.
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.
+**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.
id.
+Retrieves all scim tokens by its connection `id`.
id and tokenId.
+Deletes a scim token by its connection `id` and `tokenId`.
client.guardian.enrollments.createTicket({ ...params }) -> Management.CreateGuardianEnrollmentTicketResponseContentclient.groups.roles.list(id, { ...params }) -> core.Page<Management.Role, Management.ListGroupRolesResponseContent>client.guardian.enrollments.get(id) -> Management.GetGuardianEnrollmentResponseContentclient.groups.roles.create(id, { ...params }) -> voidclient.groups.roles.delete(id, { ...params }) -> voidclient.guardian.enrollments.createTicket({ ...params }) -> Management.CreateGuardianEnrollmentTicketResponseContentclient.guardian.enrollments.get(id) -> Management.GetGuardianEnrollmentResponseContentall-applications policy prompts with MFA for all logins.confidence-score policy prompts with MFA only for low confidence logins.confidence-score policy is part of the Adaptive MFA feature. Adaptive MFA requires an add-on for the Enterprise plan; review Auth0 Pricing for more details.
+**Note**: The `confidence-score` policy is part of the [Adaptive MFA feature](https://auth0.com/docs/secure/multi-factor-authentication/adaptive-mfa). Adaptive MFA requires an add-on for the Enterprise plan; review [Auth0 Pricing](https://auth0.com/pricing) for more details.
all-applications policy prompts with MFA for all logins.confidence-score policy prompts with MFA only for low confidence logins.confidence-score policy is part of the Adaptive MFA feature. Adaptive MFA requires an add-on for the Enterprise plan; review Auth0 Pricing for more details.
+**Note**: The `confidence-score` policy is part of the [Adaptive MFA feature](https://auth0.com/docs/secure/multi-factor-authentication/adaptive-mfa). Adaptive MFA requires an add-on for the Enterprise plan; review [Auth0 Pricing](https://auth0.com/pricing) for more details.
client.organizations.clientGrants.create(id, { ...params }) -> Management.AssociateOrganizationClientGrantResponseContentclient.organizations.clientGrants.delete(id, grant_id) -> voidclient.organizations.connections.list(id, { ...params }) -> core.Page<Management.OrganizationAllConnectionPost, Management.ListOrganizationAllConnectionsOffsetPaginatedResponseContent>client.organizations.connections.create(id, { ...params }) -> Management.CreateOrganizationAllConnectionResponseContentclient.organizations.connections.get(id, connection_id) -> Management.GetOrganizationAllConnectionResponseContentclient.organizations.clientGrants.create(id, { ...params }) -> Management.AssociateOrganizationClientGrantResponseContentclient.organizations.connections.delete(id, connection_id) -> voidclient.organizations.clientGrants.delete(id, grant_id) -> voidclient.organizations.connections.update(id, connection_id, { ...params }) -> Management.UpdateOrganizationAllConnectionResponseContentclient.organizations.discoveryDomains.list(id, { ...params }) -> core.Page<Management.OrganizationDiscoveryDomain, Management.ListOrganizationDiscoveryDomainsResponseContent>client.organizations.connections.list(id, { ...params }) -> core.Page<Management.OrganizationAllConnectionPost, Management.ListOrganizationAllConnectionsOffsetPaginatedResponseContent>client.organizations.connections.create(id, { ...params }) -> Management.CreateOrganizationAllConnectionResponseContentclient.organizations.discoveryDomains.create(id, { ...params }) -> Management.CreateOrganizationDiscoveryDomainResponseContentclient.organizations.connections.get(id, connection_id) -> Management.GetOrganizationAllConnectionResponseContentclient.organizations.discoveryDomains.getByName(id, discovery_domain) -> Management.GetOrganizationDiscoveryDomainByNameResponseContentclient.organizations.connections.delete(id, connection_id) -> voidclient.organizations.discoveryDomains.get(id, discovery_domain_id) -> Management.GetOrganizationDiscoveryDomainResponseContentclient.organizations.connections.update(id, connection_id, { ...params }) -> Management.UpdateOrganizationAllConnectionResponseContentclient.organizations.discoveryDomains.delete(id, discovery_domain_id) -> voidclient.organizations.discoveryDomains.list(id, { ...params }) -> core.Page<Management.OrganizationDiscoveryDomain, Management.ListOrganizationDiscoveryDomainsResponseContent>client.organizations.discoveryDomains.update(id, discovery_domain_id, { ...params }) -> Management.UpdateOrganizationDiscoveryDomainResponseContentclient.organizations.discoveryDomains.create(id, { ...params }) -> Management.CreateOrganizationDiscoveryDomainResponseContentclient.organizations.enabledConnections.list(id, { ...params }) -> core.Page<Management.OrganizationConnection, Management.ListOrganizationConnectionsOffsetPaginatedResponseContent>client.organizations.discoveryDomains.getByName(id, discovery_domain) -> Management.GetOrganizationDiscoveryDomainByNameResponseContentclient.organizations.enabledConnections.add(id, { ...params }) -> Management.AddOrganizationConnectionResponseContentclient.organizations.discoveryDomains.get(id, discovery_domain_id) -> Management.GetOrganizationDiscoveryDomainResponseContentclient.organizations.enabledConnections.get(id, connectionId) -> Management.GetOrganizationConnectionResponseContentclient.organizations.discoveryDomains.delete(id, discovery_domain_id) -> voidclient.organizations.enabledConnections.delete(id, connectionId) -> voidclient.organizations.discoveryDomains.update(id, discovery_domain_id, { ...params }) -> Management.UpdateOrganizationDiscoveryDomainResponseContentclient.organizations.enabledConnections.update(id, connectionId, { ...params }) -> Management.UpdateOrganizationConnectionResponseContentstatus field must be either pending or verified. The use_for_organization_discovery field can be true or false (default: true).
+Modify the details of a specific connection currently enabled for an Organization.
client.organizations.enabledConnections.list(id, { ...params }) -> core.Page<Management.OrganizationConnection, Management.ListOrganizationConnectionsOffsetPaginatedResponseContent>client.organizations.invitations.list(id, { ...params }) -> core.Page<Management.OrganizationInvitation, Management.ListOrganizationInvitationsOffsetPaginatedResponseContent>client.organizations.enabledConnections.add(id, { ...params }) -> Management.AddOrganizationConnectionResponseContentclient.organizations.invitations.create(id, { ...params }) -> Management.CreateOrganizationInvitationResponseContentclient.organizations.enabledConnections.get(id, connectionId) -> Management.GetOrganizationConnectionResponseContentclient.organizations.invitations.get(id, invitation_id, { ...params }) -> Management.GetOrganizationInvitationResponseContentclient.organizations.invitations.delete(id, invitation_id) -> voidclient.organizations.enabledConnections.delete(id, connectionId) -> voidclient.organizations.members.list(id, { ...params }) -> core.Page<Management.OrganizationMember, Management.ListOrganizationMembersPaginatedResponseContent>client.organizations.enabledConnections.update(id, connectionId, { ...params }) -> Management.UpdateOrganizationConnectionResponseContentclient.organizations.members.create(id, { ...params }) -> voidclient.organizations.members.delete(id, { ...params }) -> voidclient.organizations.invitations.list(id, { ...params }) -> core.Page<Management.OrganizationInvitation, Management.ListOrganizationInvitationsOffsetPaginatedResponseContent>client.organizations.groups.list(organization_id, { ...params }) -> core.Page<Management.Group, Management.ListOrganizationGroupsResponseContent>client.organizations.invitations.create(id, { ...params }) -> Management.CreateOrganizationInvitationResponseContentclient.organizations.groups.roles.list(organization_id, group_id, { ...params }) -> core.Page<Management.Role, Management.ListOrganizationGroupRolesResponseContent>client.organizations.invitations.get(id, invitation_id, { ...params }) -> Management.GetOrganizationInvitationResponseContentclient.organizations.groups.roles.create(organization_id, group_id, { ...params }) -> voidclient.organizations.invitations.delete(id, invitation_id) -> voidclient.organizations.groups.roles.delete(organization_id, group_id, { ...params }) -> voidclient.organizations.members.list(id, { ...params }) -> core.Page<Management.OrganizationMember, Management.ListOrganizationMembersPaginatedResponseContent>client.organizations.members.effectiveRoles.list(id, user_id, { ...params }) -> core.Page<Management.OrganizationMemberEffectiveRole, Management.ListOrganizationMemberEffectiveRolesResponseContent>fields parameter to optionally define the specific member details retrieved. If fields is left blank, all fields (except roles) are returned.
- fields=roles to retrieve the roles assigned to each listed member. To use this parameter, you must include the read:organization_member_roles scope in the token.
- from parameter. If there are more results, a next value will be included in the response. You can use this for subsequent API calls. When next is no longer included in the response, this indicates there are no more pages remaining.
+Lists the roles assigned to an organization member directly or through group membership.
client.organizations.members.create(id, { ...params }) -> voidclient.organizations.members.roles.list(id, user_id, { ...params }) -> core.Page<Management.Role, Management.ListOrganizationMemberRolesOffsetPaginatedResponseContent>client.organizations.members.delete(id, { ...params }) -> voidclient.organizations.members.roles.list(id, user_id, { ...params }) -> core.Page<Management.Role, Management.ListOrganizationMemberRolesOffsetPaginatedResponseContent>client.organizations.members.roles.assign(id, user_id, { ...params }) -> voidclient.organizations.members.roles.assign(id, user_id, { ...params }) -> voidclient.organizations.members.roles.delete(id, user_id, { ...params }) -> voidclient.organizations.members.roles.delete(id, user_id, { ...params }) -> voidclient.organizations.members.effectiveRoles.sources.groups.list(id, user_id, { ...params }) -> core.Page<Management.Group, Management.ListOrganizationMemberRoleSourceGroupsResponseContent>client.riskAssessments.settings.get() -> Management.GetRiskAssessmentsSettingsResponseContentclient.riskAssessments.settings.update({ ...params }) -> Management.UpdateRiskAssessmentsSettingsResponseContentclient.riskAssessments.settings.newDevice.get() -> Management.GetRiskAssessmentsSettingsNewDeviceResponseContentclient.riskAssessments.settings.get() -> Management.GetRiskAssessmentsSettingsResponseContentclient.riskAssessments.settings.newDevice.update({ ...params }) -> Management.UpdateRiskAssessmentsSettingsNewDeviceResponseContentclient.riskAssessments.settings.update({ ...params }) -> Management.UpdateRiskAssessmentsSettingsResponseContentclient.roles.groups.get(id, { ...params }) -> core.Page<Management.Group, Management.ListRoleGroupsResponseContent>client.riskAssessments.settings.newDevice.get() -> Management.GetRiskAssessmentsSettingsNewDeviceResponseContentclient.roles.groups.create(id, { ...params }) -> voidclient.riskAssessments.settings.newDevice.update({ ...params }) -> Management.UpdateRiskAssessmentsSettingsNewDeviceResponseContentclient.roles.groups.delete(id, { ...params }) -> voidfrom: Optional id from which to start selection.take: The total amount of entries to retrieve when using the from parameter. Defaults to 50.from parameter. If there are more results, a next value is included in the response. You can use this for subsequent API calls. When next is no longer included in the response, no pages are remaining.
+**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.
client.users.authenticators.deleteAll(id) -> voidclient.users.connectedAccounts.list(id, { ...params }) -> core.Page<Management.ConnectedAccount, Management.ListUserConnectedAccountsResponseContent>client.users.authenticators.deleteAll(id) -> voidclient.users.effectivePermissions.list(id, { ...params }) -> core.Page<Management.UserEffectivePermissionResponseContent, Management.ListUserEffectivePermissionsResponseContent>client.users.connectedAccounts.list(id, { ...params }) -> core.Page<Management.ConnectedAccount, Management.ListUserConnectedAccountsResponseContent>client.users.effectiveRoles.list(id, { ...params }) -> core.Page<Management.UserEffectiveRole, Management.ListUserEffectiveRolesResponseContent>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.
- update:users scope:
-
+- With the authenticated primary account's JWT in the Authorization header, which has the `update:current_user_identities` scope:
+
+ ```http
+ 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:
+
+ ```http
POST /api/v2/users/PRIMARY_ACCOUNT_USER_ID/identities
Authorization: "Bearer YOUR_API_V2_TOKEN"
{
@@ -27237,14 +28746,13 @@ Note: There are two ways of invoking the endpoint:
"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.
- client.users.effectivePermissions.sources.roles.list(id, { ...params }) -> core.Page<Management.UserEffectivePermissionRoleSourceResponseContent, Management.ListUserEffectivePermissionRoleSourcesResponseContent>client.users.effectiveRoles.sources.groups.list(id, { ...params }) -> core.Page<Management.Group, Management.ListUserRoleSourceGroupsResponseContent>client.verifiableCredentials.verification.templates.list({ ...params }) -> core.Page<Management.VerifiableCredentialTemplateResponse, Management.ListVerifiableCredentialTemplatesPaginatedResponseContent>When content-type header is set to application/json:
+ * When `content-type` header is set to `application/json`:
+ *
+ * ```json
* {
- * "template": "<!DOCTYPE html>{% assign resolved_dir = dir | default: "auto" %}<html lang="{{locale}}" dir="{{resolved_dir}}"><head>{%- auth0:head -%}</head><body class="_widget-auto-layout">{%- auth0:widget -%}</body></html>"
+ * "template": "{% assign resolved_dir = dir | default: \"auto\" %}{%- auth0:head -%}{%- auth0:widget -%}"
* }
- *
+ * ```
+ *
+ * When `content-type` header is set to `text/html`:
*
- *
- * When content-type header is set to text/html:
- *
- * <!DOCTYPE html>
+ * ```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>
- *
+ *
+ *
+ * ```
*
* @param {Management.UpdateUniversalLoginTemplateRequestContent} request
* @param {TemplatesClient.RequestOptions} requestOptions - Request-specific configuration.
diff --git a/src/management/api/resources/clients/client/Client.ts b/src/management/api/resources/clients/client/Client.ts
index 9d9583822e..7f7d521e24 100644
--- a/src/management/api/resources/clients/client/Client.ts
+++ b/src/management/api/resources/clients/client/Client.ts
@@ -385,10 +385,19 @@ export class ClientsClient {
}
/**
+ * Idempotent registration for Client ID Metadata Document (CIMD) clients.
+ * Uses external_client_id as the unique identifier for upsert operations.
*
- * 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 \
+ * Create: Returns 201 when a new client is created (requires create:clients scope).
+ * Update: Returns 200 when an existing client is updated (requires update:clients scope).
+ *
+ * This endpoint automatically:
+ * from: Optional id from which to start selection.take: The total amount of entries to retrieve when using the from parameter. Defaults to 50.from parameter. If there are more results, a next value is included in the response. You can use this for subsequent API calls. When next is no longer included in the response, no pages are remaining.
+ * - `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.
*
* @param {Management.ListConnectionsQueryParameters} request
* @param {ConnectionsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -191,9 +189,9 @@ export class ConnectionsClient {
}
/**
- * Creates a new connection according to the JSON object received in body.
+ * 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.
+ * **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.
*
* @param {Management.CreateConnectionRequestContent} request
* @param {ConnectionsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -278,7 +276,7 @@ export class ConnectionsClient {
}
/**
- * Retrieve details for a specified connection along with options that can be used for identity provider configuration.
+ * Retrieve details for a specified [connection](https://auth0.com/docs/authenticate/identity-providers) along with options that can be used for identity provider configuration.
*
* @param {string} id - The id of the connection to retrieve
* @param {Management.GetConnectionRequestParameters} request
@@ -372,9 +370,9 @@ export class ConnectionsClient {
}
/**
- * Removes a specific connection from your tenant. This action cannot be undone. Once removed, users can no longer use this connection to authenticate.
+ * Removes a specific [connection](https://auth0.com/docs/authenticate/identity-providers) 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.
+ * **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](https://auth0.com/docs/api/management/v2/connections/post-connections) requests, if they use an identical connection name.
*
* @param {string} id - The id of the connection to delete
* @param {ConnectionsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -444,9 +442,9 @@ export class ConnectionsClient {
}
/**
- * Update details for a specific connection, including option properties for identity provider configuration.
+ * Update details for a specific [connection](https://auth0.com/docs/authenticate/identity-providers), 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.
+ * **Note**: If you use the `options` parameter, the entire `options` object is overridden. To avoid partial data or other issues, ensure all parameters are present when using this option.
*
* @param {string} id - The id of the connection to update
* @param {Management.UpdateConnectionRequestContent} request
@@ -534,7 +532,7 @@ export class ConnectionsClient {
}
/**
- * Retrieves the status of an ad/ldap connection referenced by its ID. 200 OK http status code response is returned when the connection is online, otherwise a 404 status code is returned along with an error message
+ * Retrieves the status of an ad/ldap connection referenced by its `ID`. `200 OK` http status code response is returned when the connection is online, otherwise a `404` status code is returned along with an error message
*
* @param {string} id - ID of the connection to check
* @param {ConnectionsClient.RequestOptions} requestOptions - Request-specific configuration.
diff --git a/src/management/api/resources/connections/resources/clients/client/Client.ts b/src/management/api/resources/connections/resources/clients/client/Client.ts
index 22eba4c29a..322dce0a5b 100644
--- a/src/management/api/resources/connections/resources/clients/client/Client.ts
+++ b/src/management/api/resources/connections/resources/clients/client/Client.ts
@@ -23,9 +23,9 @@ export class ClientsClient {
}
/**
- * Retrieve all clients that have the specified connection enabled.
+ * Retrieve all clients that have the specified [connection](https://auth0.com/docs/authenticate/identity-providers) 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.
+ * **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.
*
* @param {string} id - The id of the connection for which enabled clients are to be retrieved
* @param {Management.GetConnectionEnabledClientsRequestParameters} request
diff --git a/src/management/api/resources/connections/resources/scimConfiguration/client/Client.ts b/src/management/api/resources/connections/resources/scimConfiguration/client/Client.ts
index 001d6da517..4319e0ffe0 100644
--- a/src/management/api/resources/connections/resources/scimConfiguration/client/Client.ts
+++ b/src/management/api/resources/connections/resources/scimConfiguration/client/Client.ts
@@ -139,7 +139,7 @@ export class ScimConfigurationClient {
}
/**
- * Retrieves a scim configuration by its connectionId.
+ * Retrieves a scim configuration by its `connectionId`.
*
* @param {string} id - The id of the connection to retrieve its SCIM configuration
* @param {ScimConfigurationClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -295,7 +295,7 @@ export class ScimConfigurationClient {
}
/**
- * Deletes a scim configuration by its connectionId.
+ * Deletes a scim configuration by its `connectionId`.
*
* @param {string} id - The id of the connection to delete its SCIM configuration
* @param {ScimConfigurationClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -364,7 +364,7 @@ export class ScimConfigurationClient {
}
/**
- * Update a scim configuration by its connectionId.
+ * Update a scim configuration by its `connectionId`.
*
* @param {string} id - The id of the connection to update its SCIM configuration
* @param {Management.UpdateScimConfigurationRequestContent} request
@@ -448,7 +448,7 @@ export class ScimConfigurationClient {
}
/**
- * Retrieves a scim configuration's default mapping by its connectionId.
+ * Retrieves a scim configuration's default mapping by its `connectionId`.
*
* @param {string} id - The id of the connection to retrieve its default SCIM mapping
* @param {ScimConfigurationClient.RequestOptions} requestOptions - Request-specific configuration.
diff --git a/src/management/api/resources/connections/resources/scimConfiguration/resources/tokens/client/Client.ts b/src/management/api/resources/connections/resources/scimConfiguration/resources/tokens/client/Client.ts
index 89bf853f5b..33f1032b0b 100644
--- a/src/management/api/resources/connections/resources/scimConfiguration/resources/tokens/client/Client.ts
+++ b/src/management/api/resources/connections/resources/scimConfiguration/resources/tokens/client/Client.ts
@@ -26,7 +26,7 @@ export class TokensClient {
}
/**
- * Retrieves all scim tokens by its connection id.
+ * Retrieves all scim tokens by its connection `id`.
*
* @param {string} id - The id of the connection to retrieve its SCIM configuration
* @param {TokensClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -185,7 +185,7 @@ export class TokensClient {
}
/**
- * Deletes a scim token by its connection id and tokenId.
+ * Deletes a scim token by its connection `id` and `tokenId`.
*
* @param {string} id - The connection id that owns the SCIM token to delete
* @param {string} tokenId - The id of the scim token to delete
diff --git a/src/management/api/resources/customDomains/client/Client.ts b/src/management/api/resources/customDomains/client/Client.ts
index 7cb1f957fa..bae72fb255 100644
--- a/src/management/api/resources/customDomains/client/Client.ts
+++ b/src/management/api/resources/customDomains/client/Client.ts
@@ -23,7 +23,7 @@ export class CustomDomainsClient {
}
/**
- * Retrieve details on custom domains.
+ * Retrieve details on [custom domains](https://auth0.com/docs/custom-domains).
*
* @param {Management.ListCustomDomainsRequestParameters} request
* @param {CustomDomainsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -122,7 +122,6 @@ export class CustomDomainsClient {
* - custom_client_ip_header
* - tls_policy
*
- *
* TLS Policies:
*
* - recommended - for modern usage this includes TLS 1.2 only
@@ -511,23 +510,31 @@ export class CustomDomainsClient {
* - custom_client_ip_header
* - tls_policy
*
- * custom_client_ip_header for a domain, the body to
+ * **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" }tls_policy for a domain, the body to send should be:
- * { "tls_policy": "recommended" }compatible TLS policy is no longer supported.
+ * - The `compatible` TLS policy is no longer supported.
*
* @param {string} id - The id of the custom domain to update
* @param {Management.UpdateCustomDomainRequestContent} request
@@ -690,12 +697,12 @@ export class CustomDomainsClient {
/**
* 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.
+ * 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.
+ * 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.
+ * [Learn more](https://auth0.com/docs/custom-domains#step-2-verify-ownership) about verifying custom domains that use Auth0 Managed certificates.
+ * [Learn more](https://auth0.com/docs/custom-domains/self-managed-certificates#step-2-verify-ownership) about verifying custom domains that use Self Managed certificates.
*
* @param {string} id - ID of the custom domain to verify.
* @param {CustomDomainsClient.RequestOptions} requestOptions - Request-specific configuration.
diff --git a/src/management/api/resources/deviceCredentials/client/Client.ts b/src/management/api/resources/deviceCredentials/client/Client.ts
index 9b231c7e9d..4bf55e07f2 100644
--- a/src/management/api/resources/deviceCredentials/client/Client.ts
+++ b/src/management/api/resources/deviceCredentials/client/Client.ts
@@ -23,7 +23,7 @@ export class DeviceCredentialsClient {
}
/**
- * Retrieve device credential information (public_key, refresh_token, or rotating_refresh_token) associated with a specific user.
+ * Retrieve device credential information (`public_key`, `refresh_token`, or `rotating_refresh_token`) associated with a specific user.
*
* @param {Management.ListDeviceCredentialsRequestParameters} request
* @param {DeviceCredentialsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -154,9 +154,9 @@ export class DeviceCredentialsClient {
}
/**
- * 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.
+ * 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.
+ * When refresh token rotation is enabled, the endpoint becomes consistent. For more information, read [Signing Keys](https://auth0.com/docs/get-started/tenant-settings/signing-keys).
*
* @param {Management.CreatePublicKeyDeviceCredentialRequestContent} request
* @param {DeviceCredentialsClient.RequestOptions} requestOptions - Request-specific configuration.
diff --git a/src/management/api/resources/groups/client/Client.ts b/src/management/api/resources/groups/client/Client.ts
index a82d823426..acc5b377fc 100644
--- a/src/management/api/resources/groups/client/Client.ts
+++ b/src/management/api/resources/groups/client/Client.ts
@@ -9,6 +9,7 @@ import { handleNonStatusCodeError } from "../../../../errors/handleNonStatusCode
import * as errors from "../../../../errors/index.js";
import * as Management from "../../../index.js";
import { MembersClient } from "../resources/members/client/Client.js";
+import { RolesClient } from "../resources/roles/client/Client.js";
export declare namespace GroupsClient {
export type Options = BaseClientOptions;
@@ -19,6 +20,7 @@ export declare namespace GroupsClient {
export class GroupsClient {
protected readonly _options: NormalizedClientOptionsWithAuthall-applications policy prompts with MFA for all logins.confidence-score policy prompts with MFA only for low confidence logins.confidence-score policy is part of the Adaptive MFA feature. Adaptive MFA requires an add-on for the Enterprise plan; review Auth0 Pricing for more details.
+ * - `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](https://auth0.com/docs/secure/multi-factor-authentication/adaptive-mfa). Adaptive MFA requires an add-on for the Enterprise plan; review [Auth0 Pricing](https://auth0.com/pricing) for more details.
*
* @param {PoliciesClient.RequestOptions} requestOptions - Request-specific configuration.
*
@@ -101,15 +100,14 @@ export class PoliciesClient {
}
/**
- * Set multi-factor authentication (MFA) policies for your tenant.
+ * Set [multi-factor authentication (MFA) policies](https://auth0.com/docs/secure/multi-factor-authentication/enable-mfa) 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.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.
+ * - `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](https://auth0.com/docs/secure/multi-factor-authentication/adaptive-mfa). Adaptive MFA requires an add-on for the Enterprise plan; review [Auth0 Pricing](https://auth0.com/pricing) for more details.
*
* @param {Management.SetGuardianPoliciesRequestContent} request
* @param {PoliciesClient.RequestOptions} requestOptions - Request-specific configuration.
diff --git a/src/management/api/resources/hooks/client/Client.ts b/src/management/api/resources/hooks/client/Client.ts
index 8245183f3c..20a9d96d7d 100644
--- a/src/management/api/resources/hooks/client/Client.ts
+++ b/src/management/api/resources/hooks/client/Client.ts
@@ -29,7 +29,7 @@ export class HooksClient {
}
/**
- * Retrieve all hooks. Accepts a list of fields to include or exclude in the result.
+ * Retrieve all [hooks](https://auth0.com/docs/hooks). Accepts a list of fields to include or exclude in the result.
*
* @param {Management.ListHooksRequestParameters} request
* @param {HooksClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -236,7 +236,7 @@ export class HooksClient {
}
/**
- * Retrieve a hook by its ID. Accepts a list of fields to include in the result.
+ * Retrieve [a hook](https://auth0.com/docs/hooks) by its ID. Accepts a list of fields to include in the result.
*
* @param {string} id - ID of the hook to retrieve.
* @param {Management.GetHookRequestParameters} request
diff --git a/src/management/api/resources/index.ts b/src/management/api/resources/index.ts
index 49c914cf74..069d447bbd 100644
--- a/src/management/api/resources/index.ts
+++ b/src/management/api/resources/index.ts
@@ -25,6 +25,7 @@ export * as logStreams from "./logStreams/index.js";
export * as networkAcls from "./networkAcls/index.js";
export * as organizations from "./organizations/index.js";
export * as prompts from "./prompts/index.js";
+export * as rateLimitPolicies from "./rateLimitPolicies/index.js";
export * as refreshTokens from "./refreshTokens/index.js";
export * as resourceServers from "./resourceServers/index.js";
export * as riskAssessments from "./riskAssessments/index.js";
diff --git a/src/management/api/resources/jobs/resources/verificationEmail/client/Client.ts b/src/management/api/resources/jobs/resources/verificationEmail/client/Client.ts
index 044eee41d8..c6393010ca 100644
--- a/src/management/api/resources/jobs/resources/verificationEmail/client/Client.ts
+++ b/src/management/api/resources/jobs/resources/verificationEmail/client/Client.ts
@@ -23,7 +23,7 @@ export class VerificationEmailClient {
}
/**
- * Send an email to the specified user that asks them to click a link to verify their email address.
+ * Send an email to the specified user that asks them to click a link to [verify their email address](https://auth0.com/docs/email/custom#verification-email).
*
* Note: You must have the `Status` toggle enabled for the verification email template for the email to be sent.
*
diff --git a/src/management/api/resources/logs/client/Client.ts b/src/management/api/resources/logs/client/Client.ts
index 5be328c6f4..9bb564623f 100644
--- a/src/management/api/resources/logs/client/Client.ts
+++ b/src/management/api/resources/logs/client/Client.ts
@@ -25,33 +25,30 @@ export class LogsClient {
/**
* 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").
+ * 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.
+ * For more information on all possible event types, their respective acronyms, and descriptions, see [Log Event Type Codes](https://auth0.com/docs/logs/log-event-type-codes).
*
- * fields and sort, see Searchable Fields.
+ * For more information on the list of fields that can be used in `fields` and `sort`, see [Searchable Fields](https://auth0.com/docs/logs/log-search-query-syntax#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.
+ * Auth0 [limits the number of logs](https://auth0.com/docs/logs/retrieve-log-events-using-mgmt-api#limitations) 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](https://auth0.com/docs/logs/retrieve-log-events-using-mgmt-api#retrieve-logs-by-checkpoint).
*
- * take parameter. If you use from at the same time as q, from takes precedence and q is ignored.from parameter.from and take will be ignored, and date ordering is not guaranteed.
+ * - **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.
*
* @param {Management.ListLogsRequestParameters} request
* @param {LogsClient.RequestOptions} requestOptions - Request-specific configuration.
diff --git a/src/management/api/resources/organizations/client/Client.ts b/src/management/api/resources/organizations/client/Client.ts
index b174b63cc7..beb785c0ce 100644
--- a/src/management/api/resources/organizations/client/Client.ts
+++ b/src/management/api/resources/organizations/client/Client.ts
@@ -12,6 +12,7 @@ import { ClientGrantsClient } from "../resources/clientGrants/client/Client.js";
import { ConnectionsClient } from "../resources/connections/client/Client.js";
import { DiscoveryDomainsClient } from "../resources/discoveryDomains/client/Client.js";
import { EnabledConnectionsClient } from "../resources/enabledConnections/client/Client.js";
+import { GroupsClient } from "../resources/groups/client/Client.js";
import { InvitationsClient } from "../resources/invitations/client/Client.js";
import { MembersClient } from "../resources/members/client/Client.js";
@@ -29,6 +30,7 @@ export class OrganizationsClient {
protected _enabledConnections: EnabledConnectionsClient | undefined;
protected _invitations: InvitationsClient | undefined;
protected _members: MembersClient | undefined;
+ protected _groups: GroupsClient | undefined;
constructor(options: OrganizationsClient.Options) {
this._options = normalizeClientOptionsWithAuth(options);
@@ -58,26 +60,28 @@ export class OrganizationsClient {
return (this._members ??= new MembersClient(this._options));
}
+ public get groups(): GroupsClient {
+ return (this._groups ??= new GroupsClient(this._options));
+ }
+
/**
* Retrieve detailed list of all Organizations available in your tenant. For more information, see Auth0 Organizations.
*
* This endpoint supports two types of pagination:
- * from: Optional id from which to start selection.take: The total number of entries to retrieve when using the from parameter. Defaults to 50.from parameter. If there are more results, a next value is included in the response. You can use this for subsequent API calls. When next is no longer included in the response, no pages are remaining.
+ * - `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.
*
* @param {Management.ListOrganizationsRequestParameters} request
* @param {OrganizationsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -184,7 +188,7 @@ export class OrganizationsClient {
}
/**
- * Create a new Organization within your tenant. To learn more about Organization settings, behavior, and configuration options, review Create Your First Organization.
+ * Create a new Organization within your tenant. To learn more about Organization settings, behavior, and configuration options, review [Create Your First Organization](https://auth0.com/docs/manage-users/organizations/create-first-organization).
*
* @param {Management.CreateOrganizationRequestContent} request
* @param {OrganizationsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -422,7 +426,7 @@ export class OrganizationsClient {
/**
* 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.
+ * **Note**: Members are automatically disassociated from an Organization when it is deleted. However, this action does **not** delete these users from your tenant.
*
* @param {string} id - Organization identifier.
* @param {OrganizationsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -495,7 +499,7 @@ export class OrganizationsClient {
}
/**
- * Update the details of a specific Organization, such as name and display name, branding options, and metadata.
+ * Update the details of a specific [Organization](https://auth0.com/docs/manage-users/organizations/configure-organizations/create-organizations), such as name and display name, branding options, and metadata.
*
* @param {string} id - ID of the organization to update.
* @param {Management.UpdateOrganizationRequestContent} request
diff --git a/src/management/api/resources/organizations/resources/discoveryDomains/client/Client.ts b/src/management/api/resources/organizations/resources/discoveryDomains/client/Client.ts
index 994e970db0..0e55a76498 100644
--- a/src/management/api/resources/organizations/resources/discoveryDomains/client/Client.ts
+++ b/src/management/api/resources/organizations/resources/discoveryDomains/client/Client.ts
@@ -496,7 +496,7 @@ export class DiscoveryDomainsClient {
}
/**
- * 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).
+ * 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`).
*
* @param {string} id - ID of the organization.
* @param {string} discovery_domain_id - ID of the discovery domain to update.
diff --git a/src/management/api/resources/organizations/resources/enabledConnections/client/Client.ts b/src/management/api/resources/organizations/resources/enabledConnections/client/Client.ts
index 8c4fa5fd80..fb0e3fe238 100644
--- a/src/management/api/resources/organizations/resources/enabledConnections/client/Client.ts
+++ b/src/management/api/resources/organizations/resources/enabledConnections/client/Client.ts
@@ -149,7 +149,7 @@ export class EnabledConnectionsClient {
/**
* 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.
+ * [Connections](https://auth0.com/docs/authenticate/identity-providers) represent the relationship between Auth0 and a source of users. Available types of connections include database, enterprise, and social.
*
* @param {string} id - Organization identifier.
* @param {Management.AddOrganizationConnectionRequestContent} request
@@ -321,7 +321,7 @@ export class EnabledConnectionsClient {
/**
* 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.
+ * **Note**: This action does not remove the connection from your tenant.
*
* @param {string} id - Organization identifier.
* @param {string} connectionId - Connection identifier.
diff --git a/src/management/api/resources/organizations/resources/groups/client/Client.ts b/src/management/api/resources/organizations/resources/groups/client/Client.ts
new file mode 100644
index 0000000000..9975a5af08
--- /dev/null
+++ b/src/management/api/resources/organizations/resources/groups/client/Client.ts
@@ -0,0 +1,142 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../../../BaseClient.js";
+import { normalizeClientOptionsWithAuth, type NormalizedClientOptionsWithAuth } from "../../../../../../BaseClient.js";
+import * as core from "../../../../../../core/index.js";
+import { mergeHeaders } from "../../../../../../core/headers.js";
+import * as environments from "../../../../../../environments.js";
+import { handleNonStatusCodeError } from "../../../../../../errors/handleNonStatusCodeError.js";
+import * as errors from "../../../../../../errors/index.js";
+import * as Management from "../../../../../index.js";
+import { RolesClient } from "../resources/roles/client/Client.js";
+
+export declare namespace GroupsClient {
+ export type Options = BaseClientOptions;
+
+ export interface RequestOptions extends BaseRequestOptions {}
+}
+
+export class GroupsClient {
+ protected readonly _options: NormalizedClientOptionsWithAuthfields parameter to optionally define the specific member details retrieved. If fields is left blank, all fields (except roles) are returned.
- * fields=roles to retrieve the roles assigned to each listed member. To use this parameter, you must include the read:organization_member_roles scope in the token.
- * from parameter. If there are more results, a next value will be included in the response. You can use this for subsequent API calls. When next is no longer included in the response, this indicates there are no more pages remaining.
+ * 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.
*
* @param {string} id - Organization identifier.
* @param {Management.ListOrganizationMembersRequestParameters} request
@@ -168,9 +168,9 @@ export class MembersClient {
}
/**
- * Set one or more existing users as members of a specific Organization.
+ * Set one or more existing users as members of a specific [Organization](https://auth0.com/docs/manage-users/organizations).
*
- * 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.
+ * 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](https://auth0.com/docs/manage-users/organizations/configure-organizations/invite-members), manually create them through the Auth0 Dashboard, or use the Management API.
*
* @param {string} id - Organization identifier.
* @param {Management.CreateOrganizationMemberRequestContent} request
diff --git a/src/management/api/resources/organizations/resources/members/resources/effectiveRoles/client/Client.ts b/src/management/api/resources/organizations/resources/members/resources/effectiveRoles/client/Client.ts
new file mode 100644
index 0000000000..a65f01d550
--- /dev/null
+++ b/src/management/api/resources/organizations/resources/members/resources/effectiveRoles/client/Client.ts
@@ -0,0 +1,155 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../../../../../BaseClient.js";
+import {
+ normalizeClientOptionsWithAuth,
+ type NormalizedClientOptionsWithAuth,
+} from "../../../../../../../../BaseClient.js";
+import * as core from "../../../../../../../../core/index.js";
+import { mergeHeaders } from "../../../../../../../../core/headers.js";
+import * as environments from "../../../../../../../../environments.js";
+import { handleNonStatusCodeError } from "../../../../../../../../errors/handleNonStatusCodeError.js";
+import * as errors from "../../../../../../../../errors/index.js";
+import * as Management from "../../../../../../../index.js";
+import { SourcesClient } from "../resources/sources/client/Client.js";
+
+export declare namespace EffectiveRolesClient {
+ export type Options = BaseClientOptions;
+
+ export interface RequestOptions extends BaseRequestOptions {}
+}
+
+export class EffectiveRolesClient {
+ protected readonly _options: NormalizedClientOptionsWithAuthfrom: Optional id from which to start selection.take: The total amount of entries to retrieve when using the from parameter. Defaults to 50.from parameter. If there are more results, a next value is included in the response. You can use this for subsequent API calls. When next is no longer included in the response, no pages are remaining.
+ * - `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.
*
* @param {string} id - ID of the role to retrieve a list of users associated with.
* @param {Management.ListRoleUsersRequestParameters} request
@@ -151,9 +149,9 @@ export class UsersClient {
}
/**
- * Assign one or more users to an existing user role. To learn more, review Role-Based Access Control.
+ * Assign one or more users to an existing user role. To learn more, review [Role-Based Access Control](https://auth0.com/docs/manage-users/access-control/rbac).
*
- * Note: New roles cannot be created through this action.
+ * **Note**: New roles cannot be created through this action.
*
* @param {string} id - ID of the role to assign users to.
* @param {Management.AssignRoleUsersRequestContent} request
diff --git a/src/management/api/resources/rules/client/Client.ts b/src/management/api/resources/rules/client/Client.ts
index 3f3f3b7bab..5c773ba522 100644
--- a/src/management/api/resources/rules/client/Client.ts
+++ b/src/management/api/resources/rules/client/Client.ts
@@ -23,7 +23,7 @@ export class RulesClient {
}
/**
- * Retrieve a filtered list of rules. Accepts a list of fields to include or exclude.
+ * Retrieve a filtered list of [rules](https://auth0.com/docs/rules). Accepts a list of fields to include or exclude.
*
* @param {Management.ListRulesRequestParameters} request
* @param {RulesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -147,9 +147,9 @@ export class RulesClient {
}
/**
- * Create a new rule.
+ * Create a [new rule](https://auth0.com/docs/rules#create-a-new-rule-using-the-management-api).
*
- * Note: Changing a rule's stage of execution from the default login_success can change the rule's function signature to have user omitted.
+ * Note: Changing a rule's stage of execution from the default `login_success` can change the rule's function signature to have user omitted.
*
* @param {Management.CreateRuleRequestContent} request
* @param {RulesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -231,7 +231,7 @@ export class RulesClient {
}
/**
- * Retrieve rule details. Accepts a list of fields to include or exclude in the result.
+ * Retrieve [rule](https://auth0.com/docs/rules) details. Accepts a list of fields to include or exclude in the result.
*
* @param {string} id - ID of the rule to retrieve.
* @param {Management.GetRuleRequestParameters} request
diff --git a/src/management/api/resources/userAttributeProfiles/client/Client.ts b/src/management/api/resources/userAttributeProfiles/client/Client.ts
index 600f19609e..0c3398a4bd 100644
--- a/src/management/api/resources/userAttributeProfiles/client/Client.ts
+++ b/src/management/api/resources/userAttributeProfiles/client/Client.ts
@@ -138,7 +138,7 @@ export class UserAttributeProfilesClient {
}
/**
- * Create a User Attribute Profile
+ * Create a User Attribute Profile.
*
* @param {Management.CreateUserAttributeProfileRequestContent} request
* @param {UserAttributeProfilesClient.RequestOptions} requestOptions - Request-specific configuration.
diff --git a/src/management/api/resources/userBlocks/client/Client.ts b/src/management/api/resources/userBlocks/client/Client.ts
index cecdd8c2ee..98d062f9f1 100644
--- a/src/management/api/resources/userBlocks/client/Client.ts
+++ b/src/management/api/resources/userBlocks/client/Client.ts
@@ -23,7 +23,7 @@ export class UserBlocksClient {
}
/**
- * Retrieve details of all Brute-force Protection blocks for a user with the given identifier (username, phone number, or email).
+ * Retrieve details of all [Brute-force Protection](https://auth0.com/docs/secure/attack-protection/brute-force-protection) blocks for a user with the given identifier (username, phone number, or email).
*
* @param {Management.ListUserBlocksByIdentifierRequestParameters} request
* @param {UserBlocksClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -111,9 +111,9 @@ export class UserBlocksClient {
}
/**
- * Remove all Brute-force Protection blocks for the user with the given identifier (username, phone number, or email).
+ * Remove all [Brute-force Protection](https://auth0.com/docs/secure/attack-protection/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.
+ * Note: This endpoint does not unblock users that were [blocked by a tenant administrator](https://auth0.com/docs/user-profile#block-and-unblock-a-user).
*
* @param {Management.DeleteUserBlocksByIdentifierRequestParameters} request
* @param {UserBlocksClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -196,7 +196,7 @@ export class UserBlocksClient {
}
/**
- * Retrieve details of all Brute-force Protection blocks for the user with the given ID.
+ * Retrieve details of all [Brute-force Protection](https://auth0.com/docs/secure/attack-protection/brute-force-protection) blocks for the user with the given ID.
*
* @param {string} id - user_id of the user blocks to retrieve.
* @param {Management.ListUserBlocksRequestParameters} request
@@ -288,9 +288,9 @@ export class UserBlocksClient {
}
/**
- * Remove all Brute-force Protection blocks for the user with the given ID.
+ * Remove all [Brute-force Protection](https://auth0.com/docs/secure/attack-protection/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.
+ * Note: This endpoint does not unblock users that were [blocked by a tenant administrator](https://auth0.com/docs/user-profile#block-and-unblock-a-user).
*
* @param {string} id - The user_id of the user to update.
* @param {UserBlocksClient.RequestOptions} requestOptions - Request-specific configuration.
diff --git a/src/management/api/resources/users/client/Client.ts b/src/management/api/resources/users/client/Client.ts
index 10e8303ca0..065240330c 100644
--- a/src/management/api/resources/users/client/Client.ts
+++ b/src/management/api/resources/users/client/Client.ts
@@ -11,6 +11,8 @@ import * as Management from "../../../index.js";
import { AuthenticationMethodsClient } from "../resources/authenticationMethods/client/Client.js";
import { AuthenticatorsClient } from "../resources/authenticators/client/Client.js";
import { ConnectedAccountsClient } from "../resources/connectedAccounts/client/Client.js";
+import { EffectivePermissionsClient } from "../resources/effectivePermissions/client/Client.js";
+import { EffectiveRolesClient } from "../resources/effectiveRoles/client/Client.js";
import { EnrollmentsClient } from "../resources/enrollments/client/Client.js";
import { FederatedConnectionsTokensetsClient } from "../resources/federatedConnectionsTokensets/client/Client.js";
import { GroupsClient } from "../resources/groups/client/Client.js";
@@ -35,6 +37,8 @@ export class UsersClient {
protected _authenticationMethods: AuthenticationMethodsClient | undefined;
protected _authenticators: AuthenticatorsClient | undefined;
protected _connectedAccounts: ConnectedAccountsClient | undefined;
+ protected _effectivePermissions: EffectivePermissionsClient | undefined;
+ protected _effectiveRoles: EffectiveRolesClient | undefined;
protected _enrollments: EnrollmentsClient | undefined;
protected _federatedConnectionsTokensets: FederatedConnectionsTokensetsClient | undefined;
protected _groups: GroupsClient | undefined;
@@ -64,6 +68,14 @@ export class UsersClient {
return (this._connectedAccounts ??= new ConnectedAccountsClient(this._options));
}
+ public get effectivePermissions(): EffectivePermissionsClient {
+ return (this._effectivePermissions ??= new EffectivePermissionsClient(this._options));
+ }
+
+ public get effectiveRoles(): EffectiveRolesClient {
+ return (this._effectiveRoles ??= new EffectiveRolesClient(this._options));
+ }
+
public get enrollments(): EnrollmentsClient {
return (this._enrollments ??= new EnrollmentsClient(this._options));
}
@@ -119,14 +131,18 @@ export class UsersClient {
* - 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.
+ * The `q` query parameter can be used to get users that match the specified criteria [using query string syntax.](https://auth0.com/docs/users/search/v3/query-syntax)
+ *
+ * [Learn more about searching for users.](https://auth0.com/docs/users/search/v3)
+ *
+ * Read about [best practices](https://auth0.com/docs/users/search/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](https://auth0.com/docs/api/management/v2#!/Jobs/post_users_exports), or the [User Import / Export](https://auth0.com/docs/extensions/user-import-export) extension.
*
* @param {Management.ListUsersRequestParameters} request
* @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -265,9 +281,9 @@ export class UsersClient {
}
/**
- * Create a new user for a given database or passwordless connection.
+ * Create a new user for a given [database](https://auth0.com/docs/connections/database) or [passwordless](https://auth0.com/docs/connections/passwordless) connection.
*
- * Note: connection is required but other parameters such as email and password are dependent upon the type of connection.
+ * Note: `connection` is required but other parameters such as `email` and `password` are dependent upon the type of connection.
*
* @param {Management.CreateUserRequestContent} request
* @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -439,7 +455,7 @@ export class UsersClient {
}
/**
- * 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.
+ * 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](https://auth0.com/docs/manage-users/user-search/retrieve-users-with-get-users-endpoint).
*
* @param {string} id - ID of the user to retrieve.
* @param {Management.GetUserRequestParameters} request
@@ -530,7 +546,7 @@ export class UsersClient {
}
/**
- * Delete a user by user ID. This action cannot be undone. For Auth0 Dashboard instructions, see Delete Users.
+ * Delete a user by user ID. This action cannot be undone. For Auth0 Dashboard instructions, see [Delete Users](https://auth0.com/docs/manage-users/user-accounts/delete-users).
*
* @param {string} id - ID of the user to delete.
* @param {UsersClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -604,64 +620,84 @@ export class UsersClient {
*
* These are the attributes that can be updated at the root level:
*
- * user_metadata and app_metadata). These properties are merged instead of being replaced but be careful, the merge only occurs on the first level.email, email_verified, phone_number, phone_verified, username or password of a secondary identity, you need to specify the connection property too.email or phone_number you can specify, optionally, the client_id property.email_verified is not supported for enterprise and passwordless sms connections.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.null as the value.{ "email_verified": true }user_metadata:
- * { "user_metadata" : { "profileCode": 1479 } }addresses the body to send should be:
- * { "user_metadata" : { "addresses": {"work_address": "100 Industrial Way"} }}user_metadata property:{
+ * ```json
+ * { "user_metadata" : { "addresses": {"work_address": "100 Industrial Way"} }}
+ * ```
+ *
+ * The modified object ends up with the following `user_metadata` property:
+ *
+ * ```json
+ * {
* "user_metadata": {
* "profileCode": 1479,
* "addresses": { "work_address": "100 Industrial Way" }
* }
- * }"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:
- * {
+ * 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:
+ *
+ * ```json
+ * {
* "user_metadata": {
* "addresses": {
* "work_address": "100 Industrial Way",
* "home_address": "742 Evergreen Terrace"
* }
* }
- * }user_metadata property:
- * {
+ * ```json
+ * {
* "user_metadata": {
* "profileCode": 1479,
* "addresses": {
@@ -669,7 +705,8 @@ export class UsersClient {
* "home_address": "742 Evergreen Terrace"
* }
* }
- * }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.
- * 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.
- * null to unset, a solid color as a string value #FFFFFF, or a gradient as an object.
+ * Property contains either `null` to unset, a solid color as a string value `#FFFFFF`, or a gradient as an object.
*
- *
+ * ```js
* {
* type: 'linear-gradient',
* start: '#FFFFFF',
* end: '#000000',
* angle_deg: 35
* }
- * cimd identifies clients registered via a Client ID Metadata Document. */
+/** Indicates the type of external metadata used to register the client. This field is omitted for regular clients. The value cimd identifies clients registered via a Client ID Metadata Document. The value dcr identifies clients registered via Dynamic Client Registration. */
export const ClientExternalMetadataTypeEnum = {
Cimd: "cimd",
+ Dcr: "dcr",
} as const;
export type ClientExternalMetadataTypeEnum =
(typeof ClientExternalMetadataTypeEnum)[keyof typeof ClientExternalMetadataTypeEnum];
@@ -3372,7 +3424,7 @@ export type ConnectionAuthorizationEndpoint = string;
/**
* Base URL override for the Exact Online API endpoint used for OAuth2 authorization and API requests. Defaults to https://start.exactonline.nl.
*/
-export type ConnectionBaseUrlExact = Management.ConnectionHttpsUrlWithHttpFallback;
+export type ConnectionBaseUrlExact = string;
/**
* Enables Auth0's brute force protection to prevent credential stuffing attacks. When enabled, blocks suspicious login attempts from specific IP addresses after repeated failures.
@@ -3417,26 +3469,29 @@ export type ConnectionClientIdBitbucket = string;
export type ConnectionClientId = string;
/**
- * OAuth 2.0 client identifier obtained from Amazon Developer Console during Login with Amazon application registration. When not provided, Auth0 development keys are used for testing purposes.
+ * OAuth 2.0 client identifier issued by the identity provider during application registration. This value identifies your Auth0 connection to the identity provider.
*/
-export type ConnectionClientIdAmazon = Management.ConnectionClientId;
+export type ConnectionClientIdAmazon = string;
-export type ConnectionClientIdAzureAd = Management.ConnectionClientId;
+/**
+ * OAuth 2.0 client identifier issued by the identity provider during application registration. This value identifies your Auth0 connection to the identity provider.
+ */
+export type ConnectionClientIdAzureAd = string;
/**
- * OAuth2.0 client identifier for the Exact Online connection, obtained when registering your application in the Exact App Center.
+ * OAuth 2.0 client identifier issued by the identity provider during application registration. This value identifies your Auth0 connection to the identity provider.
*/
-export type ConnectionClientIdExact = Management.ConnectionClientId;
+export type ConnectionClientIdExact = string;
/**
- * Your Facebook App ID. You can find this in your [Facebook Developers Console](https://developers.facebook.com/apps) under the App Settings section.
+ * OAuth 2.0 client identifier issued by the identity provider during application registration. This value identifies your Auth0 connection to the identity provider.
*/
-export type ConnectionClientIdFacebook = Management.ConnectionClientId;
+export type ConnectionClientIdFacebook = string;
/**
- * Your Google OAuth 2.0 client ID. You can find this in your [Google Cloud Console](https://console.cloud.google.com/apis/credentials) under the OAuth 2.0 Client IDs section.
+ * OAuth 2.0 client identifier issued by the identity provider during application registration. This value identifies your Auth0 connection to the identity provider.
*/
-export type ConnectionClientIdGoogleApps = Management.ConnectionClientId;
+export type ConnectionClientIdGoogleApps = string;
/**
* Your Google OAuth 2.0 client ID. You can find this in your [Google Cloud Console](https://console.cloud.google.com/apis/credentials) under the OAuth 2.0 Client IDs section.
@@ -3454,18 +3509,24 @@ export type ConnectionClientIdLine = string;
export type ConnectionClientIdLinkedin = string;
/**
- * OAuth 1.0a client ID (consumer key) that identifies the client to the provider and is used to sign OAuth 1.0a requests.
+ * OAuth 2.0 client identifier issued by the identity provider during application registration. This value identifies your Auth0 connection to the identity provider.
*/
-export type ConnectionClientIdOAuth1 = Management.ConnectionClientId;
+export type ConnectionClientIdOAuth1 = string;
-export type ConnectionClientIdOAuth2 = Management.ConnectionClientId;
+/**
+ * OAuth 2.0 client identifier issued by the identity provider during application registration. This value identifies your Auth0 connection to the identity provider.
+ */
+export type ConnectionClientIdOAuth2 = string;
-export type ConnectionClientIdOidc = Management.ConnectionClientId;
+/**
+ * OAuth 2.0 client identifier issued by the identity provider during application registration. This value identifies your Auth0 connection to the identity provider.
+ */
+export type ConnectionClientIdOidc = string;
/**
- * OAuth 2.0 client identifier issued by PayPal during application registration. This value identifies your Auth0 connection to PayPal. Leave empty to use Auth0 Dev Keys.
+ * OAuth 2.0 client identifier issued by the identity provider during application registration. This value identifies your Auth0 connection to the identity provider.
*/
-export type ConnectionClientIdPaypal = Management.ConnectionClientId;
+export type ConnectionClientIdPaypal = string;
/**
* The OAuth 2.0 client identifier
@@ -3488,31 +3549,34 @@ export type ConnectionClientProtocolSaml = Management.ConnectionOptionsIdpInitia
export type ConnectionClientSecret = string;
/**
- * OAuth 2.0 client secret obtained from Amazon Developer Console during Login with Amazon application registration. Used to authenticate your application when exchanging authorization codes for tokens.
+ * OAuth 2.0 client secret issued by the identity provider during application registration. Used to authenticate your Auth0 connection when exchanging authorization codes for tokens. May be null for public clients.
*/
-export type ConnectionClientSecretAmazon = Management.ConnectionClientSecret;
+export type ConnectionClientSecretAmazon = string;
/**
* The client secret (application password) from your Azure AD app registration. Used to authenticate your application when exchanging authorization codes for tokens.
*/
export type ConnectionClientSecretAzureAd = string;
-export type ConnectionClientSecretBitbucket = Management.ConnectionClientSecret;
+/**
+ * OAuth 2.0 client secret issued by the identity provider during application registration. Used to authenticate your Auth0 connection when exchanging authorization codes for tokens. May be null for public clients.
+ */
+export type ConnectionClientSecretBitbucket = string;
/**
- * OAuth2.0 client secret for the Exact Online connection, obtained when registering your application in the Exact App Center.
+ * OAuth 2.0 client secret issued by the identity provider during application registration. Used to authenticate your Auth0 connection when exchanging authorization codes for tokens. May be null for public clients.
*/
-export type ConnectionClientSecretExact = Management.ConnectionClientSecret;
+export type ConnectionClientSecretExact = string;
/**
- * Your Facebook App Secret. You can find this in your [Facebook Developers Console](https://developers.facebook.com/apps) under the App Settings section.
+ * OAuth 2.0 client secret issued by the identity provider during application registration. Used to authenticate your Auth0 connection when exchanging authorization codes for tokens. May be null for public clients.
*/
-export type ConnectionClientSecretFacebook = Management.ConnectionClientSecret;
+export type ConnectionClientSecretFacebook = string;
/**
- * Your Google OAuth 2.0 client secret. You can find this in your [Google Cloud Console](https://console.cloud.google.com/apis/credentials) under the OAuth 2.0 Client IDs section.
+ * OAuth 2.0 client secret issued by the identity provider during application registration. Used to authenticate your Auth0 connection when exchanging authorization codes for tokens. May be null for public clients.
*/
-export type ConnectionClientSecretGoogleApps = Management.ConnectionClientSecret;
+export type ConnectionClientSecretGoogleApps = string;
/**
* Your Google OAuth 2.0 client secret. You can find this in your [Google Cloud Console](https://console.cloud.google.com/apis/credentials) under the OAuth 2.0 Client IDs section.
@@ -3530,25 +3594,34 @@ export type ConnectionClientSecretLine = string;
export type ConnectionClientSecretLinkedin = string;
/**
- * OAuth 1.0a client secret paired with the consumer key to sign request-token and access-token requests for this connection. Treat as a sensitive credential and supply the exact secret issued by the upstream provider.
+ * OAuth 2.0 client secret issued by the identity provider during application registration. Used to authenticate your Auth0 connection when exchanging authorization codes for tokens. May be null for public clients.
*/
-export type ConnectionClientSecretOAuth1 = Management.ConnectionClientSecret;
+export type ConnectionClientSecretOAuth1 = string;
-export type ConnectionClientSecretOAuth2 = Management.ConnectionClientSecret;
+/**
+ * OAuth 2.0 client secret issued by the identity provider during application registration. Used to authenticate your Auth0 connection when exchanging authorization codes for tokens. May be null for public clients.
+ */
+export type ConnectionClientSecretOAuth2 = string;
-export type ConnectionClientSecretOidc = Management.ConnectionClientSecret;
+/**
+ * OAuth 2.0 client secret issued by the identity provider during application registration. Used to authenticate your Auth0 connection when exchanging authorization codes for tokens. May be null for public clients.
+ */
+export type ConnectionClientSecretOidc = string;
/**
- * OAuth 2.0 client secret issued by PayPal during application registration. Leave empty to use Auth0 Dev Keys.
+ * OAuth 2.0 client secret issued by the identity provider during application registration. Used to authenticate your Auth0 connection when exchanging authorization codes for tokens. May be null for public clients.
*/
-export type ConnectionClientSecretPaypal = Management.ConnectionClientSecret;
+export type ConnectionClientSecretPaypal = string;
/**
* The OAuth 2.0 client secret
*/
export type ConnectionClientSecretSalesforce = string;
-export type ConnectionClientSecretWindowsLive = Management.ConnectionClientSecret;
+/**
+ * OAuth 2.0 client secret issued by the identity provider during application registration. Used to authenticate your Auth0 connection when exchanging authorization codes for tokens. May be null for public clients.
+ */
+export type ConnectionClientSecretWindowsLive = string;
export interface ConnectionCommon {
display_name?: Management.ConnectionDisplayName | undefined;
@@ -3724,6 +3797,8 @@ export type ConnectionDomainOkta = string;
/** Algorithm used for DPoP proof JWT signing. */
export const ConnectionDpopSigningAlgEnum = {
Es256: "ES256",
+ Es384: "ES384",
+ Es512: "ES512",
Ed25519: "Ed25519",
} as const;
export type ConnectionDpopSigningAlgEnum =
@@ -4032,9 +4107,9 @@ export type ConnectionHandleLoginFromSocialGoogleApps = boolean;
export type ConnectionHttpsUrlWithHttpFallback = string;
-export type ConnectionHttpsUrlWithHttpFallback2048 = Management.ConnectionHttpsUrlWithHttpFallback;
+export type ConnectionHttpsUrlWithHttpFallback2048 = string;
-export type ConnectionHttpsUrlWithHttpFallback255 = Management.ConnectionHttpsUrlWithHttpFallback;
+export type ConnectionHttpsUrlWithHttpFallback255 = string;
/**
* https url of the icon to be shown
@@ -4209,9 +4284,15 @@ export type ConnectionIpsAd = string[];
*/
export type ConnectionIsDomainConnection = boolean;
-export type ConnectionIssuer = Management.ConnectionHttpsUrlWithHttpFallback255;
+/**
+ * The identity provider's unique issuer identifier URL (e.g., https://accounts.google.com). Must match the 'iss' claim in ID tokens from the identity provider.
+ */
+export type ConnectionIssuer = string;
-export type ConnectionJwksUri = Management.ConnectionHttpsUrlWithHttpFallback255;
+/**
+ * URL of the identity provider's JSON Web Key Set (JWKS) endpoint containing public keys for signature verification. Auth0 retrieves these keys to validate ID token signatures.
+ */
+export type ConnectionJwksUri = string;
export interface ConnectionKey {
/** The key id of the signing key */
@@ -4318,9 +4399,15 @@ export type ConnectionNamePrefixTemplate = string;
*/
export type ConnectionNonPersistentAttrs = string[];
-export type ConnectionOpPolicyUri = Management.ConnectionHttpsUrlWithHttpFallback255;
+/**
+ * URL that the OpenID Provider provides to the person registering the Client to read about the OPs requirements on how the Relying Party can use the data provided by the OP. The registration process SHOULD display this URL to the person registering the Client if it is given.
+ */
+export type ConnectionOpPolicyUri = string;
-export type ConnectionOpTosUri = Management.ConnectionHttpsUrlWithHttpFallback255;
+/**
+ * URL that the OpenID Provider provides to the person registering the Client to read about OpenID Providers terms of service. The registration process SHOULD display this URL to the person registering the Client if it is given.
+ */
+export type ConnectionOpTosUri = string;
/**
* In order to return options in the response, the `read:connections_options` scope must be present
@@ -5871,7 +5958,7 @@ export type ConnectionPingFederateBaseUrl = Management.ConnectionPingFederateBas
/**
* PingFederate base URL constrained to HTTP/HTTPS with length bounds
*/
-export type ConnectionPingFederateBaseUrlPingFederate = Management.ConnectionHttpsUrlWithHttpFallback;
+export type ConnectionPingFederateBaseUrlPingFederate = string;
export interface ConnectionProfile {
id?: Management.ConnectionProfileId | undefined;
@@ -6029,6 +6116,7 @@ export interface ConnectionPropertiesOptions {
password_options?: Management.ConnectionPasswordOptions | undefined;
assertion_decryption_settings?: Management.ConnectionAssertionDecryptionSettings | undefined;
id_token_signed_response_algs?: ((Management.ConnectionIdTokenSignedResponseAlgs | undefined) | null) | undefined;
+ dpop_signing_alg?: Management.ConnectionDpopSigningAlgEnum | undefined;
token_endpoint_auth_method?: (Management.ConnectionTokenEndpointAuthMethodEnum | null) | undefined;
token_endpoint_auth_signing_alg?: (Management.ConnectionTokenEndpointAuthSigningAlgEnum | null) | undefined;
token_endpoint_jwtca_aud_format?: Management.ConnectionTokenEndpointJwtcaAudFormatEnumOidc | undefined;
@@ -6089,7 +6177,10 @@ export type ConnectionRealms = string[];
*/
export type ConnectionRecipientUrlSaml = Management.ConnectionHttpsUrlWithHttpFallback255;
-export type ConnectionRegistrationEndpoint = Management.ConnectionHttpsUrlWithHttpFallback255;
+/**
+ * URL of the OPs Dynamic Client Registration Endpoint. RECOMMENDED but not REQUIRED. https://openid.net/specs/openid-connect-discovery-1_0.html#OpenID.Registration
+ */
+export type ConnectionRegistrationEndpoint = string;
/**
* JSON array containing a list of the JWE encryption algorithms (alg values) supported by the OP for Request Objects. These algorithms are used both when the Request Object is passed by value and when it is passed by reference.
@@ -7153,7 +7244,10 @@ export interface ConnectionScriptsOAuth2 {
*/
export type ConnectionSendBackChannelNonce = boolean;
-export type ConnectionServiceDocumentation = Management.ConnectionHttpsUrlWithHttpFallback255;
+/**
+ * URL of a page containing human-readable information that developers might want or need to know when using the OpenID Provider. In particular, if the OpenID Provider does not support Dynamic Client Registration, then information on how to register Clients needs to be provided in this documentation.
+ */
+export type ConnectionServiceDocumentation = string;
/** When using an external IdP, this flag determines whether 'name', 'given_name', 'family_name', 'nickname', and 'picture' attributes are updated. In addition, it also determines whether the user is created when user doesnt exist previously. Possible values are 'on_each_login' (default value, it configures the connection to automatically create the user if necessary and update the root attributes from the external IdP with each user login. When this setting is used, root attributes cannot be independently updated), 'on_first_login' (configures the connection to create the user and set the root attributes on first login only, allowing them to be independently updated thereafter), and 'never_on_login' (configures the connection not to create the user and not to set the root attributes from the external IdP, allowing them to be independently updated). */
export const ConnectionSetUserRootAttributesEnum = {
@@ -7367,7 +7461,10 @@ export type ConnectionTenantDomainAzureAdOne = string;
*/
export type ConnectionTenantDomainGoogleApps = Management.ConnectionTenantDomain;
-export type ConnectionTenantDomainSaml = Management.ConnectionTenantDomain;
+/**
+ * For SAML connections, the tenant domain used to construct the login endpoint URL. Can be a string for single-tenant or an array of strings for multi-tenant validation.
+ */
+export type ConnectionTenantDomainSaml = string;
/**
* The Azure AD tenant ID as a UUID. The unique identifier for your Azure AD organization. Must be a valid 36-character UUID.
@@ -7389,7 +7486,10 @@ export type ConnectionThumbprintsAd = Management.ConnectionSha1Thumbprint[];
*/
export type ConnectionThumbprintsSaml = Management.ConnectionSha1Thumbprint[];
-export type ConnectionTokenEndpoint = Management.ConnectionHttpsUrlWithHttpFallback255;
+/**
+ * URL of the identity provider's OAuth 2.0 token endpoint where authorization codes are exchanged for access tokens. Must be a valid HTTPS URL. Required for authorization code flow but optional for implicit flow.
+ */
+export type ConnectionTokenEndpoint = string;
/** Authentication method used at the identity provider's token endpoint. 'client_secret_post' sends credentials in the request body; 'private_key_jwt' uses a signed JWT assertion for enhanced security. */
export const ConnectionTokenEndpointAuthMethodEnum = {
@@ -7580,7 +7680,10 @@ export type ConnectionUserinfoEncryptionAlgValuesSupported = string[];
*/
export type ConnectionUserinfoEncryptionEncValuesSupported = string[];
-export type ConnectionUserinfoEndpoint = Management.ConnectionHttpsUrlWithHttpFallback255;
+/**
+ * Optional URL of the identity provider's UserInfo endpoint. When configured with attribute mapping, Auth0 calls this endpoint to retrieve additional user profile claims using the access token.
+ */
+export type ConnectionUserinfoEndpoint = string;
/**
* JSON array containing a list of the JWS [JWS] signing algorithms (alg values) [JWA] supported by the UserInfo Endpoint to encode the Claims in a JWT [JWT]. The value none MAY be included.
@@ -9728,6 +9831,20 @@ export interface CreatePublicKeyDeviceCredentialResponseContent {
[key: string]: any;
}
+export interface CreateRateLimitPolicyResponseContent {
+ /** Unique identifier for the Rate Limit Policy. */
+ id: string;
+ resource: Management.RateLimitPolicyResourceEnum;
+ consumer: Management.RateLimitPolicyConsumerEnum;
+ /** Identifier or category within the consumer to which the policy applies. Supported values: `client_id:null to unset, a solid color as a string value #FFFFFF, or a gradient as an object.
+ * Property contains either `null` to unset, a solid color as a string value `#FFFFFF`, or a gradient as an object.
*
- *
+ * ```js
* {
* type: 'linear-gradient',
* start: '#FFFFFF',
* end: '#000000',
* angle_deg: 35
* }
- *