auth0 5.11.0 → 5.12.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (152) hide show
  1. package/dist/cjs/lib/retry.d.ts +7 -2
  2. package/dist/cjs/lib/retry.js +35 -5
  3. package/dist/cjs/management/api/requests/requests.d.ts +12 -2
  4. package/dist/cjs/management/api/resources/branding/resources/phone/resources/providers/client/Client.d.ts +6 -6
  5. package/dist/cjs/management/api/resources/branding/resources/phone/resources/providers/client/Client.js +6 -6
  6. package/dist/cjs/management/api/resources/clientGrants/client/Client.d.ts +4 -4
  7. package/dist/cjs/management/api/resources/clientGrants/client/Client.js +4 -4
  8. package/dist/cjs/management/api/resources/clientGrants/resources/organizations/client/Client.d.ts +1 -0
  9. package/dist/cjs/management/api/resources/clientGrants/resources/organizations/client/Client.js +3 -0
  10. package/dist/cjs/management/api/resources/clients/client/Client.d.ts +68 -85
  11. package/dist/cjs/management/api/resources/clients/client/Client.js +68 -85
  12. package/dist/cjs/management/api/resources/clients/resources/connections/client/Client.d.ts +4 -9
  13. package/dist/cjs/management/api/resources/clients/resources/connections/client/Client.js +4 -9
  14. package/dist/cjs/management/api/resources/clients/resources/credentials/client/Client.d.ts +38 -14
  15. package/dist/cjs/management/api/resources/clients/resources/credentials/client/Client.js +38 -14
  16. package/dist/cjs/management/api/resources/connectionProfiles/client/Client.d.ts +1 -0
  17. package/dist/cjs/management/api/resources/connectionProfiles/client/Client.js +3 -0
  18. package/dist/cjs/management/api/resources/connections/resources/users/client/Client.d.ts +1 -0
  19. package/dist/cjs/management/api/resources/connections/resources/users/client/Client.js +3 -0
  20. package/dist/cjs/management/api/resources/customDomains/client/Client.d.ts +1 -0
  21. package/dist/cjs/management/api/resources/customDomains/client/Client.js +3 -0
  22. package/dist/cjs/management/api/resources/emails/resources/provider/client/Client.d.ts +50 -81
  23. package/dist/cjs/management/api/resources/emails/resources/provider/client/Client.js +50 -81
  24. package/dist/cjs/management/api/resources/groups/resources/members/client/Client.d.ts +1 -0
  25. package/dist/cjs/management/api/resources/groups/resources/members/client/Client.js +3 -0
  26. package/dist/cjs/management/api/resources/groups/resources/roles/client/Client.d.ts +5 -3
  27. package/dist/cjs/management/api/resources/groups/resources/roles/client/Client.js +9 -3
  28. package/dist/cjs/management/api/resources/organizations/client/Client.d.ts +2 -0
  29. package/dist/cjs/management/api/resources/organizations/client/Client.js +6 -0
  30. package/dist/cjs/management/api/resources/organizations/resources/connections/client/Client.d.ts +1 -0
  31. package/dist/cjs/management/api/resources/organizations/resources/connections/client/Client.js +3 -0
  32. package/dist/cjs/management/api/resources/organizations/resources/enabledConnections/client/Client.d.ts +5 -0
  33. package/dist/cjs/management/api/resources/organizations/resources/enabledConnections/client/Client.js +15 -0
  34. package/dist/cjs/management/api/resources/organizations/resources/groups/client/Client.d.ts +1 -0
  35. package/dist/cjs/management/api/resources/organizations/resources/groups/client/Client.js +3 -0
  36. package/dist/cjs/management/api/resources/organizations/resources/groups/resources/roles/client/Client.d.ts +3 -0
  37. package/dist/cjs/management/api/resources/organizations/resources/groups/resources/roles/client/Client.js +9 -0
  38. package/dist/cjs/management/api/resources/organizations/resources/members/client/Client.d.ts +1 -0
  39. package/dist/cjs/management/api/resources/organizations/resources/members/client/Client.js +3 -0
  40. package/dist/cjs/management/api/resources/organizations/resources/members/resources/effectiveRoles/client/Client.d.ts +1 -0
  41. package/dist/cjs/management/api/resources/organizations/resources/members/resources/effectiveRoles/client/Client.js +3 -0
  42. package/dist/cjs/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/resources/groups/client/Client.d.ts +1 -0
  43. package/dist/cjs/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/resources/groups/client/Client.js +3 -0
  44. package/dist/cjs/management/api/resources/organizations/resources/members/resources/roles/client/Client.d.ts +1 -0
  45. package/dist/cjs/management/api/resources/organizations/resources/members/resources/roles/client/Client.js +3 -0
  46. package/dist/cjs/management/api/resources/refreshTokens/client/Client.d.ts +1 -1
  47. package/dist/cjs/management/api/resources/refreshTokens/client/Client.js +1 -1
  48. package/dist/cjs/management/api/resources/roles/resources/groups/client/Client.d.ts +2 -0
  49. package/dist/cjs/management/api/resources/roles/resources/groups/client/Client.js +6 -0
  50. package/dist/cjs/management/api/resources/roles/resources/permissions/client/Client.d.ts +1 -0
  51. package/dist/cjs/management/api/resources/roles/resources/permissions/client/Client.js +3 -0
  52. package/dist/cjs/management/api/resources/selfServiceProfiles/resources/ssoTicket/client/Client.d.ts +1 -0
  53. package/dist/cjs/management/api/resources/selfServiceProfiles/resources/ssoTicket/client/Client.js +3 -0
  54. package/dist/cjs/management/api/resources/tokenExchangeProfiles/client/Client.d.ts +10 -12
  55. package/dist/cjs/management/api/resources/tokenExchangeProfiles/client/Client.js +12 -12
  56. package/dist/cjs/management/api/resources/userAttributeProfiles/client/Client.d.ts +1 -0
  57. package/dist/cjs/management/api/resources/userAttributeProfiles/client/Client.js +3 -0
  58. package/dist/cjs/management/api/resources/userGrants/client/Client.d.ts +1 -1
  59. package/dist/cjs/management/api/resources/userGrants/client/Client.js +1 -1
  60. package/dist/cjs/management/api/resources/users/resources/effectiveRoles/client/Client.d.ts +1 -0
  61. package/dist/cjs/management/api/resources/users/resources/effectiveRoles/client/Client.js +3 -0
  62. package/dist/cjs/management/api/resources/users/resources/effectiveRoles/resources/sources/resources/groups/client/Client.d.ts +1 -0
  63. package/dist/cjs/management/api/resources/users/resources/effectiveRoles/resources/sources/resources/groups/client/Client.js +3 -0
  64. package/dist/cjs/management/api/resources/users/resources/groups/client/Client.d.ts +1 -0
  65. package/dist/cjs/management/api/resources/users/resources/groups/client/Client.js +3 -0
  66. package/dist/cjs/management/api/resources/users/resources/organizations/client/Client.d.ts +1 -0
  67. package/dist/cjs/management/api/resources/users/resources/organizations/client/Client.js +3 -0
  68. package/dist/cjs/management/api/resources/users/resources/permissions/client/Client.d.ts +2 -0
  69. package/dist/cjs/management/api/resources/users/resources/permissions/client/Client.js +6 -0
  70. package/dist/cjs/management/api/resources/users/resources/roles/client/Client.d.ts +2 -0
  71. package/dist/cjs/management/api/resources/users/resources/roles/client/Client.js +6 -0
  72. package/dist/cjs/management/api/types/types.d.ts +131 -77
  73. package/dist/cjs/management/api/types/types.js +29 -45
  74. package/dist/cjs/management/version.d.ts +1 -1
  75. package/dist/cjs/management/version.js +1 -1
  76. package/dist/esm/lib/retry.d.mts +7 -2
  77. package/dist/esm/lib/retry.mjs +35 -5
  78. package/dist/esm/management/api/requests/requests.d.mts +12 -2
  79. package/dist/esm/management/api/resources/branding/resources/phone/resources/providers/client/Client.d.mts +6 -6
  80. package/dist/esm/management/api/resources/branding/resources/phone/resources/providers/client/Client.mjs +6 -6
  81. package/dist/esm/management/api/resources/clientGrants/client/Client.d.mts +4 -4
  82. package/dist/esm/management/api/resources/clientGrants/client/Client.mjs +4 -4
  83. package/dist/esm/management/api/resources/clientGrants/resources/organizations/client/Client.d.mts +1 -0
  84. package/dist/esm/management/api/resources/clientGrants/resources/organizations/client/Client.mjs +3 -0
  85. package/dist/esm/management/api/resources/clients/client/Client.d.mts +68 -85
  86. package/dist/esm/management/api/resources/clients/client/Client.mjs +68 -85
  87. package/dist/esm/management/api/resources/clients/resources/connections/client/Client.d.mts +4 -9
  88. package/dist/esm/management/api/resources/clients/resources/connections/client/Client.mjs +4 -9
  89. package/dist/esm/management/api/resources/clients/resources/credentials/client/Client.d.mts +38 -14
  90. package/dist/esm/management/api/resources/clients/resources/credentials/client/Client.mjs +38 -14
  91. package/dist/esm/management/api/resources/connectionProfiles/client/Client.d.mts +1 -0
  92. package/dist/esm/management/api/resources/connectionProfiles/client/Client.mjs +3 -0
  93. package/dist/esm/management/api/resources/connections/resources/users/client/Client.d.mts +1 -0
  94. package/dist/esm/management/api/resources/connections/resources/users/client/Client.mjs +3 -0
  95. package/dist/esm/management/api/resources/customDomains/client/Client.d.mts +1 -0
  96. package/dist/esm/management/api/resources/customDomains/client/Client.mjs +3 -0
  97. package/dist/esm/management/api/resources/emails/resources/provider/client/Client.d.mts +50 -81
  98. package/dist/esm/management/api/resources/emails/resources/provider/client/Client.mjs +50 -81
  99. package/dist/esm/management/api/resources/groups/resources/members/client/Client.d.mts +1 -0
  100. package/dist/esm/management/api/resources/groups/resources/members/client/Client.mjs +3 -0
  101. package/dist/esm/management/api/resources/groups/resources/roles/client/Client.d.mts +5 -3
  102. package/dist/esm/management/api/resources/groups/resources/roles/client/Client.mjs +9 -3
  103. package/dist/esm/management/api/resources/organizations/client/Client.d.mts +2 -0
  104. package/dist/esm/management/api/resources/organizations/client/Client.mjs +6 -0
  105. package/dist/esm/management/api/resources/organizations/resources/connections/client/Client.d.mts +1 -0
  106. package/dist/esm/management/api/resources/organizations/resources/connections/client/Client.mjs +3 -0
  107. package/dist/esm/management/api/resources/organizations/resources/enabledConnections/client/Client.d.mts +5 -0
  108. package/dist/esm/management/api/resources/organizations/resources/enabledConnections/client/Client.mjs +15 -0
  109. package/dist/esm/management/api/resources/organizations/resources/groups/client/Client.d.mts +1 -0
  110. package/dist/esm/management/api/resources/organizations/resources/groups/client/Client.mjs +3 -0
  111. package/dist/esm/management/api/resources/organizations/resources/groups/resources/roles/client/Client.d.mts +3 -0
  112. package/dist/esm/management/api/resources/organizations/resources/groups/resources/roles/client/Client.mjs +9 -0
  113. package/dist/esm/management/api/resources/organizations/resources/members/client/Client.d.mts +1 -0
  114. package/dist/esm/management/api/resources/organizations/resources/members/client/Client.mjs +3 -0
  115. package/dist/esm/management/api/resources/organizations/resources/members/resources/effectiveRoles/client/Client.d.mts +1 -0
  116. package/dist/esm/management/api/resources/organizations/resources/members/resources/effectiveRoles/client/Client.mjs +3 -0
  117. package/dist/esm/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/resources/groups/client/Client.d.mts +1 -0
  118. package/dist/esm/management/api/resources/organizations/resources/members/resources/effectiveRoles/resources/sources/resources/groups/client/Client.mjs +3 -0
  119. package/dist/esm/management/api/resources/organizations/resources/members/resources/roles/client/Client.d.mts +1 -0
  120. package/dist/esm/management/api/resources/organizations/resources/members/resources/roles/client/Client.mjs +3 -0
  121. package/dist/esm/management/api/resources/refreshTokens/client/Client.d.mts +1 -1
  122. package/dist/esm/management/api/resources/refreshTokens/client/Client.mjs +1 -1
  123. package/dist/esm/management/api/resources/roles/resources/groups/client/Client.d.mts +2 -0
  124. package/dist/esm/management/api/resources/roles/resources/groups/client/Client.mjs +6 -0
  125. package/dist/esm/management/api/resources/roles/resources/permissions/client/Client.d.mts +1 -0
  126. package/dist/esm/management/api/resources/roles/resources/permissions/client/Client.mjs +3 -0
  127. package/dist/esm/management/api/resources/selfServiceProfiles/resources/ssoTicket/client/Client.d.mts +1 -0
  128. package/dist/esm/management/api/resources/selfServiceProfiles/resources/ssoTicket/client/Client.mjs +3 -0
  129. package/dist/esm/management/api/resources/tokenExchangeProfiles/client/Client.d.mts +10 -12
  130. package/dist/esm/management/api/resources/tokenExchangeProfiles/client/Client.mjs +12 -12
  131. package/dist/esm/management/api/resources/userAttributeProfiles/client/Client.d.mts +1 -0
  132. package/dist/esm/management/api/resources/userAttributeProfiles/client/Client.mjs +3 -0
  133. package/dist/esm/management/api/resources/userGrants/client/Client.d.mts +1 -1
  134. package/dist/esm/management/api/resources/userGrants/client/Client.mjs +1 -1
  135. package/dist/esm/management/api/resources/users/resources/effectiveRoles/client/Client.d.mts +1 -0
  136. package/dist/esm/management/api/resources/users/resources/effectiveRoles/client/Client.mjs +3 -0
  137. package/dist/esm/management/api/resources/users/resources/effectiveRoles/resources/sources/resources/groups/client/Client.d.mts +1 -0
  138. package/dist/esm/management/api/resources/users/resources/effectiveRoles/resources/sources/resources/groups/client/Client.mjs +3 -0
  139. package/dist/esm/management/api/resources/users/resources/groups/client/Client.d.mts +1 -0
  140. package/dist/esm/management/api/resources/users/resources/groups/client/Client.mjs +3 -0
  141. package/dist/esm/management/api/resources/users/resources/organizations/client/Client.d.mts +1 -0
  142. package/dist/esm/management/api/resources/users/resources/organizations/client/Client.mjs +3 -0
  143. package/dist/esm/management/api/resources/users/resources/permissions/client/Client.d.mts +2 -0
  144. package/dist/esm/management/api/resources/users/resources/permissions/client/Client.mjs +6 -0
  145. package/dist/esm/management/api/resources/users/resources/roles/client/Client.d.mts +2 -0
  146. package/dist/esm/management/api/resources/users/resources/roles/client/Client.mjs +6 -0
  147. package/dist/esm/management/api/types/types.d.mts +131 -77
  148. package/dist/esm/management/api/types/types.mjs +16 -32
  149. package/dist/esm/management/version.d.mts +1 -1
  150. package/dist/esm/management/version.mjs +1 -1
  151. package/package.json +1 -1
  152. package/reference.md +223 -261
