auth0 5.17.0 → 5.19.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 (343) hide show
  1. checksums.yaml +4 -4
  2. data/.version +1 -1
  3. data/CHANGELOG.md +31 -0
  4. data/README.md +13 -1
  5. data/auth0.gemspec +2 -4
  6. data/lib/auth0/api/v2/refresh_tokens.rb +34 -0
  7. data/lib/auth0/api/v2/sessions.rb +43 -0
  8. data/lib/auth0/api/v2/users.rb +37 -5
  9. data/lib/auth0/api/v2.rb +4 -0
  10. data/lib/auth0/mixins/httpproxy.rb +47 -33
  11. data/lib/auth0/mixins/token_management.rb +17 -14
  12. data/lib/auth0/version.rb +1 -1
  13. metadata +10 -338
  14. data/.bundle/config +0 -4
  15. data/.devcontainer/Dockerfile +0 -19
  16. data/.devcontainer/devcontainer.json +0 -37
  17. data/.env.example +0 -2
  18. data/.github/CODEOWNERS +0 -1
  19. data/.github/ISSUE_TEMPLATE/Bug Report.yml +0 -67
  20. data/.github/ISSUE_TEMPLATE/Feature Request.yml +0 -53
  21. data/.github/ISSUE_TEMPLATE/config.yml +0 -8
  22. data/.github/PULL_REQUEST_TEMPLATE.md +0 -35
  23. data/.github/actions/get-prerelease/action.yml +0 -30
  24. data/.github/actions/get-release-notes/action.yml +0 -42
  25. data/.github/actions/get-version/action.yml +0 -21
  26. data/.github/actions/release-create/action.yml +0 -47
  27. data/.github/actions/rubygems-publish/action.yml +0 -30
  28. data/.github/actions/setup/action.yml +0 -32
  29. data/.github/actions/tag-exists/action.yml +0 -36
  30. data/.github/dependabot.yml +0 -13
  31. data/.github/stale.yml +0 -20
  32. data/.github/workflows/codeql.yml +0 -53
  33. data/.github/workflows/matrix.json +0 -3
  34. data/.github/workflows/release.yml +0 -22
  35. data/.github/workflows/ruby-release.yml +0 -72
  36. data/.github/workflows/semgrep.yml +0 -49
  37. data/.github/workflows/snyk.yml +0 -49
  38. data/.github/workflows/test.yml +0 -69
  39. data/.gitignore +0 -18
  40. data/.rspec +0 -3
  41. data/.rubocop.yml +0 -10
  42. data/.rubocop_todo.yml +0 -5
  43. data/.semgrepignore +0 -6
  44. data/.shiprc +0 -8
  45. data/.snyk +0 -11
  46. data/CODE_OF_CONDUCT.md +0 -3
  47. data/DEPLOYMENT.md +0 -61
  48. data/DEVELOPMENT.md +0 -35
  49. data/Dockerfile +0 -5
  50. data/EXAMPLES.md +0 -222
  51. data/Gemfile +0 -20
  52. data/Gemfile.lock +0 -279
  53. data/Guardfile +0 -37
  54. data/RUBYGEM.md +0 -9
  55. data/Rakefile +0 -31
  56. data/codecov.yml +0 -22
  57. data/examples/ruby-api/.env.example +0 -2
  58. data/examples/ruby-api/.gitignore +0 -80
  59. data/examples/ruby-api/Gemfile +0 -9
  60. data/examples/ruby-api/Gemfile.lock +0 -33
  61. data/examples/ruby-api/README.md +0 -24
  62. data/examples/ruby-api/config.ru +0 -2
  63. data/examples/ruby-api/main.rb +0 -33
  64. data/examples/ruby-on-rails-api/.env.example +0 -2
  65. data/examples/ruby-on-rails-api/.gitignore +0 -18
  66. data/examples/ruby-on-rails-api/Gemfile +0 -48
  67. data/examples/ruby-on-rails-api/README.md +0 -25
  68. data/examples/ruby-on-rails-api/Rakefile +0 -6
  69. data/examples/ruby-on-rails-api/app/assets/images/.keep +0 -0
  70. data/examples/ruby-on-rails-api/app/assets/javascripts/application.js +0 -16
  71. data/examples/ruby-on-rails-api/app/assets/stylesheets/application.css +0 -15
  72. data/examples/ruby-on-rails-api/app/controllers/application_controller.rb +0 -8
  73. data/examples/ruby-on-rails-api/app/controllers/concerns/.keep +0 -0
  74. data/examples/ruby-on-rails-api/app/controllers/ping_controller.rb +0 -6
  75. data/examples/ruby-on-rails-api/app/controllers/secured_ping_controller.rb +0 -11
  76. data/examples/ruby-on-rails-api/app/helpers/application_helper.rb +0 -3
  77. data/examples/ruby-on-rails-api/app/mailers/.keep +0 -0
  78. data/examples/ruby-on-rails-api/app/models/.keep +0 -0
  79. data/examples/ruby-on-rails-api/app/models/User.rb +0 -5
  80. data/examples/ruby-on-rails-api/app/models/concerns/.keep +0 -0
  81. data/examples/ruby-on-rails-api/app/views/layouts/application.html.erb +0 -14
  82. data/examples/ruby-on-rails-api/bin/bundle +0 -3
  83. data/examples/ruby-on-rails-api/bin/rails +0 -4
  84. data/examples/ruby-on-rails-api/bin/rake +0 -4
  85. data/examples/ruby-on-rails-api/bin/setup +0 -29
  86. data/examples/ruby-on-rails-api/config/application.rb +0 -23
  87. data/examples/ruby-on-rails-api/config/boot.rb +0 -4
  88. data/examples/ruby-on-rails-api/config/database.yml +0 -27
  89. data/examples/ruby-on-rails-api/config/environment.rb +0 -5
  90. data/examples/ruby-on-rails-api/config/environments/development.rb +0 -37
  91. data/examples/ruby-on-rails-api/config/environments/production.rb +0 -83
  92. data/examples/ruby-on-rails-api/config/environments/test.rb +0 -41
  93. data/examples/ruby-on-rails-api/config/initializers/backtrace_silencers.rb +0 -7
  94. data/examples/ruby-on-rails-api/config/initializers/cookies_serializer.rb +0 -3
  95. data/examples/ruby-on-rails-api/config/initializers/dotenv.rb +0 -4
  96. data/examples/ruby-on-rails-api/config/initializers/filter_parameter_logging.rb +0 -4
  97. data/examples/ruby-on-rails-api/config/initializers/inflections.rb +0 -16
  98. data/examples/ruby-on-rails-api/config/initializers/knock.rb +0 -35
  99. data/examples/ruby-on-rails-api/config/initializers/mime_types.rb +0 -4
  100. data/examples/ruby-on-rails-api/config/initializers/session_store.rb +0 -3
  101. data/examples/ruby-on-rails-api/config/initializers/wrap_parameters.rb +0 -14
  102. data/examples/ruby-on-rails-api/config/locales/en.yml +0 -23
  103. data/examples/ruby-on-rails-api/config/routes.rb +0 -58
  104. data/examples/ruby-on-rails-api/config/secrets.yml +0 -28
  105. data/examples/ruby-on-rails-api/config.ru +0 -4
  106. data/examples/ruby-on-rails-api/db/schema.rb +0 -15
  107. data/examples/ruby-on-rails-api/db/seeds.rb +0 -7
  108. data/examples/ruby-on-rails-api/lib/assets/.keep +0 -0
  109. data/examples/ruby-on-rails-api/lib/tasks/.keep +0 -0
  110. data/examples/ruby-on-rails-api/log/.keep +0 -0
  111. data/examples/ruby-on-rails-api/public/404.html +0 -67
  112. data/examples/ruby-on-rails-api/public/422.html +0 -67
  113. data/examples/ruby-on-rails-api/public/500.html +0 -66
  114. data/examples/ruby-on-rails-api/public/favicon.ico +0 -0
  115. data/examples/ruby-on-rails-api/public/robots.txt +0 -5
  116. data/examples/ruby-on-rails-api/test/controllers/.keep +0 -0
  117. data/examples/ruby-on-rails-api/test/fixtures/.keep +0 -0
  118. data/examples/ruby-on-rails-api/test/helpers/.keep +0 -0
  119. data/examples/ruby-on-rails-api/test/integration/.keep +0 -0
  120. data/examples/ruby-on-rails-api/test/mailers/.keep +0 -0
  121. data/examples/ruby-on-rails-api/test/models/.keep +0 -0
  122. data/examples/ruby-on-rails-api/test/ping_controller_test.rb +0 -8
  123. data/examples/ruby-on-rails-api/test/secured_ping_controller_test.rb +0 -26
  124. data/examples/ruby-on-rails-api/test/test_helper.rb +0 -16
  125. data/opslevel.yml +0 -5
  126. data/publish_rubygem.sh +0 -10
  127. data/spec/fixtures/vcr_cassettes/Auth0_Api_AuthenticationEndpoints/_change_password/should_trigger_a_password_reset.yml +0 -93
  128. data/spec/fixtures/vcr_cassettes/Auth0_Api_AuthenticationEndpoints/_login_with_resource_owner/should_fail_with_an_incorrect_email.yml +0 -85
  129. data/spec/fixtures/vcr_cassettes/Auth0_Api_AuthenticationEndpoints/_login_with_resource_owner/should_fail_with_an_incorrect_password.yml +0 -85
  130. data/spec/fixtures/vcr_cassettes/Auth0_Api_AuthenticationEndpoints/_login_with_resource_owner/should_fail_with_an_invalid_audience.yml +0 -86
  131. data/spec/fixtures/vcr_cassettes/Auth0_Api_AuthenticationEndpoints/_login_with_resource_owner/should_login_successfully_with_a_custom_audience.yml +0 -87
  132. data/spec/fixtures/vcr_cassettes/Auth0_Api_AuthenticationEndpoints/_login_with_resource_owner/should_login_successfully_with_a_default_scope.yml +0 -88
  133. data/spec/fixtures/vcr_cassettes/Auth0_Api_AuthenticationEndpoints/_saml_metadata/should_retrieve_SAML_metadata.yml +0 -110
  134. data/spec/fixtures/vcr_cassettes/Auth0_Api_AuthenticationEndpoints/_userinfo/should_fail_as_not_authorized.yml +0 -94
  135. data/spec/fixtures/vcr_cassettes/Auth0_Api_AuthenticationEndpoints/_userinfo/should_return_the_userinfo.yml +0 -176
  136. data/spec/fixtures/vcr_cassettes/Auth0_Api_AuthenticationEndpoints/_wsfed_metadata/should_retrieve_WSFED_metadata.yml +0 -98
  137. data/spec/fixtures/vcr_cassettes/Auth0_Api_AuthenticationEndpoints/create_test_user.yml +0 -93
  138. data/spec/fixtures/vcr_cassettes/Auth0_Api_AuthenticationEndpoints/delete_test_user.yml +0 -72
  139. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Blacklists/_add_token_to_blacklist/should_add_a_token_to_the_blacklist.yml +0 -74
  140. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Blacklists/_blacklisted_tokens/should_get_the_added_token_from_the_blacklist.yml +0 -74
  141. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_ClientGrants/_client_grants/should_return_at_least_1_result.yml +0 -78
  142. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_ClientGrants/_client_grants/should_return_the_test_client_grant.yml +0 -78
  143. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_ClientGrants/_delete_client_grant/should_delete_the_test_client_grant.yml +0 -72
  144. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_ClientGrants/_patch_client_grant/should_update_the_test_client_grant.yml +0 -76
  145. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_ClientGrants/create_test_client.yml +0 -80
  146. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_ClientGrants/create_test_client_grant.yml +0 -76
  147. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_ClientGrants/delete_test_client.yml +0 -72
  148. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_ClientGrants/delete_test_client_grant.yml +0 -72
  149. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Clients/_client/_filters/should_exclude_and_include_fields_properly.yml +0 -78
  150. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Clients/_client/_filters/should_include_the_specified_fields.yml +0 -74
  151. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Clients/_client/should_get_the_test_client.yml +0 -78
  152. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Clients/_clients/_filters/should_exclude_fields_not_specified.yml +0 -79
  153. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Clients/_clients/_filters/should_exclude_the_specified_fields.yml +0 -272
  154. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Clients/_clients/_filters/should_include_the_specified_fields.yml +0 -88
  155. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Clients/_clients/_filters/should_paginate_results.yml +0 -79
  156. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Clients/_clients/should_get_at_least_one_client.yml +0 -271
  157. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Clients/_delete_client/should_delete_the_test_client_without_an_error.yml +0 -72
  158. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Clients/_patch_client/should_update_the_client_with_the_correct_attributes.yml +0 -81
  159. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Clients/create_test_client.yml +0 -81
  160. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Connections/_connection/_filters/should_exclude_the_fields_indicated.yml +0 -74
  161. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Connections/_connection/_filters/should_include_the_fields_indicated.yml +0 -74
  162. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Connections/_connection/should_find_the_correct_connection.yml +0 -74
  163. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Connections/_connections/_filters/should_include_previously-created_connection_when_filtered.yml +0 -78
  164. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Connections/_connections/_filters/should_should_exclude_the_fields_indicated_from_filtered_results.yml +0 -78
  165. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Connections/_connections/_filters/should_should_include_the_fields_indicated_from_filtered_results.yml +0 -78
  166. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Connections/_connections/should_include_the_previously_created_connection.yml +0 -79
  167. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Connections/_connections/should_not_be_empty.yml +0 -79
  168. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Connections/_delete_connection/should_delete_the_connection.yml +0 -74
  169. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Connections/_delete_connection_user/should_delete_the_user_created.yml +0 -148
  170. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Connections/_update_connection/should_update_the_connection.yml +0 -76
  171. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Connections/create_test_connection.yml +0 -76
  172. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Connections/create_test_user.yml +0 -76
  173. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_DeviceCredentials/create_test_credential.yml +0 -72
  174. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_DeviceCredentials/create_test_user.yml +0 -76
  175. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_DeviceCredentials/delete_test_user.yml +0 -72
  176. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Emails/_configure_provider/should_configure_a_new_email_provider.yml +0 -72
  177. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Emails/_delete_provider/should_delete_the_existing_email_provider_without_an_error.yml +0 -72
  178. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Emails/_delete_provider/should_throw_an_error_trying_to_get_the_email_provider.yml +0 -69
  179. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Emails/_get_provider/_filters/should_get_the_existing_email_provider_with_specific_fields.yml +0 -69
  180. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Emails/_get_provider/_filters/should_get_the_existing_email_provider_without_specific_fields.yml +0 -69
  181. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Emails/_get_provider/should_get_the_existing_email_provider.yml +0 -69
  182. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Emails/_update_provider/should_update_the_existing_email_provider.yml +0 -71
  183. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Emails/delete_existing_provider.yml +0 -72
  184. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Jobs/_export_users_and_get_job/should_create_an_export_users_job_successfully.yml +0 -76
  185. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Jobs/_export_users_and_get_job/should_get_the_export_users_job.yml +0 -147
  186. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Jobs/_import_users_and_get_job/should_create_an_import_users_job_successfully.yml +0 -81
  187. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Jobs/_import_users_and_get_job/should_get_the_import_users_job.yml +0 -152
  188. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Jobs/_send_verification_email_and_get_job/should_create_a_new_verification_email_job.yml +0 -149
  189. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Jobs/_send_verification_email_and_get_job/should_get_the_completed_verification_email.yml +0 -220
  190. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Jobs/_send_verification_email_and_get_job/should_reject_an_invalid_client_id.yml +0 -146
  191. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Jobs/delete_imported_user.yml +0 -143
  192. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Jobs/search_for_connection_id.yml +0 -79
  193. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Logs/_log/should_match_the_created_log_entry.yml +0 -293
  194. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Logs/_log/should_not_be_empty.yml +0 -293
  195. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Logs/_logs/_filters/should_exclude_fields_not_specified.yml +0 -74
  196. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Logs/_logs/_filters/should_exclude_the_specified_fields.yml +0 -75
  197. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Logs/_logs/_filters/should_have_one_log_entry.yml +0 -77
  198. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Logs/_logs/_filters/should_include_the_specified_fields.yml +0 -74
  199. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Logs/_logs/_from/should_take_one_log_entry.yml +0 -298
  200. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Logs/create_test_user.yml +0 -76
  201. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Logs/delete_test_disabled_rule.yml +0 -72
  202. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Logs/delete_test_enabled_rule.yml +0 -72
  203. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Logs/delete_test_user.yml +0 -72
  204. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_ResourceServers/_delete_resource_server/should_delete_the_test_server_without_an_error.yml +0 -72
  205. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_ResourceServers/_patch_resource_server/should_update_the_resource_server_with_the_correct_attributes.yml +0 -76
  206. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_ResourceServers/_resource_server/should_get_the_test_server.yml +0 -74
  207. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_ResourceServers/_resource_servers/should_get_the_test_server.yml +0 -182
  208. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_ResourceServers/_resource_servers/should_return_at_least_1_result.yml +0 -182
  209. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_ResourceServers/_resource_servers/should_return_the_first_page_of_one_result.yml +0 -171
  210. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_ResourceServers/create_test_server.yml +0 -76
  211. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_ResourceServers/delete_test_server.yml +0 -72
  212. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Roles/_add_role_permissions/should_add_a_Permission_to_the_Role_successfully.yml +0 -76
  213. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Roles/_add_role_users/should_add_a_User_to_the_Role_successfully.yml +0 -76
  214. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Roles/_delete_role/should_delete_the_Role_successfully.yml +0 -74
  215. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Roles/_get_role/should_get_the_Role_successfully.yml +0 -75
  216. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Roles/_get_role_permissions/should_get_exactly_1_Permission.yml +0 -74
  217. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Roles/_get_role_permissions/should_get_the_added_Permission_from_the_Role_successfully.yml +0 -74
  218. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Roles/_get_role_users/should_get_exactly_1_User.yml +0 -74
  219. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Roles/_get_role_users/should_get_the_added_User_from_the_Role_successfully.yml +0 -74
  220. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Roles/_get_roles/should_get_the_Role_successfully.yml +0 -75
  221. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Roles/_remove_role_permissions/should_remove_a_Permission_from_the_Role_successfully.yml +0 -74
  222. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Roles/_update_role/should_update_the_Role_successfully.yml +0 -76
  223. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Roles/create_test_api.yml +0 -76
  224. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Roles/create_test_role.yml +0 -77
  225. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Roles/create_test_user.yml +0 -76
  226. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Roles/delete_test_api.yml +0 -72
  227. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Roles/delete_test_user.yml +0 -72
  228. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Rules/_delete_rule/should_delete_the_test_disabled_rule_without_an_error.yml +0 -72
  229. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Rules/_delete_rule/should_delete_the_test_enabled_rule_without_an_error.yml +0 -72
  230. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Rules/_rule/_filters/should_exclude_the_fields_not_specified.yml +0 -75
  231. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Rules/_rule/_filters/should_exclude_the_specified_fields.yml +0 -75
  232. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Rules/_rule/_filters/should_include_the_specified_fields.yml +0 -74
  233. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Rules/_rule/should_get_a_specific_rule.yml +0 -75
  234. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Rules/_rules/_filters/should_exclude_fields_not_specified.yml +0 -116
  235. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Rules/_rules/_filters/should_include_the_specified_fields.yml +0 -118
  236. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Rules/_rules/_filters/should_return_at_least_1_disabled_rule.yml +0 -95
  237. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Rules/_rules/_filters/should_return_at_least_1_enabled_rule.yml +0 -104
  238. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Rules/_rules/_filters/should_return_paginated_results.yml +0 -157
  239. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Rules/_rules/should_return_at_least_1_rule.yml +0 -120
  240. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Rules/_update_rule/should_update_the_disabled_rule_to_be_enabled.yml +0 -77
  241. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Rules/create_test_disabled_rule.yml +0 -78
  242. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Rules/create_test_enabled_rule.yml +0 -78
  243. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Stats/_active_users/should_have_at_least_one_active_user.yml +0 -74
  244. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Stats/_daily_stats/should_have_at_least_one_stats_entry_for_the_timeframe.yml +0 -74
  245. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Tenants/_get_tenant_settings/should_get_the_tenant_settings.yml +0 -108
  246. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Tenants/_get_tenant_settings_with_specific_fields/should_exclude_a_field_not_requested.yml +0 -74
  247. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Tenants/_get_tenant_settings_with_specific_fields/should_include_the_field_requested.yml +0 -74
  248. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Tenants/_update_tenant_settings/should_revert_the_tenant_name.yml +0 -110
  249. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Tenants/_update_tenant_settings/should_update_the_tenant_settings_with_a_new_tenant_name.yml +0 -110
  250. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Tickets/_post_email_verification/should_create_an_email_verification_ticket.yml +0 -76
  251. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Tickets/_post_password_change/should_create_a_password_change_ticket.yml +0 -76
  252. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Tickets/create_test_user.yml +0 -76
  253. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Tickets/delete_test_user.yml +0 -72
  254. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Users/_add_user_permissions/should_add_a_Permissions_for_a_User_successfully.yml +0 -71
  255. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Users/_add_user_roles/should_add_a_Role_to_a_User_successfully.yml +0 -74
  256. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Users/_delete_user/should_delete_the_User_successfully.yml +0 -72
  257. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Users/_delete_user/should_delete_the_secondary_User_successfully.yml +0 -72
  258. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Users/_delete_user_provider/should_attempt_to_delete_the_MFA_provider_for_the_User.yml +0 -72
  259. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Users/_get_enrollments/should_get_Enrollments_for_a_User_successfully.yml +0 -74
  260. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Users/_get_user_permissions/should_get_exactly_1_Permission_for_a_User_successfully.yml +0 -74
  261. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Users/_get_user_permissions/should_get_the_correct_Permission_for_a_User_successfully.yml +0 -74
  262. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Users/_get_user_roles/should_get_Roles_for_a_User_successfully.yml +0 -75
  263. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Users/_invalidate_browsers/should_invalidate_MFA_browsers_for_the_User_successfully.yml +0 -74
  264. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Users/_link_user_account/should_link_two_Users_successfully.yml +0 -76
  265. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Users/_patch_user/should_patch_the_User_successfully.yml +0 -78
  266. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Users/_remove_user_permissions/should_remove_a_Permission_from_a_User_successfully.yml +0 -74
  267. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Users/_remove_user_roles/should_remove_a_Role_from_a_User_successfully.yml +0 -74
  268. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Users/_unlink_user_account/should_unlink_two_Users_successfully.yml +0 -74
  269. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Users/_user/_filters/should_exclude_fields_not_indicated.yml +0 -74
  270. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Users/_user/_filters/should_exclude_the_fields_indicated.yml +0 -74
  271. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Users/_user/_filters/should_include_the_fields_indicated.yml +0 -74
  272. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Users/_user/should_retrieve_the_created_user.yml +0 -74
  273. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Users/_user_logs/should_get_Logs_for_a_User_successfully.yml +0 -81
  274. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Users/_users/_filters/is_expected_to_find_a_user_with_a_v2_search_engine_query.yml +0 -74
  275. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Users/_users/_filters/is_expected_to_find_a_user_with_a_v3_search_engine_query.yml +0 -74
  276. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Users/_users/_filters/should_exclude_the_indicated_fields_when_paginated.yml +0 -74
  277. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Users/_users/_filters/should_include_the_indicated_fields_when_paginated.yml +0 -74
  278. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Users/_users/_filters/should_not_include_other_fields_when_paginated.yml +0 -74
  279. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Users/_users/_filters/should_return_the_correct_number_of_results_when_paginated.yml +0 -74
  280. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Users/_users/should_have_at_least_one_user.yml +0 -75
  281. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Users/create_secondary_test_user.yml +0 -76
  282. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Users/create_test_api.yml +0 -76
  283. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Users/create_test_role.yml +0 -77
  284. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Users/create_test_user.yml +0 -76
  285. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Users/delete_test_api.yml +0 -72
  286. data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Users/delete_test_role.yml +0 -74
  287. data/spec/integration/lib/auth0/api/api_authentication_spec.rb +0 -120
  288. data/spec/integration/lib/auth0/api/v2/api_blacklist_spec.rb +0 -27
  289. data/spec/integration/lib/auth0/api/v2/api_client_grants_spec.rb +0 -66
  290. data/spec/integration/lib/auth0/api/v2/api_clients_spec.rb +0 -166
  291. data/spec/integration/lib/auth0/api/v2/api_connections_spec.rb +0 -159
  292. data/spec/integration/lib/auth0/api/v2/api_email_spec.rb +0 -86
  293. data/spec/integration/lib/auth0/api/v2/api_jobs_spec.rb +0 -124
  294. data/spec/integration/lib/auth0/api/v2/api_logs_spec.rb +0 -91
  295. data/spec/integration/lib/auth0/api/v2/api_resource_servers_spec.rb +0 -130
  296. data/spec/integration/lib/auth0/api/v2/api_roles_spec.rb +0 -145
  297. data/spec/integration/lib/auth0/api/v2/api_rules_spec.rb +0 -177
  298. data/spec/integration/lib/auth0/api/v2/api_stats_spec.rb +0 -22
  299. data/spec/integration/lib/auth0/api/v2/api_tenants_spec.rb +0 -59
  300. data/spec/integration/lib/auth0/api/v2/api_tickets_spec.rb +0 -59
  301. data/spec/integration/lib/auth0/api/v2/api_user_blocks_spec.rb +0 -76
  302. data/spec/integration/lib/auth0/api/v2/api_users_spec.rb +0 -273
  303. data/spec/integration/lib/auth0/auth0_client_spec.rb +0 -90
  304. data/spec/lib/auth0/api/authentication_endpoints_spec.rb +0 -750
  305. data/spec/lib/auth0/api/v2/actions_spec.rb +0 -322
  306. data/spec/lib/auth0/api/v2/anomaly_spec.rb +0 -26
  307. data/spec/lib/auth0/api/v2/attack_protection_spec.rb +0 -132
  308. data/spec/lib/auth0/api/v2/blacklists_spec.rb +0 -25
  309. data/spec/lib/auth0/api/v2/branding_spec.rb +0 -71
  310. data/spec/lib/auth0/api/v2/client_grants_spec.rb +0 -106
  311. data/spec/lib/auth0/api/v2/clients_spec.rb +0 -155
  312. data/spec/lib/auth0/api/v2/connections_spec.rb +0 -164
  313. data/spec/lib/auth0/api/v2/device_credentials_spec.rb +0 -102
  314. data/spec/lib/auth0/api/v2/emails_spec.rb +0 -47
  315. data/spec/lib/auth0/api/v2/grants_spec.rb +0 -91
  316. data/spec/lib/auth0/api/v2/guardian_spec.rb +0 -154
  317. data/spec/lib/auth0/api/v2/jobs_spec.rb +0 -158
  318. data/spec/lib/auth0/api/v2/log_streams_spec.rb +0 -84
  319. data/spec/lib/auth0/api/v2/logs_spec.rb +0 -48
  320. data/spec/lib/auth0/api/v2/organizations_spec.rb +0 -708
  321. data/spec/lib/auth0/api/v2/prompts_spec.rb +0 -88
  322. data/spec/lib/auth0/api/v2/resource_servers_spec.rb +0 -86
  323. data/spec/lib/auth0/api/v2/roles_spec.rb +0 -366
  324. data/spec/lib/auth0/api/v2/rules_spec.rb +0 -95
  325. data/spec/lib/auth0/api/v2/stats_spec.rb +0 -22
  326. data/spec/lib/auth0/api/v2/tenants_spec.rb +0 -26
  327. data/spec/lib/auth0/api/v2/tickets_spec.rb +0 -118
  328. data/spec/lib/auth0/api/v2/user_blocks_spec.rb +0 -52
  329. data/spec/lib/auth0/api/v2/users_by_email_spec.rb +0 -21
  330. data/spec/lib/auth0/api/v2/users_spec.rb +0 -849
  331. data/spec/lib/auth0/client_spec.rb +0 -223
  332. data/spec/lib/auth0/mixins/httpproxy_spec.rb +0 -596
  333. data/spec/lib/auth0/mixins/initializer_spec.rb +0 -172
  334. data/spec/lib/auth0/mixins/token_management_spec.rb +0 -136
  335. data/spec/lib/auth0/mixins/validation_spec.rb +0 -562
  336. data/spec/spec_helper.rb +0 -71
  337. data/spec/support/credentials.rb +0 -11
  338. data/spec/support/dummy_class.rb +0 -18
  339. data/spec/support/dummy_class_for_proxy.rb +0 -5
  340. data/spec/support/dummy_class_for_restclient.rb +0 -2
  341. data/spec/support/dummy_class_for_tokens.rb +0 -20
  342. data/spec/support/import_users.json +0 -13
  343. data/spec/support/stub_response.rb +0 -1
