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
package/reference.md CHANGED
@@ -640,7 +640,7 @@ await client.branding.update();
640
640
  <dl>
641
641
  <dd>
642
642
 
643
- Retrieve a list of <a href="https://auth0.com/docs/get-started/applications/application-access-to-apis-client-grants">client grants</a>, including the scopes associated with the application/API pair.
643
+ Retrieve a list of [client grants](https://auth0.com/docs/get-started/applications/application-access-to-apis-client-grants), including the scopes associated with the application/API pair.
644
644
 
645
645
  </dd>
646
646
  </dl>
@@ -731,7 +731,7 @@ const response = page.response;
731
731
  <dl>
732
732
  <dd>
733
733
 
734
- Create a client grant for a machine-to-machine login flow. To learn more, read <a href="https://www.auth0.com/docs/get-started/authentication-and-authorization-flow/client-credentials-flow">Client Credential Flow</a>.
734
+ Create a client grant for a machine-to-machine login flow. To learn more, read [Client Credential Flow](https://www.auth0.com/docs/get-started/authentication-and-authorization-flow/client-credentials-flow).
735
735
 
736
736
  </dd>
737
737
  </dl>
@@ -796,7 +796,7 @@ await client.clientGrants.create({
796
796
  <dl>
797
797
  <dd>
798
798
 
799
- Retrieve a single <a href="https://auth0.com/docs/get-started/applications/application-access-to-apis-client-grants">client grant</a>, including the
799
+ Retrieve a single [client grant](https://auth0.com/docs/get-started/applications/application-access-to-apis-client-grants), including the
800
800
  scopes associated with the application/API pair.
801
801
 
802
802
  </dd>
@@ -860,7 +860,7 @@ await client.clientGrants.get("id");
860
860
  <dl>
861
861
  <dd>
862
862
 
863
- Delete the <a href="https://www.auth0.com/docs/get-started/authentication-and-authorization-flow/client-credentials-flow">Client Credential Flow</a> from your machine-to-machine application.
863
+ Delete the [Client Credential Flow](https://www.auth0.com/docs/get-started/authentication-and-authorization-flow/client-credentials-flow) from your machine-to-machine application.
864
864
 
865
865
  </dd>
866
866
  </dl>
@@ -997,42 +997,34 @@ await client.clientGrants.update("id");
997
997
  <dd>
998
998
 
999
999
  Retrieve clients (applications and SSO integrations) matching provided filters. A list of fields to include or exclude may also be specified.
1000
- 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>.
1001
-
1002
- <ul>
1003
- <li>
1004
- The following can be retrieved with any scope:
1005
- <code>client_id</code>, <code>app_type</code>, <code>name</code>, and <code>description</code>.
1006
- </li>
1007
- <li>
1008
- The following properties can only be retrieved with the <code>read:clients</code> or
1009
- <code>read:client_keys</code> scope:
1010
- <code>callbacks</code>, <code>oidc_logout</code>, <code>allowed_origins</code>,
1011
- <code>web_origins</code>, <code>tenant</code>, <code>global</code>, <code>config_route</code>,
1012
- <code>callback_url_template</code>, <code>jwt_configuration</code>,
1013
- <code>jwt_configuration.lifetime_in_seconds</code>, <code>jwt_configuration.secret_encoded</code>,
1014
- <code>jwt_configuration.scopes</code>, <code>jwt_configuration.alg</code>, <code>api_type</code>,
1015
- <code>logo_uri</code>, <code>allowed_clients</code>, <code>owners</code>, <code>custom_login_page</code>,
1016
- <code>custom_login_page_off</code>, <code>sso</code>, <code>addons</code>, <code>form_template</code>,
1017
- <code>custom_login_page_codeview</code>, <code>resource_servers</code>, <code>client_metadata</code>,
1018
- <code>mobile</code>, <code>mobile.android</code>, <code>mobile.ios</code>, <code>allowed_logout_urls</code>,
1019
- <code>token_endpoint_auth_method</code>, <code>is_first_party</code>, <code>oidc_conformant</code>,
1020
- <code>is_token_endpoint_ip_header_trusted</code>, <code>initiate_login_uri</code>, <code>grant_types</code>,
1021
- <code>refresh_token</code>, <code>refresh_token.rotation_type</code>, <code>refresh_token.expiration_type</code>,
1022
- <code>refresh_token.leeway</code>, <code>refresh_token.token_lifetime</code>, <code>refresh_token.policies</code>, <code>organization_usage</code>,
1023
- <code>organization_require_behavior</code>.
1024
- </li>
1025
- <li>
1026
- The following properties can only be retrieved with the
1027
- <code>read:client_keys</code> or <code>read:client_credentials</code> scope:
1028
- <code>encryption_key</code>, <code>encryption_key.pub</code>, <code>encryption_key.cert</code>,
1029
- <code>client_secret</code>, <code>client_authentication_methods</code> and <code>signing_key</code>.
1030
- </li>
1031
- </ul>
1032
- </dd>
1033
- </dl>
1034
- </dd>
1035
- </dl>
1000
+ 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).
1001
+
1002
+ - The following can be retrieved with any scope:
1003
+ `client_id`, `app_type`, `name`, and `description`.
1004
+ - The following properties can only be retrieved with the `read:clients` or
1005
+ `read:client_keys` scope:
1006
+ `callbacks`, `oidc_logout`, `allowed_origins`,
1007
+ `web_origins`, `tenant`, `global`, `config_route`,
1008
+ `callback_url_template`, `jwt_configuration`,
1009
+ `jwt_configuration.lifetime_in_seconds`, `jwt_configuration.secret_encoded`,
1010
+ `jwt_configuration.scopes`, `jwt_configuration.alg`, `api_type`,
1011
+ `logo_uri`, `allowed_clients`, `owners`, `custom_login_page`,
1012
+ `custom_login_page_off`, `sso`, `addons`, `form_template`,
1013
+ `custom_login_page_codeview`, `resource_servers`, `client_metadata`,
1014
+ `mobile`, `mobile.android`, `mobile.ios`, `allowed_logout_urls`,
1015
+ `token_endpoint_auth_method`, `is_first_party`, `oidc_conformant`,
1016
+ `is_token_endpoint_ip_header_trusted`, `initiate_login_uri`, `grant_types`,
1017
+ `refresh_token`, `refresh_token.rotation_type`, `refresh_token.expiration_type`,
1018
+ `refresh_token.leeway`, `refresh_token.token_lifetime`, `refresh_token.policies`, `organization_usage`,
1019
+ `organization_require_behavior`.
1020
+ - The following properties can only be retrieved with the
1021
+ `read:client_keys` or `read:client_credentials` scope:
1022
+ `encryption_key`, `encryption_key.pub`, `encryption_key.cert`,
1023
+ `client_secret`, `client_authentication_methods` and `signing_key`.
1024
+ </dd>
1025
+ </dl>
1026
+ </dd>
1027
+ </dl>
1036
1028
 
1037
1029
  #### 🔌 Usage
1038
1030
 
@@ -1124,21 +1116,22 @@ const response = page.response;
1124
1116
  <dl>
1125
1117
  <dd>
1126
1118
 
1127
- 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>
1128
- <a href="https://www.auth0.com/docs/authenticate/single-sign-on/api-endpoints-for-single-sign-on>">API Endpoints for Single Sign-On</a>.
1119
+ 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)
1120
+ [API Endpoints for Single Sign-On](https://www.auth0.com/docs/authenticate/single-sign-on/api-endpoints-for-single-sign-on).
1129
1121
 
1130
1122
  Notes:
1131
1123
 
1132
1124
  - We recommend leaving the `client_secret` parameter unspecified to allow the generation of a safe secret.
1133
- - The <code>client_authentication_methods</code> and <code>token_endpoint_auth_method</code> properties are mutually exclusive. Use
1134
- <code>client_authentication_methods</code> to configure the client with Private Key JWT authentication method. Otherwise, use <code>token_endpoint_auth_method</code>
1125
+ - The `client_authentication_methods` and `token_endpoint_auth_method` properties are mutually exclusive. Use
1126
+ `client_authentication_methods` to configure the client with Private Key JWT authentication method. Otherwise, use `token_endpoint_auth_method`
1135
1127
  to configure the client with client secret (basic or post) or with no authentication method (none).
1136
- - When using <code>client_authentication_methods</code> to configure the client with Private Key JWT authentication method, specify fully defined credentials.
1128
+ - When using `client_authentication_methods` to configure the client with Private Key JWT authentication method, specify fully defined credentials.
1137
1129
  These credentials will be automatically enabled for Private Key JWT authentication on the client.
1138
- - To configure <code>client_authentication_methods</code>, the <code>create:client_credentials</code> scope is required.
1139
- - To configure <code>client_authentication_methods</code>, the property <code>jwt_configuration.alg</code> must be set to RS256.
1130
+ - To configure `client_authentication_methods`, the `create:client_credentials` scope is required.
1131
+ - To configure `client_authentication_methods`, the property `jwt_configuration.alg` must be set to RS256.
1132
+
1133
+ SSO Integrations created via this endpoint will accept login requests and share user profile information.
1140
1134
 
1141
- <div class="alert alert-warning">SSO Integrations created via this endpoint will accept login requests and share user profile information.</div>
1142
1135
  </dd>
1143
1136
  </dl>
1144
1137
  </dd>
@@ -1272,21 +1265,19 @@ await client.clients.previewCimdMetadata({
1272
1265
  Idempotent registration for Client ID Metadata Document (CIMD) clients.
1273
1266
  Uses external_client_id as the unique identifier for upsert operations.
1274
1267
 
1275
- <strong>Create:</strong> Returns 201 when a new client is created (requires <code>create:clients</code> scope).
1276
- <strong>Update:</strong> Returns 200 when an existing client is updated (requires <code>update:clients</code> scope).
1268
+ **Create:** Returns 201 when a new client is created (requires `create:clients` scope).
1269
+ **Update:** Returns 200 when an existing client is updated (requires `update:clients` scope).
1277
1270
 
1278
1271
  This endpoint automatically:
1279
1272
 
1280
- <ul>
1281
- <li>Fetches and validates the metadata document</li>
1282
- <li>Maps CIMD fields to Auth0 client configuration</li>
1283
- <li>Creates/rotates credentials from the JWKS</li>
1284
- <li>Enforces CIMD security policies (HTTPS-only, no shared secrets)</li>
1285
- </ul>
1286
- </dd>
1287
- </dl>
1288
- </dd>
1289
- </dl>
1273
+ - Fetches and validates the metadata document
1274
+ - Maps CIMD fields to Auth0 client configuration
1275
+ - Creates/rotates credentials from the JWKS
1276
+ - Enforces CIMD security policies (HTTPS-only, no shared secrets)
1277
+ </dd>
1278
+ </dl>
1279
+ </dd>
1280
+ </dl>
1290
1281
 
1291
1282
  #### 🔌 Usage
1292
1283
 
@@ -1347,41 +1338,33 @@ await client.clients.registerCimdClient({
1347
1338
  <dd>
1348
1339
 
1349
1340
  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.
1350
- 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>.
1351
-
1352
- <ul>
1353
- <li>
1354
- The following properties can be retrieved with any of the scopes:
1355
- <code>client_id</code>, <code>app_type</code>, <code>name</code>, and <code>description</code>.
1356
- </li>
1357
- <li>
1358
- The following properties can only be retrieved with the <code>read:clients</code> or
1359
- <code>read:client_keys</code> scopes:
1360
- <code>callbacks</code>, <code>oidc_logout</code>, <code>allowed_origins</code>,
1361
- <code>web_origins</code>, <code>tenant</code>, <code>global</code>, <code>config_route</code>,
1362
- <code>callback_url_template</code>, <code>jwt_configuration</code>,
1363
- <code>jwt_configuration.lifetime_in_seconds</code>, <code>jwt_configuration.secret_encoded</code>,
1364
- <code>jwt_configuration.scopes</code>, <code>jwt_configuration.alg</code>, <code>api_type</code>,
1365
- <code>logo_uri</code>, <code>allowed_clients</code>, <code>owners</code>, <code>custom_login_page</code>,
1366
- <code>custom_login_page_off</code>, <code>sso</code>, <code>addons</code>, <code>form_template</code>,
1367
- <code>custom_login_page_codeview</code>, <code>resource_servers</code>, <code>client_metadata</code>,
1368
- <code>mobile</code>, <code>mobile.android</code>, <code>mobile.ios</code>, <code>allowed_logout_urls</code>,
1369
- <code>token_endpoint_auth_method</code>, <code>is_first_party</code>, <code>oidc_conformant</code>,
1370
- <code>is_token_endpoint_ip_header_trusted</code>, <code>initiate_login_uri</code>, <code>grant_types</code>,
1371
- <code>refresh_token</code>, <code>refresh_token.rotation_type</code>, <code>refresh_token.expiration_type</code>,
1372
- <code>refresh_token.leeway</code>, <code>refresh_token.token_lifetime</code>, <code>refresh_token.policies</code>, <code>organization_usage</code>,
1373
- <code>organization_require_behavior</code>.
1374
- </li>
1375
- <li>
1376
- The following properties can only be retrieved with the <code>read:client_keys</code> or <code>read:client_credentials</code> scopes:
1377
- <code>encryption_key</code>, <code>encryption_key.pub</code>, <code>encryption_key.cert</code>,
1378
- <code>client_secret</code>, <code>client_authentication_methods</code> and <code>signing_key</code>.
1379
- </li>
1380
- </ul>
1381
- </dd>
1382
- </dl>
1383
- </dd>
1384
- </dl>
1341
+ 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).
1342
+
1343
+ - The following properties can be retrieved with any of the scopes:
1344
+ `client_id`, `app_type`, `name`, and `description`.
1345
+ - The following properties can only be retrieved with the `read:clients` or
1346
+ `read:client_keys` scopes:
1347
+ `callbacks`, `oidc_logout`, `allowed_origins`,
1348
+ `web_origins`, `tenant`, `global`, `config_route`,
1349
+ `callback_url_template`, `jwt_configuration`,
1350
+ `jwt_configuration.lifetime_in_seconds`, `jwt_configuration.secret_encoded`,
1351
+ `jwt_configuration.scopes`, `jwt_configuration.alg`, `api_type`,
1352
+ `logo_uri`, `allowed_clients`, `owners`, `custom_login_page`,
1353
+ `custom_login_page_off`, `sso`, `addons`, `form_template`,
1354
+ `custom_login_page_codeview`, `resource_servers`, `client_metadata`,
1355
+ `mobile`, `mobile.android`, `mobile.ios`, `allowed_logout_urls`,
1356
+ `token_endpoint_auth_method`, `is_first_party`, `oidc_conformant`,
1357
+ `is_token_endpoint_ip_header_trusted`, `initiate_login_uri`, `grant_types`,
1358
+ `refresh_token`, `refresh_token.rotation_type`, `refresh_token.expiration_type`,
1359
+ `refresh_token.leeway`, `refresh_token.token_lifetime`, `refresh_token.policies`, `organization_usage`,
1360
+ `organization_require_behavior`.
1361
+ - The following properties can only be retrieved with the `read:client_keys` or `read:client_credentials` scopes:
1362
+ `encryption_key`, `encryption_key.pub`, `encryption_key.cert`,
1363
+ `client_secret`, `client_authentication_methods` and `signing_key`.
1364
+ </dd>
1365
+ </dl>
1366
+ </dd>
1367
+ </dl>
1385
1368
 
1386
1369
  #### 🔌 Usage
1387
1370
 
@@ -1513,16 +1496,16 @@ await client.clients.delete("id");
1513
1496
  <dl>
1514
1497
  <dd>
1515
1498
 
1516
- 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>.
1499
+ 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).
1517
1500
 
1518
1501
  Notes:
1519
1502
 
1520
1503
  - The `client_secret` and `signing_key` attributes can only be updated with the `update:client_keys` scope.
1521
- - 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).
1522
- - 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.
1523
- - To configure <code>client_authentication_methods</code>, the <code>update:client_credentials</code> scope is required.
1524
- - To configure <code>client_authentication_methods</code>, the property <code>jwt_configuration.alg</code> must be set to RS256.
1525
- - 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.
1504
+ - 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).
1505
+ - 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.
1506
+ - To configure `client_authentication_methods`, the `update:client_credentials` scope is required.
1507
+ - To configure `client_authentication_methods`, the property `jwt_configuration.alg` must be set to RS256.
1508
+ - To change a client's `is_first_party` property to `false`, the `organization_usage` and `organization_require_behavior` properties must be unset.
1526
1509
  </dd>
1527
1510
  </dl>
1528
1511
  </dd>
@@ -1596,7 +1579,7 @@ Rotate a client secret.
1596
1579
 
1597
1580
  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.
1598
1581
 
1599
- For more information, read <a href="https://www.auth0.com/docs/get-started/applications/rotate-client-secret">Rotate Client Secrets</a>.
1582
+ For more information, read [Rotate Client Secrets](https://www.auth0.com/docs/get-started/applications/rotate-client-secret).
1600
1583
 
1601
1584
  </dd>
1602
1585
  </dl>
@@ -4682,7 +4665,7 @@ await client.forms.update("id");
4682
4665
  <dl>
4683
4666
  <dd>
4684
4667
 
4685
- Retrieve the <a href="https://auth0.com/docs/api-auth/which-oauth-flow-to-use">grants</a> associated with your account.
4668
+ Retrieve the [grants](https://auth0.com/docs/api-auth/which-oauth-flow-to-use) associated with your account.
4686
4669
 
4687
4670
  </dd>
4688
4671
  </dl>
@@ -7911,7 +7894,7 @@ const response = page.response;
7911
7894
  <dl>
7912
7895
  <dd>
7913
7896
 
7914
- Revoke refresh tokens in bulk by ID list, user, user+client, or client.
7897
+ Revoke refresh tokens in bulk by ID list, user, user+client, or user+client+audience.
7915
7898
 
7916
7899
  </dd>
7917
7900
  </dl>
@@ -10437,16 +10420,14 @@ await client.tickets.changePassword();
10437
10420
 
10438
10421
  Retrieve a list of all Token Exchange Profiles available in your tenant.
10439
10422
 
10440
- By using this feature, you agree to the applicable Free Trial terms in <a href="https://www.okta.com/legal/">Okta’s Master Subscription Agreement</a>. It is your responsibility to securely validate the user’s subject_token. See <a href="https://auth0.com/docs/authenticate/custom-token-exchange">User Guide</a> for more details.
10423
+ By using this feature, you agree to the applicable Free Trial terms in [Okta’s Master Subscription Agreement](https://www.okta.com/legal/). It is your responsibility to securely validate the user’s subject_token. See [User Guide](https://auth0.com/docs/authenticate/custom-token-exchange) for more details.
10441
10424
 
10442
10425
  This endpoint supports Checkpoint pagination. To search by checkpoint, use the following parameters:
10443
10426
 
10444
- <ul>
10445
- <li><code>from</code>: Optional id from which to start selection.</li>
10446
- <li><code>take</code>: The total amount of entries to retrieve when using the from parameter. Defaults to 50.</li>
10447
- </ul>
10427
+ - `from`: Optional id from which to start selection.
10428
+ - `take`: The total amount of entries to retrieve when using the from parameter. Defaults to 50.
10448
10429
 
10449
- <b>Note</b>: The first time you call this endpoint using checkpoint pagination, 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 pages are remaining.
10430
+ **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.
10450
10431
 
10451
10432
  </dd>
10452
10433
  </dl>
@@ -10529,7 +10510,7 @@ const response = page.response;
10529
10510
 
10530
10511
  Create a new Token Exchange Profile within your tenant.
10531
10512
 
10532
- By using this feature, you agree to the applicable Free Trial terms in <a href="https://www.okta.com/legal/">Okta’s Master Subscription Agreement</a>. It is your responsibility to securely validate the user’s subject_token. See <a href="https://auth0.com/docs/authenticate/custom-token-exchange">User Guide</a> for more details.
10513
+ By using this feature, you agree to the applicable Free Trial terms in [Okta’s Master Subscription Agreement](https://www.okta.com/legal/). It is your responsibility to securely validate the user’s subject_token. See [User Guide](https://auth0.com/docs/authenticate/custom-token-exchange) for more details.
10533
10514
 
10534
10515
  </dd>
10535
10516
  </dl>
@@ -10599,7 +10580,7 @@ await client.tokenExchangeProfiles.create({
10599
10580
 
10600
10581
  Retrieve details about a single Token Exchange Profile specified by ID.
10601
10582
 
10602
- By using this feature, you agree to the applicable Free Trial terms in <a href="https://www.okta.com/legal/">Okta’s Master Subscription Agreement</a>. It is your responsibility to securely validate the user’s subject_token. See <a href="https://auth0.com/docs/authenticate/custom-token-exchange">User Guide</a> for more details.
10583
+ By using this feature, you agree to the applicable Free Trial terms in [Okta’s Master Subscription Agreement](https://www.okta.com/legal/). It is your responsibility to securely validate the user’s subject_token. See [User Guide](https://auth0.com/docs/authenticate/custom-token-exchange) for more details.
10603
10584
 
10604
10585
  </dd>
10605
10586
  </dl>
@@ -10664,7 +10645,7 @@ await client.tokenExchangeProfiles.get("id");
10664
10645
 
10665
10646
  Delete a Token Exchange Profile within your tenant.
10666
10647
 
10667
- By using this feature, you agree to the applicable Free Trial terms in <a href="https://www.okta.com/legal/">Okta's Master Subscription Agreement</a>. It is your responsibility to securely validate the user's subject_token. See <a href="https://auth0.com/docs/authenticate/custom-token-exchange">User Guide</a> for more details.
10648
+ By using this feature, you agree to the applicable Free Trial terms in [Okta's Master Subscription Agreement](https://www.okta.com/legal/). It is your responsibility to securely validate the user's subject_token. See [User Guide](https://auth0.com/docs/authenticate/custom-token-exchange) for more details.
10668
10649
 
10669
10650
  </dd>
10670
10651
  </dl>
@@ -10729,7 +10710,7 @@ await client.tokenExchangeProfiles.delete("id");
10729
10710
 
10730
10711
  Update a Token Exchange Profile within your tenant.
10731
10712
 
10732
- By using this feature, you agree to the applicable Free Trial terms in <a href="https://www.okta.com/legal/">Okta's Master Subscription Agreement</a>. It is your responsibility to securely validate the user's subject_token. See <a href="https://auth0.com/docs/authenticate/custom-token-exchange">User Guide</a> for more details.
10713
+ By using this feature, you agree to the applicable Free Trial terms in [Okta's Master Subscription Agreement](https://www.okta.com/legal/). It is your responsibility to securely validate the user's subject_token. See [User Guide](https://auth0.com/docs/authenticate/custom-token-exchange) for more details.
10733
10714
 
10734
10715
  </dd>
10735
10716
  </dl>
@@ -14841,7 +14822,7 @@ await client.branding.themes.update("themeId", {
14841
14822
  <dl>
14842
14823
  <dd>
14843
14824
 
14844
- Retrieve a list of <a href="https://auth0.com/docs/customize/phone-messages/configure-phone-messaging-providers">phone providers</a> details set for a Tenant. A list of fields to include or exclude may also be specified.
14825
+ Retrieve a list of [phone providers](https://auth0.com/docs/customize/phone-messages/configure-phone-messaging-providers) details set for a Tenant. A list of fields to include or exclude may also be specified.
14845
14826
 
14846
14827
  </dd>
14847
14828
  </dl>
@@ -14906,8 +14887,8 @@ await client.branding.phone.providers.list({
14906
14887
  <dl>
14907
14888
  <dd>
14908
14889
 
14909
- Create a <a href="https://auth0.com/docs/customize/phone-messages/configure-phone-messaging-providers">phone provider</a>.
14910
- The <code>credentials</code> object requires different properties depending on the phone provider (which is specified using the <code>name</code> property).
14890
+ Create a [phone provider](https://auth0.com/docs/customize/phone-messages/configure-phone-messaging-providers).
14891
+ The `credentials` object requires different properties depending on the phone provider (which is specified using the `name` property).
14911
14892
 
14912
14893
  </dd>
14913
14894
  </dl>
@@ -14975,7 +14956,7 @@ await client.branding.phone.providers.create({
14975
14956
  <dl>
14976
14957
  <dd>
14977
14958
 
14978
- Retrieve <a href="https://auth0.com/docs/customize/phone-messages/configure-phone-messaging-providers">phone provider</a> details. A list of fields to include or exclude may also be specified.
14959
+ Retrieve [phone provider](https://auth0.com/docs/customize/phone-messages/configure-phone-messaging-providers) details. A list of fields to include or exclude may also be specified.
14979
14960
 
14980
14961
  </dd>
14981
14962
  </dl>
@@ -15101,8 +15082,8 @@ await client.branding.phone.providers.delete("id");
15101
15082
  <dl>
15102
15083
  <dd>
15103
15084
 
15104
- Update a <a href="https://auth0.com/docs/customize/phone-messages/configure-phone-messaging-providers">phone provider</a>.
15105
- The <code>credentials</code> object requires different properties depending on the phone provider (which is specified using the <code>name</code> property).
15085
+ Update a [phone provider](https://auth0.com/docs/customize/phone-messages/configure-phone-messaging-providers).
15086
+ The `credentials` object requires different properties depending on the phone provider (which is specified using the `name` property).
15106
15087
 
15107
15088
  </dd>
15108
15089
  </dl>
@@ -15679,7 +15660,7 @@ const response = page.response;
15679
15660
 
15680
15661
  Get the details of a client credential.
15681
15662
 
15682
- <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.
15663
+ **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.
15683
15664
 
15684
15665
  </dd>
15685
15666
  </dl>
@@ -15744,43 +15725,65 @@ await client.clients.credentials.list("client_id");
15744
15725
 
15745
15726
  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.
15746
15727
 
15747
- <h5>Public Key</h5>Public Key credentials can be used to set up Private Key JWT client authentication and JWT-secured Authorization requests.
15748
-
15749
- Sample: <pre><code>{
15750
- "credential_type": "public_key",
15751
- "name": "string",
15752
- "pem": "string",
15753
- "alg": "RS256",
15754
- "parse_expiry_from_cert": false,
15755
- "expires_at": "2022-12-31T23:59:59Z"
15756
- }</code></pre>
15757
-
15758
- <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.
15759
-
15760
- CA-signed Certificate Sample (pem): <pre><code>{
15761
- "credential_type": "x509_cert",
15762
- "name": "string",
15763
- "pem": "string"
15764
- }</code></pre>CA-signed Certificate Sample (subject_dn): <pre><code>{
15765
- "credential_type": "cert_subject_dn",
15766
- "name": "string",
15767
- "subject_dn": "string"
15768
- }</code></pre>Self-signed Certificate Sample: <pre><code>{
15769
- "credential_type": "cert_subject_dn",
15770
- "name": "string",
15771
- "pem": "string"
15772
- }</code></pre>
15728
+ **Public Key**
15729
+
15730
+ Public Key credentials can be used to set up Private Key JWT client authentication and JWT-secured Authorization requests.
15731
+
15732
+ Sample:
15733
+
15734
+ ```json
15735
+ {
15736
+ "credential_type": "public_key",
15737
+ "name": "string",
15738
+ "pem": "string",
15739
+ "alg": "RS256",
15740
+ "parse_expiry_from_cert": false,
15741
+ "expires_at": "2022-12-31T23:59:59Z"
15742
+ }
15743
+ ```
15744
+
15745
+ **Certificate (CA-signed & self-signed)**
15746
+
15747
+ 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.
15748
+
15749
+ CA-signed Certificate Sample (pem):
15750
+
15751
+ ```json
15752
+ {
15753
+ "credential_type": "x509_cert",
15754
+ "name": "string",
15755
+ "pem": "string"
15756
+ }
15757
+ ```
15758
+
15759
+ CA-signed Certificate Sample (subject_dn):
15760
+
15761
+ ```json
15762
+ {
15763
+ "credential_type": "cert_subject_dn",
15764
+ "name": "string",
15765
+ "subject_dn": "string"
15766
+ }
15767
+ ```
15768
+
15769
+ Self-signed Certificate Sample:
15770
+
15771
+ ```json
15772
+ {
15773
+ "credential_type": "cert_subject_dn",
15774
+ "name": "string",
15775
+ "pem": "string"
15776
+ }
15777
+ ```
15773
15778
 
15774
15779
  The credential will be created but not yet enabled for use until you set the corresponding properties in the client:
15775
15780
 
15776
- <ul>
15777
- <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>
15778
- <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>
15779
- </ul>
15780
- </dd>
15781
- </dl>
15782
- </dd>
15783
- </dl>
15781
+ - 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)
15782
+ - 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)
15783
+ </dd>
15784
+ </dl>
15785
+ </dd>
15786
+ </dl>
15784
15787
 
15785
15788
  #### 🔌 Usage
15786
15789
 
@@ -15850,7 +15853,7 @@ await client.clients.credentials.create("client_id", {
15850
15853
 
15851
15854
  Get the details of a client credential.
15852
15855
 
15853
- <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.
15856
+ **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.
15854
15857
 
15855
15858
  </dd>
15856
15859
  </dl>
@@ -16073,20 +16076,14 @@ await client.clients.credentials.update("client_id", "credential_id");
16073
16076
  <dl>
16074
16077
  <dd>
16075
16078
 
16076
- 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.
16079
+ 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.
16077
16080
 
16078
- <ul>
16079
- <li>
16080
- This endpoint requires the <code>read:connections</code> scope and any one of <code>read:clients</code> or <code>read:client_summary</code>.
16081
- </li>
16082
- <li>
16083
- <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.
16084
- </li>
16085
- </ul>
16086
- </dd>
16087
- </dl>
16088
- </dd>
16089
- </dl>
16081
+ - This endpoint requires the `read:connections` scope and any one of `read:clients` or `read:client_summary`.
16082
+ - **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.
16083
+ </dd>
16084
+ </dl>
16085
+ </dd>
16086
+ </dl>
16090
16087
 
16091
16088
  #### 🔌 Usage
16092
16089
 
@@ -17883,7 +17880,7 @@ await client.connections.scimConfiguration.tokens.delete("id", "tokenId");
17883
17880
  <dl>
17884
17881
  <dd>
17885
17882
 
17886
- Retrieve details of the <a href="https://auth0.com/docs/customize/email/smtp-email-providers">email provider configuration</a> in your tenant. A list of fields to include or exclude may also be specified.
17883
+ Retrieve details of the [email provider configuration](https://auth0.com/docs/customize/email/smtp-email-providers) in your tenant. A list of fields to include or exclude may also be specified.
17887
17884
 
17888
17885
  </dd>
17889
17886
  </dl>
@@ -17949,53 +17946,35 @@ await client.emails.provider.get({
17949
17946
  <dl>
17950
17947
  <dd>
17951
17948
 
17952
- Create an <a href="https://auth0.com/docs/email/providers">email provider</a>. The <code>credentials</code> object
17953
- requires different properties depending on the email provider (which is specified using the <code>name</code> property):
17949
+ Create an [email provider](https://auth0.com/docs/email/providers). The `credentials` object
17950
+ requires different properties depending on the email provider (which is specified using the `name` property):
17954
17951
 
17955
- <ul>
17956
- <li><code>mandrill</code> requires <code>api_key</code></li>
17957
- <li><code>sendgrid</code> requires <code>api_key</code></li>
17958
- <li>
17959
- <code>sparkpost</code> requires <code>api_key</code>. Optionally, set <code>region</code> to <code>eu</code> to use
17960
- the SparkPost service hosted in Western Europe; set to <code>null</code> to use the SparkPost service hosted in
17961
- North America. <code>eu</code> or <code>null</code> are the only valid values for <code>region</code>.
17962
- </li>
17963
- <li>
17964
- <code>mailgun</code> requires <code>api_key</code> and <code>domain</code>. Optionally, set <code>region</code> to
17965
- <code>eu</code> to use the Mailgun service hosted in Europe; set to <code>null</code> otherwise. <code>eu</code> or
17966
- <code>null</code> are the only valid values for <code>region</code>.
17967
- </li>
17968
- <li><code>ses</code> requires <code>accessKeyId</code>, <code>secretAccessKey</code>, and <code>region</code></li>
17969
- <li>
17970
- <code>smtp</code> requires <code>smtp_host</code>, <code>smtp_port</code>, <code>smtp_user</code>, and
17971
- <code>smtp_pass</code>
17972
- </li>
17973
- </ul>
17974
- Depending on the type of provider it is possible to specify <code>settings</code> object with different configuration
17952
+ - `mandrill` requires `api_key`
17953
+ - `sendgrid` requires `api_key`
17954
+ - `sparkpost` requires `api_key`. Optionally, set `region` to `eu` to use
17955
+ the SparkPost service hosted in Western Europe; set to `null` to use the SparkPost service hosted in
17956
+ North America. `eu` or `null` are the only valid values for `region`.
17957
+ - `mailgun` requires `api_key` and `domain`. Optionally, set `region` to
17958
+ `eu` to use the Mailgun service hosted in Europe; set to `null` otherwise. `eu` or
17959
+ `null` are the only valid values for `region`.
17960
+ - `ses` requires `accessKeyId`, `secretAccessKey`, and `region`
17961
+ - `smtp` requires `smtp_host`, `smtp_port`, `smtp_user`, and
17962
+ `smtp_pass`
17963
+
17964
+ Depending on the type of provider it is possible to specify `settings` object with different configuration
17975
17965
  options, which will be used when sending an email:
17976
- <ul>
17977
- <li>
17978
- <code>smtp</code> provider, <code>settings</code> may contain <code>headers</code> object.
17979
- <ul>
17980
- <li>
17981
- When using AWS SES SMTP host, you may provide a name of configuration set in
17982
- <code>X-SES-Configuration-Set</code> header. Value must be a string.
17983
- </li>
17984
- <li>
17985
- When using Sparkpost host, you may provide value for
17986
- <code>X-MSYS_API</code> header. Value must be an object.
17987
- </li>
17988
- </ul>
17989
- </li>
17990
- <li>
17991
- for <code>ses</code> provider, <code>settings</code> may contain <code>message</code> object, where you can provide
17992
- a name of configuration set in <code>configuration_set_name</code> property. Value must be a string.
17993
- </li>
17994
- </ul>
17995
- </dd>
17996
- </dl>
17997
- </dd>
17998
- </dl>
17966
+
17967
+ - `smtp` provider, `settings` may contain `headers` object.
17968
+ - When using AWS SES SMTP host, you may provide a name of configuration set in
17969
+ `X-SES-Configuration-Set` header. Value must be a string.
17970
+ - When using Sparkpost host, you may provide value for
17971
+ `X-MSYS_API` header. Value must be an object.
17972
+ - For `ses` provider, `settings` may contain `message` object, where you can provide
17973
+ a name of configuration set in `configuration_set_name` property. Value must be a string.
17974
+ </dd>
17975
+ </dl>
17976
+ </dd>
17977
+ </dl>
17999
17978
 
18000
17979
  #### 🔌 Usage
18001
17980
 
@@ -18113,51 +18092,34 @@ await client.emails.provider.delete();
18113
18092
  <dl>
18114
18093
  <dd>
18115
18094
 
18116
- Update an <a href="https://auth0.com/docs/email/providers">email provider</a>. The <code>credentials</code> object
18117
- requires different properties depending on the email provider (which is specified using the <code>name</code> property):
18095
+ Update an [email provider](https://auth0.com/docs/email/providers). The `credentials` object
18096
+ requires different properties depending on the email provider (which is specified using the `name` property):
18097
+
18098
+ - `mandrill` requires `api_key`
18099
+ - `sendgrid` requires `api_key`
18100
+ - `sparkpost` requires `api_key`. Optionally, set `region` to `eu` to use
18101
+ the SparkPost service hosted in Western Europe; set to `null` to use the SparkPost service hosted in
18102
+ North America. `eu` or `null` are the only valid values for `region`.
18103
+ - `mailgun` requires `api_key` and `domain`. Optionally, set `region` to
18104
+ `eu` to use the Mailgun service hosted in Europe; set to `null` otherwise. `eu` or
18105
+ `null` are the only valid values for `region`.
18106
+ - `ses` requires `accessKeyId`, `secretAccessKey`, and `region`
18107
+ - `smtp` requires `smtp_host`, `smtp_port`, `smtp_user`, and
18108
+ `smtp_pass`
18118
18109
 
18119
- <ul>
18120
- <li><code>mandrill</code> requires <code>api_key</code></li>
18121
- <li><code>sendgrid</code> requires <code>api_key</code></li>
18122
- <li>
18123
- <code>sparkpost</code> requires <code>api_key</code>. Optionally, set <code>region</code> to <code>eu</code> to use
18124
- the SparkPost service hosted in Western Europe; set to <code>null</code> to use the SparkPost service hosted in
18125
- North America. <code>eu</code> or <code>null</code> are the only valid values for <code>region</code>.
18126
- </li>
18127
- <li>
18128
- <code>mailgun</code> requires <code>api_key</code> and <code>domain</code>. Optionally, set <code>region</code> to
18129
- <code>eu</code> to use the Mailgun service hosted in Europe; set to <code>null</code> otherwise. <code>eu</code> or
18130
- <code>null</code> are the only valid values for <code>region</code>.
18131
- </li>
18132
- <li><code>ses</code> requires <code>accessKeyId</code>, <code>secretAccessKey</code>, and <code>region</code></li>
18133
- <li>
18134
- <code>smtp</code> requires <code>smtp_host</code>, <code>smtp_port</code>, <code>smtp_user</code>, and
18135
- <code>smtp_pass</code>
18136
- </li>
18137
- </ul>
18138
- Depending on the type of provider it is possible to specify <code>settings</code> object with different configuration
18110
+ Depending on the type of provider it is possible to specify `settings` object with different configuration
18139
18111
  options, which will be used when sending an email:
18140
- <ul>
18141
- <li>
18142
- <code>smtp</code> provider, <code>settings</code> may contain <code>headers</code> object.
18143
- <ul>
18144
- <li>
18145
- When using AWS SES SMTP host, you may provide a name of configuration set in
18146
- <code>X-SES-Configuration-Set</code> header. Value must be a string.
18147
- </li>
18148
- <li>
18149
- When using Sparkpost host, you may provide value for
18150
- <code>X-MSYS_API</code> header. Value must be an object.
18151
- </li>
18152
- </ul>
18153
- for <code>ses</code> provider, <code>settings</code> may contain <code>message</code> object, where you can provide
18154
- a name of configuration set in <code>configuration_set_name</code> property. Value must be a string.
18155
- </li>
18156
- </ul>
18157
- </dd>
18158
- </dl>
18159
- </dd>
18160
- </dl>
18112
+
18113
+ - `smtp` provider, `settings` may contain `headers` object. - When using AWS SES SMTP host, you may provide a name of configuration set in
18114
+ `X-SES-Configuration-Set` header. Value must be a string. - When using Sparkpost host, you may provide value for
18115
+ `X-MSYS_API` header. Value must be an object.
18116
+
18117
+ For `ses` provider, `settings` may contain `message` object, where you can provide
18118
+ a name of configuration set in `configuration_set_name` property. Value must be a string.
18119
+ </dd>
18120
+ </dl>
18121
+ </dd>
18122
+ </dl>
18161
18123
 
18162
18124
  #### 🔌 Usage
18163
18125
 
@@ -19023,7 +18985,7 @@ const response = page.response;
19023
18985
  <dl>
19024
18986
  <dd>
19025
18987
 
19026
- Lists the <a href="https://auth0.com/docs/manage-users/access-control/rbac">roles</a> assigned to a group.
18988
+ Lists the [roles](https://auth0.com/docs/manage-users/access-control/rbac) assigned to a group.
19027
18989
 
19028
18990
  </dd>
19029
18991
  </dl>
@@ -19112,7 +19074,7 @@ const response = page.response;
19112
19074
  <dl>
19113
19075
  <dd>
19114
19076
 
19115
- Assign one or more <a href="https://auth0.com/docs/manage-users/access-control/rbac">roles</a> to a specified group.
19077
+ Assign one or more [roles](https://auth0.com/docs/manage-users/access-control/rbac) to a specified group.
19116
19078
 
19117
19079
  </dd>
19118
19080
  </dl>
@@ -19185,7 +19147,7 @@ await client.groups.roles.create("id", {
19185
19147
  <dl>
19186
19148
  <dd>
19187
19149
 
19188
- Unassign one or more <a href="https://auth0.com/docs/manage-users/access-control/rbac">roles</a> from a specified group.
19150
+ Unassign one or more [roles](https://auth0.com/docs/manage-users/access-control/rbac) from a specified group.
19189
19151
 
19190
19152
  </dd>
19191
19153
  </dl>