@@ -18,38 +18,30 @@ export declare class ClientsClient {
18
18
  get connections(): ConnectionsClient;
19
19
  /**
20
20
  * Retrieve clients (applications and SSO integrations) matching provided filters. A list of fields to include or exclude may also be specified.
21
- * For more information, read <a href="https://www.auth0.com/docs/get-started/applications"> Applications in Auth0</a> and <a href="https://www.auth0.com/docs/authenticate/single-sign-on"> Single Sign-On</a>.
22
- *
23
- * <ul>
24
- * <li>
25
- * The following can be retrieved with any scope:
26
- * <code>client_id</code>, <code>app_type</code>, <code>name</code>, and <code>description</code>.
27
- * </li>
28
- * <li>
29
- * The following properties can only be retrieved with the <code>read:clients</code> or
30
- * <code>read:client_keys</code> scope:
31
- * <code>callbacks</code>, <code>oidc_logout</code>, <code>allowed_origins</code>,
32
- * <code>web_origins</code>, <code>tenant</code>, <code>global</code>, <code>config_route</code>,
33
- * <code>callback_url_template</code>, <code>jwt_configuration</code>,
34
- * <code>jwt_configuration.lifetime_in_seconds</code>, <code>jwt_configuration.secret_encoded</code>,
35
- * <code>jwt_configuration.scopes</code>, <code>jwt_configuration.alg</code>, <code>api_type</code>,
36
- * <code>logo_uri</code>, <code>allowed_clients</code>, <code>owners</code>, <code>custom_login_page</code>,
37
- * <code>custom_login_page_off</code>, <code>sso</code>, <code>addons</code>, <code>form_template</code>,
38
- * <code>custom_login_page_codeview</code>, <code>resource_servers</code>, <code>client_metadata</code>,
39
- * <code>mobile</code>, <code>mobile.android</code>, <code>mobile.ios</code>, <code>allowed_logout_urls</code>,
40
- * <code>token_endpoint_auth_method</code>, <code>is_first_party</code>, <code>oidc_conformant</code>,
41
- * <code>is_token_endpoint_ip_header_trusted</code>, <code>initiate_login_uri</code>, <code>grant_types</code>,
42
- * <code>refresh_token</code>, <code>refresh_token.rotation_type</code>, <code>refresh_token.expiration_type</code>,
43
- * <code>refresh_token.leeway</code>, <code>refresh_token.token_lifetime</code>, <code>refresh_token.policies</code>, <code>organization_usage</code>,
44
- * <code>organization_require_behavior</code>.
45
- * </li>
46
- * <li>
47
- * The following properties can only be retrieved with the
48
- * <code>read:client_keys</code> or <code>read:client_credentials</code> scope:
49
- * <code>encryption_key</code>, <code>encryption_key.pub</code>, <code>encryption_key.cert</code>,
50
- * <code>client_secret</code>, <code>client_authentication_methods</code> and <code>signing_key</code>.
51
- * </li>
52
- * </ul>
21
+ * For more information, read [Applications in Auth0](https://www.auth0.com/docs/get-started/applications) and [Single Sign-On](https://www.auth0.com/docs/authenticate/single-sign-on).
22
+ *
23
+ * - The following can be retrieved with any scope:
24
+ * `client_id`, `app_type`, `name`, and `description`.
25
+ * - The following properties can only be retrieved with the `read:clients` or
26
+ * `read:client_keys` scope:
27
+ * `callbacks`, `oidc_logout`, `allowed_origins`,
28
+ * `web_origins`, `tenant`, `global`, `config_route`,
29
+ * `callback_url_template`, `jwt_configuration`,
30
+ * `jwt_configuration.lifetime_in_seconds`, `jwt_configuration.secret_encoded`,
31
+ * `jwt_configuration.scopes`, `jwt_configuration.alg`, `api_type`,
32
+ * `logo_uri`, `allowed_clients`, `owners`, `custom_login_page`,
33
+ * `custom_login_page_off`, `sso`, `addons`, `form_template`,
34
+ * `custom_login_page_codeview`, `resource_servers`, `client_metadata`,
35
+ * `mobile`, `mobile.android`, `mobile.ios`, `allowed_logout_urls`,
36
+ * `token_endpoint_auth_method`, `is_first_party`, `oidc_conformant`,
37
+ * `is_token_endpoint_ip_header_trusted`, `initiate_login_uri`, `grant_types`,
38
+ * `refresh_token`, `refresh_token.rotation_type`, `refresh_token.expiration_type`,
39
+ * `refresh_token.leeway`, `refresh_token.token_lifetime`, `refresh_token.policies`, `organization_usage`,
40
+ * `organization_require_behavior`.
41
+ * - The following properties can only be retrieved with the
42
+ * `read:client_keys` or `read:client_credentials` scope:
43
+ * `encryption_key`, `encryption_key.pub`, `encryption_key.cert`,
44
+ * `client_secret`, `client_authentication_methods` and `signing_key`.
53
45
  *
54
46
  * @param {Management.ListClientsRequestParameters} request
55
47
  * @param {ClientsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -75,20 +67,20 @@ export declare class ClientsClient {
75
67
  */
76
68
  list(request?: Management.ListClientsRequestParameters, requestOptions?: ClientsClient.RequestOptions): Promise<core.Page<Management.Client, Management.ListClientsOffsetPaginatedResponseContent>>;
77
69
  /**
78
- * Create a new client (application or SSO integration). For more information, read <a href="https://www.auth0.com/docs/get-started/auth0-overview/create-applications">Create Applications</a>
79
- * <a href="https://www.auth0.com/docs/authenticate/single-sign-on/api-endpoints-for-single-sign-on>">API Endpoints for Single Sign-On</a>.
70
+ * Create a new client (application or SSO integration). For more information, read [Create Applications](https://www.auth0.com/docs/get-started/auth0-overview/create-applications)
71
+ * [API Endpoints for Single Sign-On](https://www.auth0.com/docs/authenticate/single-sign-on/api-endpoints-for-single-sign-on).
80
72
  *
81
73
  * Notes:
82
74
  * - We recommend leaving the `client_secret` parameter unspecified to allow the generation of a safe secret.
83
- * - The <code>client_authentication_methods</code> and <code>token_endpoint_auth_method</code> properties are mutually exclusive. Use
84
- * <code>client_authentication_methods</code> to configure the client with Private Key JWT authentication method. Otherwise, use <code>token_endpoint_auth_method</code>
75
+ * - The `client_authentication_methods` and `token_endpoint_auth_method` properties are mutually exclusive. Use
76
+ * `client_authentication_methods` to configure the client with Private Key JWT authentication method. Otherwise, use `token_endpoint_auth_method`
85
77
  * to configure the client with client secret (basic or post) or with no authentication method (none).
86
- * - When using <code>client_authentication_methods</code> to configure the client with Private Key JWT authentication method, specify fully defined credentials.
78
+ * - When using `client_authentication_methods` to configure the client with Private Key JWT authentication method, specify fully defined credentials.
87
79
  * These credentials will be automatically enabled for Private Key JWT authentication on the client.
88
- * - To configure <code>client_authentication_methods</code>, the <code>create:client_credentials</code> scope is required.
89
- * - To configure <code>client_authentication_methods</code>, the property <code>jwt_configuration.alg</code> must be set to RS256.
80
+ * - To configure `client_authentication_methods`, the `create:client_credentials` scope is required.
81
+ * - To configure `client_authentication_methods`, the property `jwt_configuration.alg` must be set to RS256.
90
82
  *
91
- * <div class="alert alert-warning">SSO Integrations created via this endpoint will accept login requests and share user profile information.</div>
83
+ * SSO Integrations created via this endpoint will accept login requests and share user profile information.
92
84
  *
93
85
  * @param {Management.CreateClientRequestContent} request
94
86
  * @param {ClientsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -133,16 +125,14 @@ export declare class ClientsClient {
133
125
  * Idempotent registration for Client ID Metadata Document (CIMD) clients.
134
126
  * Uses external_client_id as the unique identifier for upsert operations.
135
127
  *
136
- * <strong>Create:</strong> Returns 201 when a new client is created (requires <code>create:clients</code> scope).
137
- * <strong>Update:</strong> Returns 200 when an existing client is updated (requires <code>update:clients</code> scope).
128
+ * **Create:** Returns 201 when a new client is created (requires `create:clients` scope).
129
+ * **Update:** Returns 200 when an existing client is updated (requires `update:clients` scope).
138
130
  *
139
131
  * This endpoint automatically:
140
- * <ul>
141
- * <li>Fetches and validates the metadata document</li>
142
- * <li>Maps CIMD fields to Auth0 client configuration</li>
143
- * <li>Creates/rotates credentials from the JWKS</li>
144
- * <li>Enforces CIMD security policies (HTTPS-only, no shared secrets)</li>
145
- * </ul>
132
+ * - Fetches and validates the metadata document
133
+ * - Maps CIMD fields to Auth0 client configuration
134
+ * - Creates/rotates credentials from the JWKS
135
+ * - Enforces CIMD security policies (HTTPS-only, no shared secrets)
146
136
  *
147
137
  * @param {Management.RegisterCimdClientRequestContent} request
148
138
  * @param {ClientsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -162,36 +152,29 @@ export declare class ClientsClient {
162
152
  private __registerCimdClient;
163
153
  /**
164
154
  * Retrieve client details by ID. Clients are SSO connections or Applications linked with your Auth0 tenant. A list of fields to include or exclude may also be specified.
165
- * For more information, read <a href="https://www.auth0.com/docs/get-started/applications"> Applications in Auth0</a> and <a href="https://www.auth0.com/docs/authenticate/single-sign-on"> Single Sign-On</a>.
166
- * <ul>
167
- * <li>
168
- * The following properties can be retrieved with any of the scopes:
169
- * <code>client_id</code>, <code>app_type</code>, <code>name</code>, and <code>description</code>.
170
- * </li>
171
- * <li>
172
- * The following properties can only be retrieved with the <code>read:clients</code> or
173
- * <code>read:client_keys</code> scopes:
174
- * <code>callbacks</code>, <code>oidc_logout</code>, <code>allowed_origins</code>,
175
- * <code>web_origins</code>, <code>tenant</code>, <code>global</code>, <code>config_route</code>,
176
- * <code>callback_url_template</code>, <code>jwt_configuration</code>,
177
- * <code>jwt_configuration.lifetime_in_seconds</code>, <code>jwt_configuration.secret_encoded</code>,
178
- * <code>jwt_configuration.scopes</code>, <code>jwt_configuration.alg</code>, <code>api_type</code>,
179
- * <code>logo_uri</code>, <code>allowed_clients</code>, <code>owners</code>, <code>custom_login_page</code>,
180
- * <code>custom_login_page_off</code>, <code>sso</code>, <code>addons</code>, <code>form_template</code>,
181
- * <code>custom_login_page_codeview</code>, <code>resource_servers</code>, <code>client_metadata</code>,
182
- * <code>mobile</code>, <code>mobile.android</code>, <code>mobile.ios</code>, <code>allowed_logout_urls</code>,
183
- * <code>token_endpoint_auth_method</code>, <code>is_first_party</code>, <code>oidc_conformant</code>,
184
- * <code>is_token_endpoint_ip_header_trusted</code>, <code>initiate_login_uri</code>, <code>grant_types</code>,
185
- * <code>refresh_token</code>, <code>refresh_token.rotation_type</code>, <code>refresh_token.expiration_type</code>,
186
- * <code>refresh_token.leeway</code>, <code>refresh_token.token_lifetime</code>, <code>refresh_token.policies</code>, <code>organization_usage</code>,
187
- * <code>organization_require_behavior</code>.
188
- * </li>
189
- * <li>
190
- * The following properties can only be retrieved with the <code>read:client_keys</code> or <code>read:client_credentials</code> scopes:
191
- * <code>encryption_key</code>, <code>encryption_key.pub</code>, <code>encryption_key.cert</code>,
192
- * <code>client_secret</code>, <code>client_authentication_methods</code> and <code>signing_key</code>.
193
- * </li>
194
- * </ul>
155
+ * For more information, read [Applications in Auth0](https://www.auth0.com/docs/get-started/applications) and [Single Sign-On](https://www.auth0.com/docs/authenticate/single-sign-on).
156
+ *
157
+ * - The following properties can be retrieved with any of the scopes:
158
+ * `client_id`, `app_type`, `name`, and `description`.
159
+ * - The following properties can only be retrieved with the `read:clients` or
160
+ * `read:client_keys` scopes:
161
+ * `callbacks`, `oidc_logout`, `allowed_origins`,
162
+ * `web_origins`, `tenant`, `global`, `config_route`,
163
+ * `callback_url_template`, `jwt_configuration`,
164
+ * `jwt_configuration.lifetime_in_seconds`, `jwt_configuration.secret_encoded`,
165
+ * `jwt_configuration.scopes`, `jwt_configuration.alg`, `api_type`,
166
+ * `logo_uri`, `allowed_clients`, `owners`, `custom_login_page`,
167
+ * `custom_login_page_off`, `sso`, `addons`, `form_template`,
168
+ * `custom_login_page_codeview`, `resource_servers`, `client_metadata`,
169
+ * `mobile`, `mobile.android`, `mobile.ios`, `allowed_logout_urls`,
170
+ * `token_endpoint_auth_method`, `is_first_party`, `oidc_conformant`,
171
+ * `is_token_endpoint_ip_header_trusted`, `initiate_login_uri`, `grant_types`,
172
+ * `refresh_token`, `refresh_token.rotation_type`, `refresh_token.expiration_type`,
173
+ * `refresh_token.leeway`, `refresh_token.token_lifetime`, `refresh_token.policies`, `organization_usage`,
174
+ * `organization_require_behavior`.
175
+ * - The following properties can only be retrieved with the `read:client_keys` or `read:client_credentials` scopes:
176
+ * `encryption_key`, `encryption_key.pub`, `encryption_key.cert`,
177
+ * `client_secret`, `client_authentication_methods` and `signing_key`.
195
178
  *
196
179
  * @param {string} id - ID of the client to retrieve.
197
180
  * @param {Management.GetClientRequestParameters} request
@@ -228,15 +211,15 @@ export declare class ClientsClient {
228
211
  delete(id: string, requestOptions?: ClientsClient.RequestOptions): core.HttpResponsePromise<void>;
229
212
  private __delete;
230
213
  /**
231
- * Updates a client's settings. For more information, read <a href="https://www.auth0.com/docs/get-started/applications"> Applications in Auth0</a> and <a href="https://www.auth0.com/docs/authenticate/single-sign-on"> Single Sign-On</a>.
214
+ * Updates a client's settings. For more information, read [Applications in Auth0](https://www.auth0.com/docs/get-started/applications) and [Single Sign-On](https://www.auth0.com/docs/authenticate/single-sign-on).
232
215
  *
233
216
  * Notes:
234
217
  * - The `client_secret` and `signing_key` attributes can only be updated with the `update:client_keys` scope.
235
- * - The <code>client_authentication_methods</code> and <code>token_endpoint_auth_method</code> properties are mutually exclusive. Use <code>client_authentication_methods</code> to configure the client with Private Key JWT authentication method. Otherwise, use <code>token_endpoint_auth_method</code> to configure the client with client secret (basic or post) or with no authentication method (none).
236
- * - When using <code>client_authentication_methods</code> to configure the client with Private Key JWT authentication method, only specify the credential IDs that were generated when creating the credentials on the client.
237
- * - To configure <code>client_authentication_methods</code>, the <code>update:client_credentials</code> scope is required.
238
- * - To configure <code>client_authentication_methods</code>, the property <code>jwt_configuration.alg</code> must be set to RS256.
239
- * - To change a client's <code>is_first_party</code> property to <code>false</code>, the <code>organization_usage</code> and <code>organization_require_behavior</code> properties must be unset.
218
+ * - The `client_authentication_methods` and `token_endpoint_auth_method` properties are mutually exclusive. Use `client_authentication_methods` to configure the client with Private Key JWT authentication method. Otherwise, use `token_endpoint_auth_method` to configure the client with client secret (basic or post) or with no authentication method (none).
219
+ * - When using `client_authentication_methods` to configure the client with Private Key JWT authentication method, only specify the credential IDs that were generated when creating the credentials on the client.
220
+ * - To configure `client_authentication_methods`, the `update:client_credentials` scope is required.
221
+ * - To configure `client_authentication_methods`, the property `jwt_configuration.alg` must be set to RS256.
222
+ * - To change a client's `is_first_party` property to `false`, the `organization_usage` and `organization_require_behavior` properties must be unset.
240
223
  *
241
224
  * @param {string} id - ID of the client to update.
242
225
  * @param {Management.UpdateClientRequestContent} request
@@ -258,7 +241,7 @@ export declare class ClientsClient {
258
241
  *
259
242
  * This endpoint cannot be used with clients configured with Private Key JWT authentication method (client_authentication_methods configured with private_key_jwt). The generated secret is NOT base64 encoded.
260
243
  *
261
- * For more information, read <a href="https://www.auth0.com/docs/get-started/applications/rotate-client-secret">Rotate Client Secrets</a>.
244
+ * For more information, read [Rotate Client Secrets](https://www.auth0.com/docs/get-started/applications/rotate-client-secret).
262
245
  *
263
246
  * @param {string} id - ID of the client that will rotate secrets.
264
247
  * @param {ClientsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -31,38 +31,30 @@ export class ClientsClient {
31
31
  }
32
32
  /**
33
33
  * Retrieve clients (applications and SSO integrations) matching provided filters. A list of fields to include or exclude may also be specified.
34
- * For more information, read <a href="https://www.auth0.com/docs/get-started/applications"> Applications in Auth0</a> and <a href="https://www.auth0.com/docs/authenticate/single-sign-on"> Single Sign-On</a>.
35
- *
36
- * <ul>
37
- * <li>
38
- * The following can be retrieved with any scope:
39
- * <code>client_id</code>, <code>app_type</code>, <code>name</code>, and <code>description</code>.
40
- * </li>
41
- * <li>
42
- * The following properties can only be retrieved with the <code>read:clients</code> or
43
- * <code>read:client_keys</code> scope:
44
- * <code>callbacks</code>, <code>oidc_logout</code>, <code>allowed_origins</code>,
45
- * <code>web_origins</code>, <code>tenant</code>, <code>global</code>, <code>config_route</code>,
46
- * <code>callback_url_template</code>, <code>jwt_configuration</code>,
47
- * <code>jwt_configuration.lifetime_in_seconds</code>, <code>jwt_configuration.secret_encoded</code>,
48
- * <code>jwt_configuration.scopes</code>, <code>jwt_configuration.alg</code>, <code>api_type</code>,
49
- * <code>logo_uri</code>, <code>allowed_clients</code>, <code>owners</code>, <code>custom_login_page</code>,
50
- * <code>custom_login_page_off</code>, <code>sso</code>, <code>addons</code>, <code>form_template</code>,
51
- * <code>custom_login_page_codeview</code>, <code>resource_servers</code>, <code>client_metadata</code>,
52
- * <code>mobile</code>, <code>mobile.android</code>, <code>mobile.ios</code>, <code>allowed_logout_urls</code>,
53
- * <code>token_endpoint_auth_method</code>, <code>is_first_party</code>, <code>oidc_conformant</code>,
54
- * <code>is_token_endpoint_ip_header_trusted</code>, <code>initiate_login_uri</code>, <code>grant_types</code>,
55
- * <code>refresh_token</code>, <code>refresh_token.rotation_type</code>, <code>refresh_token.expiration_type</code>,
56
- * <code>refresh_token.leeway</code>, <code>refresh_token.token_lifetime</code>, <code>refresh_token.policies</code>, <code>organization_usage</code>,
57
- * <code>organization_require_behavior</code>.
58
- * </li>
59
- * <li>
60
- * The following properties can only be retrieved with the
61
- * <code>read:client_keys</code> or <code>read:client_credentials</code> scope:
62
- * <code>encryption_key</code>, <code>encryption_key.pub</code>, <code>encryption_key.cert</code>,
63
- * <code>client_secret</code>, <code>client_authentication_methods</code> and <code>signing_key</code>.
64
- * </li>
65
- * </ul>
34
+ * For more information, read [Applications in Auth0](https://www.auth0.com/docs/get-started/applications) and [Single Sign-On](https://www.auth0.com/docs/authenticate/single-sign-on).
35
+ *
36
+ * - The following can be retrieved with any scope:
37
+ * `client_id`, `app_type`, `name`, and `description`.
38
+ * - The following properties can only be retrieved with the `read:clients` or
39
+ * `read:client_keys` scope:
40
+ * `callbacks`, `oidc_logout`, `allowed_origins`,
41
+ * `web_origins`, `tenant`, `global`, `config_route`,
42
+ * `callback_url_template`, `jwt_configuration`,
43
+ * `jwt_configuration.lifetime_in_seconds`, `jwt_configuration.secret_encoded`,
44
+ * `jwt_configuration.scopes`, `jwt_configuration.alg`, `api_type`,
45
+ * `logo_uri`, `allowed_clients`, `owners`, `custom_login_page`,
46
+ * `custom_login_page_off`, `sso`, `addons`, `form_template`,
47
+ * `custom_login_page_codeview`, `resource_servers`, `client_metadata`,
48
+ * `mobile`, `mobile.android`, `mobile.ios`, `allowed_logout_urls`,
49
+ * `token_endpoint_auth_method`, `is_first_party`, `oidc_conformant`,
50
+ * `is_token_endpoint_ip_header_trusted`, `initiate_login_uri`, `grant_types`,
51
+ * `refresh_token`, `refresh_token.rotation_type`, `refresh_token.expiration_type`,
52
+ * `refresh_token.leeway`, `refresh_token.token_lifetime`, `refresh_token.policies`, `organization_usage`,
53
+ * `organization_require_behavior`.
54
+ * - The following properties can only be retrieved with the
55
+ * `read:client_keys` or `read:client_credentials` scope:
56
+ * `encryption_key`, `encryption_key.pub`, `encryption_key.cert`,
57
+ * `client_secret`, `client_authentication_methods` and `signing_key`.
66
58
  *
67
59
  * @param {Management.ListClientsRequestParameters} request
68
60
  * @param {ClientsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -161,20 +153,20 @@ export class ClientsClient {
161
153
  });
162
154
  }
163
155
  /**
164
- * Create a new client (application or SSO integration). For more information, read <a href="https://www.auth0.com/docs/get-started/auth0-overview/create-applications">Create Applications</a>
165
- * <a href="https://www.auth0.com/docs/authenticate/single-sign-on/api-endpoints-for-single-sign-on>">API Endpoints for Single Sign-On</a>.
156
+ * Create a new client (application or SSO integration). For more information, read [Create Applications](https://www.auth0.com/docs/get-started/auth0-overview/create-applications)
157
+ * [API Endpoints for Single Sign-On](https://www.auth0.com/docs/authenticate/single-sign-on/api-endpoints-for-single-sign-on).
166
158
  *
167
159
  * Notes:
168
160
  * - We recommend leaving the `client_secret` parameter unspecified to allow the generation of a safe secret.
169
- * - The <code>client_authentication_methods</code> and <code>token_endpoint_auth_method</code> properties are mutually exclusive. Use
170
- * <code>client_authentication_methods</code> to configure the client with Private Key JWT authentication method. Otherwise, use <code>token_endpoint_auth_method</code>
161
+ * - The `client_authentication_methods` and `token_endpoint_auth_method` properties are mutually exclusive. Use
162
+ * `client_authentication_methods` to configure the client with Private Key JWT authentication method. Otherwise, use `token_endpoint_auth_method`
171
163
  * to configure the client with client secret (basic or post) or with no authentication method (none).
172
- * - When using <code>client_authentication_methods</code> to configure the client with Private Key JWT authentication method, specify fully defined credentials.
164
+ * - When using `client_authentication_methods` to configure the client with Private Key JWT authentication method, specify fully defined credentials.
173
165
  * These credentials will be automatically enabled for Private Key JWT authentication on the client.
174
- * - To configure <code>client_authentication_methods</code>, the <code>create:client_credentials</code> scope is required.
175
- * - To configure <code>client_authentication_methods</code>, the property <code>jwt_configuration.alg</code> must be set to RS256.
166
+ * - To configure `client_authentication_methods`, the `create:client_credentials` scope is required.
167
+ * - To configure `client_authentication_methods`, the property `jwt_configuration.alg` must be set to RS256.
176
168
  *
177
- * <div class="alert alert-warning">SSO Integrations created via this endpoint will accept login requests and share user profile information.</div>
169
+ * SSO Integrations created via this endpoint will accept login requests and share user profile information.
178
170
  *
179
171
  * @param {Management.CreateClientRequestContent} request
180
172
  * @param {ClientsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -317,16 +309,14 @@ export class ClientsClient {
317
309
  * Idempotent registration for Client ID Metadata Document (CIMD) clients.
318
310
  * Uses external_client_id as the unique identifier for upsert operations.
319
311
  *
320
- * <strong>Create:</strong> Returns 201 when a new client is created (requires <code>create:clients</code> scope).
321
- * <strong>Update:</strong> Returns 200 when an existing client is updated (requires <code>update:clients</code> scope).
312
+ * **Create:** Returns 201 when a new client is created (requires `create:clients` scope).
313
+ * **Update:** Returns 200 when an existing client is updated (requires `update:clients` scope).
322
314
  *
323
315
  * This endpoint automatically:
324
- * <ul>
325
- * <li>Fetches and validates the metadata document</li>
326
- * <li>Maps CIMD fields to Auth0 client configuration</li>
327
- * <li>Creates/rotates credentials from the JWKS</li>
328
- * <li>Enforces CIMD security policies (HTTPS-only, no shared secrets)</li>
329
- * </ul>
316
+ * - Fetches and validates the metadata document
317
+ * - Maps CIMD fields to Auth0 client configuration
318
+ * - Creates/rotates credentials from the JWKS
319
+ * - Enforces CIMD security policies (HTTPS-only, no shared secrets)
330
320
  *
331
321
  * @param {Management.RegisterCimdClientRequestContent} request
332
322
  * @param {ClientsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -395,36 +385,29 @@ export class ClientsClient {
395
385
  }
396
386
  /**
397
387
  * Retrieve client details by ID. Clients are SSO connections or Applications linked with your Auth0 tenant. A list of fields to include or exclude may also be specified.
398
- * For more information, read <a href="https://www.auth0.com/docs/get-started/applications"> Applications in Auth0</a> and <a href="https://www.auth0.com/docs/authenticate/single-sign-on"> Single Sign-On</a>.
399
- * <ul>
400
- * <li>
401
- * The following properties can be retrieved with any of the scopes:
402
- * <code>client_id</code>, <code>app_type</code>, <code>name</code>, and <code>description</code>.
403
- * </li>
404
- * <li>
405
- * The following properties can only be retrieved with the <code>read:clients</code> or
406
- * <code>read:client_keys</code> scopes:
407
- * <code>callbacks</code>, <code>oidc_logout</code>, <code>allowed_origins</code>,
408
- * <code>web_origins</code>, <code>tenant</code>, <code>global</code>, <code>config_route</code>,
409
- * <code>callback_url_template</code>, <code>jwt_configuration</code>,
410
- * <code>jwt_configuration.lifetime_in_seconds</code>, <code>jwt_configuration.secret_encoded</code>,
411
- * <code>jwt_configuration.scopes</code>, <code>jwt_configuration.alg</code>, <code>api_type</code>,
412
- * <code>logo_uri</code>, <code>allowed_clients</code>, <code>owners</code>, <code>custom_login_page</code>,
413
- * <code>custom_login_page_off</code>, <code>sso</code>, <code>addons</code>, <code>form_template</code>,
414
- * <code>custom_login_page_codeview</code>, <code>resource_servers</code>, <code>client_metadata</code>,
415
- * <code>mobile</code>, <code>mobile.android</code>, <code>mobile.ios</code>, <code>allowed_logout_urls</code>,
416
- * <code>token_endpoint_auth_method</code>, <code>is_first_party</code>, <code>oidc_conformant</code>,
417
- * <code>is_token_endpoint_ip_header_trusted</code>, <code>initiate_login_uri</code>, <code>grant_types</code>,
418
- * <code>refresh_token</code>, <code>refresh_token.rotation_type</code>, <code>refresh_token.expiration_type</code>,
419
- * <code>refresh_token.leeway</code>, <code>refresh_token.token_lifetime</code>, <code>refresh_token.policies</code>, <code>organization_usage</code>,
420
- * <code>organization_require_behavior</code>.
421
- * </li>
422
- * <li>
423
- * The following properties can only be retrieved with the <code>read:client_keys</code> or <code>read:client_credentials</code> scopes:
424
- * <code>encryption_key</code>, <code>encryption_key.pub</code>, <code>encryption_key.cert</code>,
425
- * <code>client_secret</code>, <code>client_authentication_methods</code> and <code>signing_key</code>.
426
- * </li>
427
- * </ul>
388
+ * For more information, read [Applications in Auth0](https://www.auth0.com/docs/get-started/applications) and [Single Sign-On](https://www.auth0.com/docs/authenticate/single-sign-on).
389
+ *
390
+ * - The following properties can be retrieved with any of the scopes:
391
+ * `client_id`, `app_type`, `name`, and `description`.
392
+ * - The following properties can only be retrieved with the `read:clients` or
393
+ * `read:client_keys` scopes:
394
+ * `callbacks`, `oidc_logout`, `allowed_origins`,
395
+ * `web_origins`, `tenant`, `global`, `config_route`,
396
+ * `callback_url_template`, `jwt_configuration`,
397
+ * `jwt_configuration.lifetime_in_seconds`, `jwt_configuration.secret_encoded`,
398
+ * `jwt_configuration.scopes`, `jwt_configuration.alg`, `api_type`,
399
+ * `logo_uri`, `allowed_clients`, `owners`, `custom_login_page`,
400
+ * `custom_login_page_off`, `sso`, `addons`, `form_template`,
401
+ * `custom_login_page_codeview`, `resource_servers`, `client_metadata`,
402
+ * `mobile`, `mobile.android`, `mobile.ios`, `allowed_logout_urls`,
403
+ * `token_endpoint_auth_method`, `is_first_party`, `oidc_conformant`,
404
+ * `is_token_endpoint_ip_header_trusted`, `initiate_login_uri`, `grant_types`,
405
+ * `refresh_token`, `refresh_token.rotation_type`, `refresh_token.expiration_type`,
406
+ * `refresh_token.leeway`, `refresh_token.token_lifetime`, `refresh_token.policies`, `organization_usage`,
407
+ * `organization_require_behavior`.
408
+ * - The following properties can only be retrieved with the `read:client_keys` or `read:client_credentials` scopes:
409
+ * `encryption_key`, `encryption_key.pub`, `encryption_key.cert`,
410
+ * `client_secret`, `client_authentication_methods` and `signing_key`.
428
411
  *
429
412
  * @param {string} id - ID of the client to retrieve.
430
413
  * @param {Management.GetClientRequestParameters} request
@@ -554,15 +537,15 @@ export class ClientsClient {
554
537
  });
555
538
  }
556
539
  /**
557
- * Updates a client's settings. For more information, read <a href="https://www.auth0.com/docs/get-started/applications"> Applications in Auth0</a> and <a href="https://www.auth0.com/docs/authenticate/single-sign-on"> Single Sign-On</a>.
540
+ * Updates a client's settings. For more information, read [Applications in Auth0](https://www.auth0.com/docs/get-started/applications) and [Single Sign-On](https://www.auth0.com/docs/authenticate/single-sign-on).
558
541
  *
559
542
  * Notes:
560
543
  * - The `client_secret` and `signing_key` attributes can only be updated with the `update:client_keys` scope.
561
- * - The <code>client_authentication_methods</code> and <code>token_endpoint_auth_method</code> properties are mutually exclusive. Use <code>client_authentication_methods</code> to configure the client with Private Key JWT authentication method. Otherwise, use <code>token_endpoint_auth_method</code> to configure the client with client secret (basic or post) or with no authentication method (none).
562
- * - When using <code>client_authentication_methods</code> to configure the client with Private Key JWT authentication method, only specify the credential IDs that were generated when creating the credentials on the client.
563
- * - To configure <code>client_authentication_methods</code>, the <code>update:client_credentials</code> scope is required.
564
- * - To configure <code>client_authentication_methods</code>, the property <code>jwt_configuration.alg</code> must be set to RS256.
565
- * - To change a client's <code>is_first_party</code> property to <code>false</code>, the <code>organization_usage</code> and <code>organization_require_behavior</code> properties must be unset.
544
+ * - The `client_authentication_methods` and `token_endpoint_auth_method` properties are mutually exclusive. Use `client_authentication_methods` to configure the client with Private Key JWT authentication method. Otherwise, use `token_endpoint_auth_method` to configure the client with client secret (basic or post) or with no authentication method (none).
545
+ * - When using `client_authentication_methods` to configure the client with Private Key JWT authentication method, only specify the credential IDs that were generated when creating the credentials on the client.
546
+ * - To configure `client_authentication_methods`, the `update:client_credentials` scope is required.
547
+ * - To configure `client_authentication_methods`, the property `jwt_configuration.alg` must be set to RS256.
548
+ * - To change a client's `is_first_party` property to `false`, the `organization_usage` and `organization_require_behavior` properties must be unset.
566
549
  *
567
550
  * @param {string} id - ID of the client to update.
568
551
  * @param {Management.UpdateClientRequestContent} request
@@ -633,7 +616,7 @@ export class ClientsClient {
633
616
  *
634
617
  * This endpoint cannot be used with clients configured with Private Key JWT authentication method (client_authentication_methods configured with private_key_jwt). The generated secret is NOT base64 encoded.
635
618
  *
636
- * For more information, read <a href="https://www.auth0.com/docs/get-started/applications/rotate-client-secret">Rotate Client Secrets</a>.
619
+ * For more information, read [Rotate Client Secrets](https://www.auth0.com/docs/get-started/applications/rotate-client-secret).
637
620
  *
638
621
  * @param {string} id - ID of the client that will rotate secrets.
639
622
  * @param {ClientsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -11,15 +11,10 @@ export declare class ConnectionsClient {
11
11
  protected readonly _options: NormalizedClientOptionsWithAuth<ConnectionsClient.Options>;
12
12
  constructor(options: ConnectionsClient.Options);
13
13
  /**
14
- * Retrieve all connections that are enabled for the specified <a href="https://www.auth0.com/docs/get-started/applications"> Application</a>, using checkpoint pagination. A list of fields to include or exclude for each connection may also be specified.
15
- * <ul>
16
- * <li>
17
- * This endpoint requires the <code>read:connections</code> scope and any one of <code>read:clients</code> or <code>read:client_summary</code>.
18
- * </li>
19
- * <li>
20
- * <b>Note</b>: The first time you call this endpoint, omit the <code>from</code> parameter. If there are more results, a <code>next</code> value is included in the response. You can use this for subsequent API calls. When <code>next</code> is no longer included in the response, no further results are remaining.
21
- * </li>
22
- * </ul>
14
+ * Retrieve all connections that are enabled for the specified [Application](https://www.auth0.com/docs/get-started/applications), using checkpoint pagination. A list of fields to include or exclude for each connection may also be specified.
15
+ *
16
+ * - This endpoint requires the `read:connections` scope and any one of `read:clients` or `read:client_summary`.
17
+ * - **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.
23
18
  *
24
19
  * @param {string} id - ID of the client for which to retrieve enabled connections.
25
20
  * @param {Management.ConnectionsGetRequest} request
@@ -20,15 +20,10 @@ export class ConnectionsClient {
20
20
  this._options = normalizeClientOptionsWithAuth(options);
21
21
  }
22
22
  /**
23
- * Retrieve all connections that are enabled for the specified <a href="https://www.auth0.com/docs/get-started/applications"> Application</a>, using checkpoint pagination. A list of fields to include or exclude for each connection may also be specified.
24
- * <ul>
25
- * <li>
26
- * This endpoint requires the <code>read:connections</code> scope and any one of <code>read:clients</code> or <code>read:client_summary</code>.
27
- * </li>
28
- * <li>
29
- * <b>Note</b>: The first time you call this endpoint, omit the <code>from</code> parameter. If there are more results, a <code>next</code> value is included in the response. You can use this for subsequent API calls. When <code>next</code> is no longer included in the response, no further results are remaining.
30
- * </li>
31
- * </ul>
23
+ * Retrieve all connections that are enabled for the specified [Application](https://www.auth0.com/docs/get-started/applications), using checkpoint pagination. A list of fields to include or exclude for each connection may also be specified.
24
+ *
25
+ * - This endpoint requires the `read:connections` scope and any one of `read:clients` or `read:client_summary`.
26
+ * - **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.
32
27
  *
33
28
  * @param {string} id - ID of the client for which to retrieve enabled connections.
34
29
  * @param {Management.ConnectionsGetRequest} request
@@ -13,7 +13,7 @@ export declare class CredentialsClient {
13
13
  /**
14
14
  * Get the details of a client credential.
15
15
  *
16
- * <b>Important</b>: To enable credentials to be used for a client authentication method, set the <code>client_authentication_methods</code> property on the client. To enable credentials to be used for JWT-Secured Authorization requests set the <code>signed_request_object</code> property on the client.
16
+ * **Important**: To enable credentials to be used for a client authentication method, set the `client_authentication_methods` property on the client. To enable credentials to be used for JWT-Secured Authorization requests set the `signed_request_object` property on the client.
17
17
  *
18
18
  * @param {string} client_id - ID of the client.
19
19
  * @param {CredentialsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -31,37 +31,61 @@ export declare class CredentialsClient {
31
31
  /**
32
32
  * Create a client credential associated to your application. Credentials can be used to configure Private Key JWT and mTLS authentication methods, as well as for JWT-secured Authorization requests.
33
33
  *
34
- * <h5>Public Key</h5>Public Key credentials can be used to set up Private Key JWT client authentication and JWT-secured Authorization requests.
34
+ * **Public Key**
35
35
  *
36
- * Sample: <pre><code>{
36
+ * Public Key credentials can be used to set up Private Key JWT client authentication and JWT-secured Authorization requests.
37
+ *
38
+ * Sample:
39
+ *
40
+ * ```json
41
+ * {
37
42
  * "credential_type": "public_key",
38
43
  * "name": "string",
39
44
  * "pem": "string",
40
45
  * "alg": "RS256",
41
46
  * "parse_expiry_from_cert": false,
42
47
  * "expires_at": "2022-12-31T23:59:59Z"
43
- * }</code></pre>
44
- * <h5>Certificate (CA-signed & self-signed)</h5>Certificate credentials can be used to set up mTLS client authentication. CA-signed certificates can be configured either with a signed certificate or with just the certificate Subject DN.
48
+ * }
49
+ * ```
50
+ *
51
+ * **Certificate (CA-signed & self-signed)**
52
+ *
53
+ * Certificate credentials can be used to set up mTLS client authentication. CA-signed certificates can be configured either with a signed certificate or with just the certificate Subject DN.
54
+ *
55
+ * CA-signed Certificate Sample (pem):
45
56
  *
46
- * CA-signed Certificate Sample (pem): <pre><code>{
57
+ * ```json
58
+ * {
47
59
  * "credential_type": "x509_cert",
48
60
  * "name": "string",
49
61
  * "pem": "string"
50
- * }</code></pre>CA-signed Certificate Sample (subject_dn): <pre><code>{
62
+ * }
63
+ * ```
64
+ *
65
+ * CA-signed Certificate Sample (subject_dn):
66
+ *
67
+ * ```json
68
+ * {
51
69
  * "credential_type": "cert_subject_dn",
52
70
  * "name": "string",
53
71
  * "subject_dn": "string"
54
- * }</code></pre>Self-signed Certificate Sample: <pre><code>{
72
+ * }
73
+ * ```
74
+ *
75
+ * Self-signed Certificate Sample:
76
+ *
77
+ * ```json
78
+ * {
55
79
  * "credential_type": "cert_subject_dn",
56
80
  * "name": "string",
57
81
  * "pem": "string"
58
- * }</code></pre>
82
+ * }
83
+ * ```
59
84
  *
60
85
  * The credential will be created but not yet enabled for use until you set the corresponding properties in the client:
61
- * <ul>
62
- * <li>To enable the credential for Private Key JWT or mTLS authentication methods, set the <code>client_authentication_methods</code> property on the client. For more information, read <a href="https://auth0.com/docs/get-started/applications/configure-private-key-jwt">Configure Private Key JWT Authentication</a> and <a href="https://auth0.com/docs/get-started/applications/configure-mtls">Configure mTLS Authentication</a></li>
63
- * <li>To enable the credential for JWT-secured Authorization requests, set the <code>signed_request_object</code>property on the client. For more information, read <a href="https://auth0.com/docs/get-started/applications/configure-jar">Configure JWT-secured Authorization Requests (JAR)</a></li>
64
- * </ul>
86
+ *
87
+ * - To enable the credential for Private Key JWT or mTLS authentication methods, set the `client_authentication_methods` property on the client. For more information, read [Configure Private Key JWT Authentication](https://auth0.com/docs/get-started/applications/configure-private-key-jwt) and [Configure mTLS Authentication](https://auth0.com/docs/get-started/applications/configure-mtls)
88
+ * - To enable the credential for JWT-secured Authorization requests, set the `signed_request_object`property on the client. For more information, read [Configure JWT-secured Authorization Requests (JAR)](https://auth0.com/docs/get-started/applications/configure-jar)
65
89
  *
66
90
  * @param {string} client_id - ID of the client.
67
91
  * @param {Management.PostClientCredentialRequestContent} request
@@ -83,7 +107,7 @@ export declare class CredentialsClient {
83
107
  /**
84
108
  * Get the details of a client credential.
85
109
  *
86
- * <b>Important</b>: To enable credentials to be used for a client authentication method, set the <code>client_authentication_methods</code> property on the client. To enable credentials to be used for JWT-Secured Authorization requests set the <code>signed_request_object</code> property on the client.
110
+ * **Important**: To enable credentials to be used for a client authentication method, set the `client_authentication_methods` property on the client. To enable credentials to be used for JWT-Secured Authorization requests set the `signed_request_object` property on the client.
87
111
  *
88
112
  * @param {string} client_id - ID of the client.
89
113
  * @param {string} credential_id - ID of the credential.