data/.shiprc DELETED
@@ -1,8 +0,0 @@
1
- {
2
- "files": {
3
- "lib/auth0/version.rb": [],
4
- ".version": []
5
- },
6
- "prebump": "bundle install && bundle exec rake test",
7
- "postbump": "bundle update"
8
- }
data/.snyk DELETED
@@ -1,11 +0,0 @@
1
- ignore:
2
- SNYK-RUBY-RACK-1061917:
3
- - rubocop-rails > rack:
4
- reason: No direct upgrade available
5
- expires: "2023-11-02T12:00:00.000Z"
6
- - dotenv-rails > railties > actionpack > rack:
7
- reason: No direct upgrade available
8
- expires: "2023-11-02T12:00:00.000Z"
9
- - dotenv-rails > railties > actionpack > rack-test:
10
- reason: No direct upgrade available
11
- expires: "2023-11-02T12:00:00.000Z"
data/CODE_OF_CONDUCT.md DELETED
@@ -1,3 +0,0 @@
1
- # Code of Conduct
2
-
3
- Please see [Auth0's code of conduct guidelines](https://github.com/auth0/open-source-template/blob/master/CODE-OF-CONDUCT.md) for information on contributing to this repo.
data/DEPLOYMENT.md DELETED
@@ -1,61 +0,0 @@
1
- # Releasing the gem
2
-
3
- ## Credentials set up
4
-
5
- Make sure you have access in https://rubygems.org/gems/auth0/ and that your Ruby Gems tokens are set in `~/.gem/credentials`.
6
-
7
- In order to generate the required changelog entry, define an environment variable `GITHUB_READ_TOKEN` with a Github API token that has READ access to `repo:public_repo`. You can generate a Github API Token [here](https://github.com/settings/tokens/new?description=GitHub%20Changelog%20Generator%20token).
8
-
9
- Create a new Github Milestone with the version name prefixed with `v`. i.e. `v4.10.2`. Assign every Issue and Pull Request to be included on this release to that Milestone, and tag them with the `CH:xxxxxx` labels, depending on the type of change fixed or introduced there.
10
-
11
- Finally, follow the next steps:
12
-
13
- ```bash
14
- # Install gems for exec commands
15
- bundle install
16
-
17
- # Run all tests
18
- bundle exec rake test
19
-
20
- # Create a release branch
21
- git checkout master
22
- git pull
23
- git checkout -b release-X.X.X
24
- git push --set-upstream origin release-X.X.X
25
-
26
- # Update the version number
27
- # This will create a commit with the new version
28
- bundle exec gem bump --version X.X.X
29
-
30
- # Make sure the Gemfile.lock is up-to-date
31
- bundle update
32
- git commit -am "Update gems"
33
-
34
- # Generate the changelog
35
- github_changelog_generator -t $GITHUB_READ_TOKEN
36
- # ... or similar.
37
- # Review the changelog
38
- # Remove "unreleased" section
39
- # Make sure the tags are ordered
40
-
41
- # Commit, push, and create a PR for this release
42
- git commit -am "Update CHANGELOG.md"
43
- git push
44
-
45
- # Add related milestone
46
- # Create PR on GitHub and assign for review
47
- # Merge/rebase and delete branch once approved
48
-
49
- # Create and add a tag
50
- git checkout master
51
- git pull
52
- bundle exec gem tag
53
- git push origin vX.X.X
54
- # Create a new release from this tag on GitHub using markdown from the changelog
55
-
56
- # Make sure you are an author for this gem here https://rubygems.org/gems/auth0/
57
- # Rubygems token can be updated in ~/.gem/credentials
58
- bundle exec gem release
59
- ```
60
-
61
- The steps above were tested with Ruby `v2.5.7`.
data/DEVELOPMENT.md DELETED
@@ -1,35 +0,0 @@
1
- # Development
2
-
3
- In order to set up the local environment you'd have to have Ruby installed and a few global gems used to run and record the unit tests. A working Ruby version can be taken from the [CI script](/.circleci/config.yml). At the moment of this writting we're using Ruby `2.5.7`.
4
-
5
- > It is expected that every Pull Request introducing a fix, change or feature contains enough test coverage to assert the new behavior.
6
-
7
- ## Running the tests
8
-
9
- Install the gems required for this project.
10
-
11
- ```bash
12
- bundle install
13
- ```
14
-
15
- Finally, run the tests.
16
-
17
- ```bash
18
- bundle exec rake test
19
- ```
20
-
21
- ### Running only unit tests
22
-
23
- You can run only the unit tests and ignore the integration tests by running the following:
24
-
25
- ```bash
26
- bundle exec rake spec
27
- ```
28
-
29
- ### Running only integration tests
30
-
31
- You can run only the unit tests and ignore the integration tests by running the following:
32
-
33
- ```bash
34
- bundle exec rake integration
35
- ```
data/Dockerfile DELETED
@@ -1,5 +0,0 @@
1
- FROM ruby:2.5
2
-
3
- WORKDIR /home/app
4
-
5
- COPY . /home/app
data/EXAMPLES.md DELETED
@@ -1,222 +0,0 @@
1
- # Examples using ruby-auth0
2
-
3
- ## Build a URL to Universal Login Page
4
-
5
- ```ruby
6
- require 'auth0'
7
-
8
- client = Auth0Client.new(
9
- client_id: ENV['AUTH0_RUBY_CLIENT_ID'],
10
- client_secret: ENV['AUTH0_RUBY_CLIENT_SECRET'],
11
- domain: ENV['AUTH0_RUBY_DOMAIN'],
12
- )
13
-
14
- client.authorize_url 'http://localhost:3000'
15
-
16
- > => #<URI::HTTPS https://YOUR_DOMAIN/authorize?client_id=YOUR_CLIENT_ID&response_type=code&redirect_uri=http%3A%2F%2Flocalhost%3A3000>
17
-
18
- ```
19
-
20
- ## Management API Client
21
-
22
- As a simple example of how to get started with the management API, we'll create an admin route to point to a list of all users from Auth0:
23
-
24
- ```ruby
25
- # config/routes.rb
26
- Rails.application.routes.draw do
27
- # ...
28
- get 'admin/users', to: 'all_users#index'
29
- # ...
30
- end
31
- ```
32
-
33
- ... and a Controller to handle that route:
34
-
35
- ```ruby
36
- # app/controllers/all_users_controller.rb
37
- require 'auth0'
38
-
39
- class AllUsersController < ApplicationController
40
- # Get all users from Auth0 with "auth0" in their email.
41
- def index
42
- @params = {
43
- q: "email:*auth0*",
44
- fields: 'email,user_id,name',
45
- include_fields: true,
46
- page: 0,
47
- per_page: 50
48
- }
49
- @users = auth0_client.users @params
50
- end
51
-
52
- private
53
-
54
- # Setup the Auth0 API connection.
55
- def auth0_client
56
- @auth0_client ||= Auth0Client.new(
57
- client_id: ENV['AUTH0_RUBY_CLIENT_ID'],
58
- client_secret: ENV['AUTH0_RUBY_CLIENT_SECRET'],
59
- domain: ENV['AUTH0_RUBY_DOMAIN'],
60
- api_version: 2,
61
- timeout: 15 # optional, defaults to 10
62
- )
63
- end
64
- end
65
- ```
66
-
67
- In this example, we're using environment variables to store the values needed to connect to Auth0 and authorize. The `token` used above is an API token for the Management API with the scopes required to perform a specific action (in this case `read:users`). These tokens can be [generated manually](https://auth0.com/docs/api/management/v2/tokens#get-a-token-manually) using a test Application or with the [Application](https://manage.auth0.com/#/applications) being used for your project.
68
-
69
- Finally, we'll add a view to display the results:
70
-
71
- ```ruby
72
- # app/views/all_users/index.html.erb
73
- <h1>Users</h1>
74
- <%= debug @params %>
75
- <%= debug @users %>
76
- ```
77
-
78
- This should show the parameters passed to the `users` method and a list of users that matched the query (or an empty array if none).
79
-
80
- ## Organizations
81
-
82
- [Organizations](https://auth0.com/docs/organizations) is a set of features that provide better support for developers who build and maintain SaaS and Business-to-Business (B2B) applications.
83
-
84
- Note that Organizations is currently only available to customers on our Enterprise and Startup subscription plans.
85
-
86
- ### Logging in with an Organization
87
-
88
- Configure the Authentication API client and pass your Organization ID or name to the authorize url:
89
-
90
- ```ruby
91
- require 'auth0'
92
-
93
- @auth0_client ||= Auth0Client.new(
94
- client_id: '{YOUR_APPLICATION_CLIENT_ID}',
95
- client_secret: '{YOUR_APPLICATION_CLIENT_SECRET}',
96
- domain: '{YOUR_TENANT}.auth0.com',
97
- organization: "{YOUR_ORGANIZATION_ID_OR_NAME}"
98
- )
99
-
100
- universal_login_url = @auth0_client.authorization_url("https://{YOUR_APPLICATION_CALLBACK_URL}")
101
-
102
- # redirect_to universal_login_url
103
- ```
104
-
105
- ### Accepting user invitations
106
-
107
- Auth0 Organizations allow users to be invited using emailed links, which will direct a user back to your application. The URL the user will arrive at is based on your configured `Application Login URI`, which you can change from your Application's settings inside the Auth0 dashboard. When they arrive at this URL, a `invitation` and `organization` query parameters will be provided
108
-
109
- ```ruby
110
- require 'auth0'
111
-
112
- @auth0_client ||= Auth0Client.new(
113
- client_id: '{YOUR_APPLICATION_CLIENT_ID}',
114
- client_secret: '{YOUR_APPLICATION_CLIENT_ID}',
115
- domain: '{YOUR_TENANT}.auth0.com',
116
- organization: "{YOUR_ORGANIZATION_ID_OR_NAME}"
117
- )
118
-
119
- universal_login_url = @auth0_client.authorization_url("https://{YOUR_APPLICATION_CALLBACK_URL}", {
120
- organization: "{ORGANIZATION_QUERY_PARAM}", # You can override organization if needed
121
- invitation: "{INVITATION_QUERY_PARAM}"
122
- })
123
-
124
- # redirect_to universal_login_url
125
- ```
126
-
127
- ## ID Token Validation
128
-
129
- An ID token may be present in the credentials received after authentication. This token contains information associated with the user that has just logged in, provided the scope used contained `openid`. You can [read more about ID tokens here](https://auth0.com/docs/tokens/concepts/id-tokens).
130
-
131
- Before accessing its contents, you must first validate the ID token to ensure it has not been tampered with and that it is meant for your application to consume. Use the `validate_id_token` method to do so:
132
-
133
- ```ruby
134
- begin
135
- @auth0_client.validate_id_token 'YOUR_ID_TOKEN'
136
- rescue Auth0::InvalidIdToken => e
137
- # In this case the ID Token contents should not be trusted
138
- end
139
- ```
140
-
141
- The method takes the following optional keyword parameters:
142
-
143
- | Parameter | Type | Description | Default value |
144
- | -------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
145
- | `algorithm` | `JWTAlgorithm` | The [signing algorithm](https://auth0.com/docs/tokens/concepts/signing-algorithms) used by your Auth0 application. | `Auth0::Algorithm::RS256` (using the [JWKS URL](https://auth0.com/docs/tokens/concepts/jwks) of your **Auth0 Domain**) |
146
- | `leeway` | Integer | Number of seconds to account for clock skew when validating the `exp`, `iat` and `azp` claims. | `60` |
147
- | `nonce` | String | The `nonce` value you sent in the call to `/authorize`, if any. | `nil` |
148
- | `max_age` | Integer | The `max_age` value you sent in the call to `/authorize`, if any. | `nil` |
149
- | `issuer` | String | By default the `iss` claim will be checked against the URL of your **Auth0 Domain**. Use this parameter to override that. | `nil` |
150
- | `audience` | String | By default the `aud` claim will be compared to your **Auth0 Client ID**. Use this parameter to override that. | `nil` |
151
- | `organization` | String | By default the `org_id` or `org_name` claims will be compared to the `organization` value specified at client creation. Use this parameter to override that. | `nil` |
152
-
153
- You can check the signing algorithm value under **Advanced Settings > OAuth > JsonWebToken Signature Algorithm** in your Auth0 application settings panel. [We recommend](https://auth0.com/docs/tokens/concepts/signing-algorithms#our-recommendation) that you make use of asymmetric signing algorithms like `RS256` instead of symmetric ones like `HS256`.
154
-
155
- ```ruby
156
- # HS256
157
-
158
- begin
159
- @auth0_client.validate_id_token 'YOUR_ID_TOKEN', algorithm: Auth0::Algorithm::HS256.secret('YOUR_SECRET')
160
- rescue Auth0::InvalidIdToken => e
161
- # Handle error
162
- end
163
-
164
- # RS256 with a custom JWKS URL
165
-
166
- begin
167
- @auth0_client.validate_id_token 'YOUR_ID_TOKEN', algorithm: Auth0::Algorithm::RS256.jwks_url('YOUR_URL')
168
- rescue Auth0::InvalidIdToken => e
169
- # Handle error
170
- end
171
- ```
172
-
173
- ### Organization claim validation
174
-
175
- If an `org_id` or `org_name` claim is present in the access token, then the claim should be validated by the API to ensure that the value received is expected or known.
176
-
177
- In particular:
178
-
179
- - The issuer (iss) claim should be checked to ensure the token was issued by Auth0
180
-
181
- - the `org_id` or `org_name` claim should be checked to ensure it is a value that is already known to the application. Which claim you check depends on the organization value being validated: if it starts with `org_`, validate against the `org_id` claim. Otherwise, validate against `org_name`. Further, the value of the `org_name` claim will always be lowercase. To aid the developer experience, you may also lowercase the input organization name when checking against the `org_name`, but do not modify the `org_name` claim value.
182
-
183
- This could be validated against a known list of organization IDs or names, or perhaps checked in conjunction with the current request URL. e.g. the sub-domain may hint at what organization should be used to validate the Access Token.
184
-
185
- Normally, validating the issuer would be enough to ensure that the token was issued by Auth0. In the case of organizations, additional checks should be made so that the organization within an Auth0 tenant is expected.
186
-
187
- If the claim cannot be validated, then the application should deem the token invalid.
188
-
189
- ```ruby
190
- begin
191
- @auth0_client.validate_id_token 'YOUR_ID_TOKEN', organization: '{Expected org_id or org_name}'
192
- rescue Auth0::InvalidIdToken => e
193
- # In this case the ID Token contents should not be trusted
194
- end
195
- ```
196
-
197
- For more information, please read [Work with Tokens and Organizations](https://auth0.com/docs/organizations/using-tokens) on Auth0 Docs.
198
-
199
- ## Use a private key to authenticate with Auth0
200
-
201
- You are able to take advantage of using a JWT signed with a private key to authenticate with Auth0 in place of using a client secret.
202
-
203
- **Note:** you must upload the corresponding public key to your Auth0 tenant, so that Auth0 is able to verify the JWT signature.
204
-
205
- Specify the client assertion key when creating the Auth0 client as in the following example:
206
-
207
- ```ruby
208
- key_string = File.read 'key.pem'
209
- key = OpenSSL::PKey::RSA.new key_string
210
-
211
- client = Auth0Client.new(
212
- domain: 'AUTH0_DOMAIN',
213
- client_id: 'AUTH0_CLIENT_ID',
214
- client_assertion_signing_key: key,
215
- client_assertion_signing_alg: 'RS256')
216
- ```
217
-
218
- Some notes:
219
-
220
- * If both `client_secret` and `client_assertion_signing_key` are specified, `client_assertion_signing_key` takes precedence
221
- * `client_assertion_signing_alg` is optional and defaults to `RS256` if omitted
222
- * Only `RS256`, `RS384` and `PS256` algorithms are supported by Auth0 currently
data/Gemfile DELETED
@@ -1,20 +0,0 @@
1
- source 'https://rubygems.org'
2
-
3
- # Specify your gem's dependencies in auth0.gemspec
4
- gemspec
5
-
6
- group :development do
7
- gem 'terminal-notifier-guard', require: false unless ENV['CIRCLECI']
8
- gem 'coveralls', require: false
9
- gem 'rubocop', require: false
10
- gem 'rubocop-rails', require: false
11
- gem 'irb', require: false
12
- end
13
-
14
- group :test do
15
- gem 'webmock', require: false
16
- gem 'vcr', require: false
17
- gem 'simplecov-cobertura'
18
- gem 'timecop', require: false
19
- gem 'pp'
20
- end
data/Gemfile.lock DELETED
@@ -1,279 +0,0 @@
1
- PATH
2
- remote: .
3
- specs:
4
- auth0 (5.17.0)
5
- addressable (~> 2.8)
6
- jwt (~> 2.7)
7
- rest-client (~> 2.1)
8
- retryable (~> 3.0)
9
- zache (~> 0.12)
10
-
11
- GEM
12
- remote: https://rubygems.org/
13
- specs:
14
- actionpack (7.1.3.3)
15
- actionview (= 7.1.3.3)
16
- activesupport (= 7.1.3.3)
17
- nokogiri (>= 1.8.5)
18
- racc
19
- rack (>= 2.2.4)
20
- rack-session (>= 1.0.1)
21
- rack-test (>= 0.6.3)
22
- rails-dom-testing (~> 2.2)
23
- rails-html-sanitizer (~> 1.6)
24
- actionview (7.1.3.3)
25
- activesupport (= 7.1.3.3)
26
- builder (~> 3.1)
27
- erubi (~> 1.11)
28
- rails-dom-testing (~> 2.2)
29
- rails-html-sanitizer (~> 1.6)
30
- activesupport (7.1.3.3)
31
- base64
32
- bigdecimal
33
- concurrent-ruby (~> 1.0, >= 1.0.2)
34
- connection_pool (>= 2.2.5)
35
- drb
36
- i18n (>= 1.6, < 2)
37
- minitest (>= 5.1)
38
- mutex_m
39
- tzinfo (~> 2.0)
40
- addressable (2.8.6)
41
- public_suffix (>= 2.0.2, < 6.0)
42
- ast (2.4.2)
43
- base64 (0.2.0)
44
- bigdecimal (3.1.8)
45
- builder (3.2.4)
46
- coderay (1.1.3)
47
- concurrent-ruby (1.2.3)
48
- connection_pool (2.4.1)
49
- coveralls (0.7.1)
50
- multi_json (~> 1.3)
51
- rest-client
52
- simplecov (>= 0.7)
53
- term-ansicolor
54
- thor
55
- crack (1.0.0)
56
- bigdecimal
57
- rexml
58
- crass (1.0.6)
59
- diff-lcs (1.5.1)
60
- docile (1.4.0)
61
- domain_name (0.6.20240107)
62
- dotenv (2.8.1)
63
- dotenv-rails (2.8.1)
64
- dotenv (= 2.8.1)
65
- railties (>= 3.2)
66
- drb (2.2.1)
67
- erubi (1.12.0)
68
- faker (2.23.0)
69
- i18n (>= 1.8.11, < 2)
70
- ffi (1.16.3)
71
- formatador (1.1.0)
72
- fuubar (2.5.1)
73
- rspec-core (~> 3.0)
74
- ruby-progressbar (~> 1.4)
75
- guard (2.18.1)
76
- formatador (>= 0.2.4)
77
- listen (>= 2.7, < 4.0)
78
- lumberjack (>= 1.0.12, < 2.0)
79
- nenv (~> 0.1)
80
- notiffany (~> 0.0)
81
- pry (>= 0.13.0)
82
- shellany (~> 0.0)
83
- thor (>= 0.18.1)
84
- guard-compat (1.2.1)
85
- guard-rspec (4.7.3)
86
- guard (~> 2.1)
87
- guard-compat (~> 1.1)
88
- rspec (>= 2.99.0, < 4.0)
89
- hashdiff (1.1.0)
90
- http-accept (1.7.0)
91
- http-cookie (1.0.5)
92
- domain_name (~> 0.5)
93
- i18n (1.14.5)
94
- concurrent-ruby (~> 1.0)
95
- io-console (0.7.2)
96
- irb (1.13.1)
97
- rdoc (>= 4.0.0)
98
- reline (>= 0.4.2)
99
- json (2.7.2)
100
- jwt (2.8.1)
101
- base64
102
- language_server-protocol (3.17.0.3)
103
- listen (3.9.0)
104
- rb-fsevent (~> 0.10, >= 0.10.3)
105
- rb-inotify (~> 0.9, >= 0.9.10)
106
- loofah (2.22.0)
107
- crass (~> 1.0.2)
108
- nokogiri (>= 1.12.0)
109
- lumberjack (1.2.10)
110
- method_source (1.1.0)
111
- mime-types (3.5.2)
112
- mime-types-data (~> 3.2015)
113
- mime-types-data (3.2024.0507)
114
- minitest (5.23.1)
115
- multi_json (1.15.0)
116
- mutex_m (0.2.0)
117
- nenv (0.3.0)
118
- netrc (0.11.0)
119
- nokogiri (1.16.5-aarch64-linux)
120
- racc (~> 1.4)
121
- nokogiri (1.16.5-arm64-darwin)
122
- racc (~> 1.4)
123
- nokogiri (1.16.5-x86_64-darwin)
124
- racc (~> 1.4)
125
- nokogiri (1.16.5-x86_64-linux)
126
- racc (~> 1.4)
127
- notiffany (0.1.3)
128
- nenv (~> 0.1)
129
- shellany (~> 0.0)
130
- parallel (1.24.0)
131
- parser (3.3.1.0)
132
- ast (~> 2.4.1)
133
- racc
134
- pp (0.5.0)
135
- prettyprint
136
- prettyprint (0.2.0)
137
- pry (0.14.2)
138
- coderay (~> 1.1)
139
- method_source (~> 1.0)
140
- psych (5.1.2)
141
- stringio
142
- public_suffix (5.0.5)
143
- racc (1.8.0)
144
- rack (3.0.11)
145
- rack-session (2.0.0)
146
- rack (>= 3.0.0)
147
- rack-test (2.1.0)
148
- rack (>= 1.3)
149
- rackup (2.1.0)
150
- rack (>= 3)
151
- webrick (~> 1.8)
152
- rails-dom-testing (2.2.0)
153
- activesupport (>= 5.0.0)
154
- minitest
155
- nokogiri (>= 1.6)
156
- rails-html-sanitizer (1.6.0)
157
- loofah (~> 2.21)
158
- nokogiri (~> 1.14)
159
- railties (7.1.3.3)
160
- actionpack (= 7.1.3.3)
161
- activesupport (= 7.1.3.3)
162
- irb
163
- rackup (>= 1.0.0)
164
- rake (>= 12.2)
165
- thor (~> 1.0, >= 1.2.2)
166
- zeitwerk (~> 2.6)
167
- rainbow (3.1.1)
168
- rake (13.2.1)
169
- rb-fsevent (0.11.2)
170
- rb-inotify (0.11.1)
171
- ffi (~> 1.0)
172
- rdoc (6.7.0)
173
- psych (>= 4.0.0)
174
- regexp_parser (2.9.2)
175
- reline (0.5.7)
176
- io-console (~> 0.5)
177
- rest-client (2.1.0)
178
- http-accept (>= 1.7.0, < 2.0)
179
- http-cookie (>= 1.0.2, < 2.0)
180
- mime-types (>= 1.16, < 4.0)
181
- netrc (~> 0.8)
182
- retryable (3.0.5)
183
- rexml (3.2.8)
184
- strscan (>= 3.0.9)
185
- rspec (3.13.0)
186
- rspec-core (~> 3.13.0)
187
- rspec-expectations (~> 3.13.0)
188
- rspec-mocks (~> 3.13.0)
189
- rspec-core (3.13.0)
190
- rspec-support (~> 3.13.0)
191
- rspec-expectations (3.13.0)
192
- diff-lcs (>= 1.2.0, < 2.0)
193
- rspec-support (~> 3.13.0)
194
- rspec-mocks (3.13.1)
195
- diff-lcs (>= 1.2.0, < 2.0)
196
- rspec-support (~> 3.13.0)
197
- rspec-support (3.13.1)
198
- rubocop (1.64.0)
199
- json (~> 2.3)
200
- language_server-protocol (>= 3.17.0)
201
- parallel (~> 1.10)
202
- parser (>= 3.3.0.2)
203
- rainbow (>= 2.2.2, < 4.0)
204
- regexp_parser (>= 1.8, < 3.0)
205
- rexml (>= 3.2.5, < 4.0)
206
- rubocop-ast (>= 1.31.1, < 2.0)
207
- ruby-progressbar (~> 1.7)
208
- unicode-display_width (>= 2.4.0, < 3.0)
209
- rubocop-ast (1.31.3)
210
- parser (>= 3.3.1.0)
211
- rubocop-rails (2.25.0)
212
- activesupport (>= 4.2.0)
213
- rack (>= 1.1)
214
- rubocop (>= 1.33.0, < 2.0)
215
- rubocop-ast (>= 1.31.1, < 2.0)
216
- ruby-progressbar (1.13.0)
217
- shellany (0.0.1)
218
- simplecov (0.22.0)
219
- docile (~> 1.1)
220
- simplecov-html (~> 0.11)
221
- simplecov_json_formatter (~> 0.1)
222
- simplecov-cobertura (2.1.0)
223
- rexml
224
- simplecov (~> 0.19)
225
- simplecov-html (0.12.3)
226
- simplecov_json_formatter (0.1.4)
227
- stringio (3.1.0)
228
- strscan (3.1.0)
229
- sync (0.5.0)
230
- term-ansicolor (1.8.0)
231
- tins (~> 1.0)
232
- terminal-notifier-guard (1.7.0)
233
- thor (1.3.1)
234
- timecop (0.9.8)
235
- tins (1.33.0)
236
- bigdecimal
237
- sync
238
- tzinfo (2.0.6)
239
- concurrent-ruby (~> 1.0)
240
- unicode-display_width (2.5.0)
241
- vcr (6.2.0)
242
- webmock (3.23.1)
243
- addressable (>= 2.8.0)
244
- crack (>= 0.3.2)
245
- hashdiff (>= 0.4.0, < 2.0.0)
246
- webrick (1.8.1)
247
- zache (0.13.1)
248
- zeitwerk (2.6.14)
249
-
250
- PLATFORMS
251
- aarch64-linux
252
- arm64-darwin-21
253
- arm64-darwin-22
254
- x86_64-darwin-21
255
- x86_64-linux
256
-
257
- DEPENDENCIES
258
- auth0!
259
- bundler
260
- coveralls
261
- dotenv-rails (~> 2.0)
262
- faker (~> 2.0)
263
- fuubar (~> 2.0)
264
- guard-rspec (~> 4.5)
265
- irb
266
- pp
267
- rake (~> 13.0)
268
- rspec (~> 3.11)
269
- rubocop
270
- rubocop-rails
271
- simplecov (~> 0.9)
272
- simplecov-cobertura
273
- terminal-notifier-guard
274
- timecop
275
- vcr
276
- webmock
277
-
278
- BUNDLED WITH
279
- 2.3.7
data/Guardfile DELETED
@@ -1,37 +0,0 @@
1
- scope group: :unit_test
2
-
3
- group :unit_test do
4
- guard 'rspec', cmd:
5
- "bundle exec rspec -P \"spec/lib/auth0/**/*#{ENV['PATTERN']}*_spec.rb\"--drb --format Fuubar --color" do
6
- # run every updated spec file
7
- watch(%r{^spec/.+_spec\.rb$})
8
- # run the lib specs when a file in lib/ changes
9
- watch(%r{^lib/(.+)\.rb$}) { 'spec' }
10
- # run all test for helper changes
11
- watch('spec/spec_helper.rb') { 'spec' }
12
- end
13
- end
14
-
15
- group :integration do
16
- guard 'rspec', cmd:
17
- "MODE=full bundle exec rspec -P \"spec/integration/**/*#{ENV['PATTERN']}*_spec.rb\" --drb --format Fuubar --color" do
18
- # run every updated spec file
19
- watch(%r{^spec/.+_spec\.rb$})
20
- # run the lib specs when a file in lib/ changes
21
- watch(%r{^lib/(.+)\.rb$}) { 'spec' }
22
- # run all test for helper changes
23
- watch('spec/spec_helper.rb') { 'spec' }
24
- end
25
- end
26
-
27
- group :full do
28
- guard 'rspec', cmd:
29
- 'MODE=full bundle exec rspec --drb --format Fuubar --color' do
30
- # run every updated spec file
31
- watch(%r{^spec/.+_spec\.rb$})
32
- # run the lib specs when a file in lib/ changes
33
- watch(%r{^lib/(.+)\.rb$}) { 'spec' }
34
- # run all test for helper changes
35
- watch('spec/spec_helper.rb') { 'spec' }
36
- end
37
- end