auth0 6.2.0 → 6.3.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 (230) hide show
  1. checksums.yaml +4 -4
  2. data/.fern/metadata.json +3 -3
  3. data/.fern/replay.lock +7 -1
  4. data/.version +1 -1
  5. data/CHANGELOG.md +7 -0
  6. data/EXAMPLES.md +44 -0
  7. data/examples/ruby-api/Gemfile.lock +1 -1
  8. data/lib/auth0/actions/client.rb +47 -6
  9. data/lib/auth0/actions/executions/client.rb +4 -1
  10. data/lib/auth0/actions/modules/client.rb +40 -6
  11. data/lib/auth0/actions/modules/versions/client.rb +19 -3
  12. data/lib/auth0/actions/triggers/bindings/client.rb +12 -2
  13. data/lib/auth0/actions/triggers/client.rb +4 -1
  14. data/lib/auth0/actions/versions/client.rb +27 -4
  15. data/lib/auth0/agents/client.rb +22 -4
  16. data/lib/auth0/anomaly/blocks/client.rb +6 -0
  17. data/lib/auth0/api/authentication_endpoints.rb +40 -0
  18. data/lib/auth0/attack_protection/bot_detection/client.rb +8 -2
  19. data/lib/auth0/attack_protection/breached_password_detection/client.rb +8 -2
  20. data/lib/auth0/attack_protection/brute_force_protection/client.rb +8 -2
  21. data/lib/auth0/attack_protection/captcha/client.rb +8 -2
  22. data/lib/auth0/attack_protection/phone_provider_protection/client.rb +8 -2
  23. data/lib/auth0/attack_protection/suspicious_ip_throttling/client.rb +8 -2
  24. data/lib/auth0/branding/client.rb +8 -2
  25. data/lib/auth0/branding/phone/providers/client.rb +31 -5
  26. data/lib/auth0/branding/phone/templates/client.rb +39 -7
  27. data/lib/auth0/branding/templates/client.rb +10 -1
  28. data/lib/auth0/branding/themes/client.rb +162 -4
  29. data/lib/auth0/client.rb +8 -8
  30. data/lib/auth0/client_grants/client.rb +28 -4
  31. data/lib/auth0/client_grants/organizations/client.rb +9 -1
  32. data/lib/auth0/clients/client.rb +46 -7
  33. data/lib/auth0/clients/connections/client.rb +11 -1
  34. data/lib/auth0/clients/credentials/client.rb +36 -7
  35. data/lib/auth0/clients/types/create_client_request_content.rb +2 -0
  36. data/lib/auth0/clients/types/update_client_request_content.rb +2 -0
  37. data/lib/auth0/connection_profiles/client.rb +30 -6
  38. data/lib/auth0/connections/client.rb +37 -4
  39. data/lib/auth0/connections/clients/client.rb +21 -2
  40. data/lib/auth0/connections/directory_provisioning/client.rb +73 -8
  41. data/lib/auth0/connections/directory_provisioning/synchronizations/client.rb +4 -1
  42. data/lib/auth0/connections/keys/client.rb +31 -8
  43. data/lib/auth0/connections/scim_configuration/client.rb +37 -6
  44. data/lib/auth0/connections/scim_configuration/tokens/client.rb +14 -2
  45. data/lib/auth0/connections/users/client.rb +6 -0
  46. data/lib/auth0/custom_domains/client.rb +43 -8
  47. data/lib/auth0/device_credentials/client.rb +25 -2
  48. data/lib/auth0/email_templates/client.rb +19 -4
  49. data/lib/auth0/emails/provider/client.rb +23 -3
  50. data/lib/auth0/event_streams/client.rb +38 -5
  51. data/lib/auth0/event_streams/deliveries/client.rb +19 -2
  52. data/lib/auth0/event_streams/redeliveries/client.rb +10 -1
  53. data/lib/auth0/events/client.rb +7 -0
  54. data/lib/auth0/experimentation/client.rb +19 -0
  55. data/lib/auth0/experimentation/experiments/client.rb +63 -0
  56. data/lib/auth0/experimentation/experiments/types/advance_ramp_request_content.rb +15 -0
  57. data/lib/auth0/flows/client.rb +28 -4
  58. data/lib/auth0/flows/executions/client.rb +23 -2
  59. data/lib/auth0/flows/vault/connections/client.rb +31 -4
  60. data/lib/auth0/forms/client.rb +27 -4
  61. data/lib/auth0/groups/client.rb +21 -2
  62. data/lib/auth0/groups/members/client.rb +10 -1
  63. data/lib/auth0/groups/roles/client.rb +20 -1
  64. data/lib/auth0/guardian/client.rb +77 -0
  65. data/lib/auth0/guardian/enrollments/client.rb +11 -2
  66. data/lib/auth0/guardian/factors/client.rb +21 -5
  67. data/lib/auth0/guardian/factors/duo/settings/client.rb +12 -3
  68. data/lib/auth0/guardian/factors/email/client.rb +93 -0
  69. data/lib/auth0/guardian/factors/email/types/set_email_factor_settings_request_content.rb +17 -0
  70. data/lib/auth0/guardian/factors/phone/client.rb +110 -8
  71. data/lib/auth0/guardian/factors/phone/types/set_phone_factor_settings_request_content.rb +17 -0
  72. data/lib/auth0/guardian/factors/push_notification/client.rb +48 -12
  73. data/lib/auth0/guardian/factors/sms/client.rb +32 -9
  74. data/lib/auth0/guardian/policies/client.rb +8 -2
  75. data/lib/auth0/guardian/types/set_guardian_settings_request_content.rb +17 -0
  76. data/lib/auth0/hooks/client.rb +33 -4
  77. data/lib/auth0/hooks/secrets/client.rb +38 -4
  78. data/lib/auth0/jobs/client.rb +4 -1
  79. data/lib/auth0/jobs/errors/client.rb +9 -4
  80. data/lib/auth0/jobs/users_exports/client.rb +4 -1
  81. data/lib/auth0/jobs/users_imports/client.rb +14 -6
  82. data/lib/auth0/jobs/verification_email/client.rb +4 -1
  83. data/lib/auth0/keys/custom_signing/client.rb +13 -2
  84. data/lib/auth0/keys/encryption/client.rb +33 -5
  85. data/lib/auth0/keys/network_acls/client.rb +19 -3
  86. data/lib/auth0/keys/signing/client.rb +21 -7
  87. data/lib/auth0/log_streams/client.rb +29 -7
  88. data/lib/auth0/logs/client.rb +16 -2
  89. data/lib/auth0/network_acls/client.rb +41 -4
  90. data/lib/auth0/organizations/client.rb +109 -5
  91. data/lib/auth0/organizations/client_grants/client.rb +25 -2
  92. data/lib/auth0/organizations/clients/client.rb +38 -4
  93. data/lib/auth0/organizations/connections/client.rb +37 -4
  94. data/lib/auth0/organizations/connections/types/create_organization_all_connection_request_parameters.rb +2 -0
  95. data/lib/auth0/organizations/connections/types/update_organization_connection_request_parameters.rb +2 -0
  96. data/lib/auth0/organizations/discovery_domains/client.rb +42 -5
  97. data/lib/auth0/organizations/enabled_connections/client.rb +36 -4
  98. data/lib/auth0/organizations/groups/client.rb +8 -1
  99. data/lib/auth0/organizations/groups/roles/client.rb +23 -1
  100. data/lib/auth0/organizations/invitations/client.rb +40 -3
  101. data/lib/auth0/organizations/members/client.rb +23 -1
  102. data/lib/auth0/organizations/members/effective_roles/client.rb +9 -1
  103. data/lib/auth0/organizations/members/effective_roles/sources/groups/client.rb +10 -1
  104. data/lib/auth0/organizations/members/roles/client.rb +24 -1
  105. data/lib/auth0/organizations/organization_template/client.rb +16 -1
  106. data/lib/auth0/organizations/roles/groups/client.rb +9 -1
  107. data/lib/auth0/organizations/roles/members/client.rb +11 -1
  108. data/lib/auth0/organizations/types/search_organizations_request_parameters.rb +19 -0
  109. data/lib/auth0/prompts/client.rb +8 -2
  110. data/lib/auth0/prompts/custom_text/client.rb +20 -2
  111. data/lib/auth0/prompts/partials/client.rb +16 -2
  112. data/lib/auth0/prompts/rendering/client.rb +34 -4
  113. data/lib/auth0/rate_limit_policies/client.rb +37 -4
  114. data/lib/auth0/refresh_tokens/client.rb +25 -3
  115. data/lib/auth0/resource_servers/client.rb +102 -4
  116. data/lib/auth0/resource_servers/types/create_resource_server_request_content.rb +4 -0
  117. data/lib/auth0/resource_servers/types/search_resource_servers_request_parameters.rb +23 -0
  118. data/lib/auth0/resource_servers/types/update_resource_server_request_content.rb +4 -0
  119. data/lib/auth0/risk_assessments/settings/client.rb +8 -2
  120. data/lib/auth0/risk_assessments/settings/new_device/client.rb +8 -2
  121. data/lib/auth0/roles/client.rb +26 -4
  122. data/lib/auth0/roles/groups/client.rb +20 -1
  123. data/lib/auth0/roles/permissions/client.rb +27 -1
  124. data/lib/auth0/roles/users/client.rb +15 -1
  125. data/lib/auth0/rules/client.rb +33 -4
  126. data/lib/auth0/rules_configs/client.rb +19 -5
  127. data/lib/auth0/self_service_profiles/client.rb +23 -4
  128. data/lib/auth0/self_service_profiles/custom_text/client.rb +23 -3
  129. data/lib/auth0/self_service_profiles/sso_ticket/client.rb +10 -1
  130. data/lib/auth0/sessions/client.rb +14 -2
  131. data/lib/auth0/stats/client.rb +16 -5
  132. data/lib/auth0/supplemental_signals/client.rb +8 -2
  133. data/lib/auth0/tenants/settings/client.rb +11 -2
  134. data/lib/auth0/tenants/settings/types/update_tenant_settings_request_content.rb +2 -0
  135. data/lib/auth0/tickets/client.rb +8 -2
  136. data/lib/auth0/token_exchange_profiles/client.rb +26 -3
  137. data/lib/auth0/types/advance_ramp_response_content.rb +15 -0
  138. data/lib/auth0/types/anonymous_sessions.rb +10 -0
  139. data/lib/auth0/types/client.rb +6 -0
  140. data/lib/auth0/types/client_my_organization_patch_configuration.rb +4 -0
  141. data/lib/auth0/types/client_my_organization_post_configuration.rb +4 -0
  142. data/lib/auth0/types/client_my_organization_response_configuration.rb +4 -0
  143. data/lib/auth0/types/connection_identity_provider_enum.rb +4 -13
  144. data/lib/auth0/types/connection_options_ad.rb +2 -0
  145. data/lib/auth0/types/connection_options_adfs.rb +2 -0
  146. data/lib/auth0/types/connection_options_azure_ad.rb +2 -0
  147. data/lib/auth0/types/connection_options_common_saml.rb +2 -0
  148. data/lib/auth0/types/connection_options_ping_federate.rb +2 -0
  149. data/lib/auth0/types/connection_options_saml.rb +2 -0
  150. data/lib/auth0/types/connection_properties_options.rb +4 -0
  151. data/lib/auth0/types/connection_strategy_enum.rb +4 -13
  152. data/lib/auth0/types/connection_thumbprints_sha384.rb +23 -0
  153. data/lib/auth0/types/connection_thumbprints_sha384ad.rb +23 -0
  154. data/lib/auth0/types/connection_thumbprints_sha384saml.rb +23 -0
  155. data/lib/auth0/types/create_anonymous_sessions.rb +10 -0
  156. data/lib/auth0/types/create_client_response_content.rb +6 -0
  157. data/lib/auth0/types/create_organization_all_connection_response_content.rb +2 -0
  158. data/lib/auth0/types/create_resource_server_response_content.rb +4 -0
  159. data/lib/auth0/types/get_client_response_content.rb +6 -0
  160. data/lib/auth0/types/get_email_factor_settings_response_content.rb +11 -0
  161. data/lib/auth0/types/get_guardian_settings_response_content.rb +15 -0
  162. data/lib/auth0/types/get_organization_all_connection_response_content.rb +2 -0
  163. data/lib/auth0/types/get_phone_factor_settings_response_content.rb +11 -0
  164. data/lib/auth0/types/get_resource_server_response_content.rb +4 -0
  165. data/lib/auth0/types/get_tenant_settings_response_content.rb +2 -0
  166. data/lib/auth0/types/oauth_scope.rb +1 -2
  167. data/lib/auth0/types/organization_all_connection_post.rb +2 -0
  168. data/lib/auth0/types/organization_member_access_level_enum.rb +14 -0
  169. data/lib/auth0/types/organization_member_access_level_enum_with_null.rb +14 -0
  170. data/lib/auth0/types/organization_sort_field_enum.rb +13 -0
  171. data/lib/auth0/types/resource_server.rb +4 -0
  172. data/lib/auth0/types/resource_server_access_token.rb +10 -0
  173. data/lib/auth0/types/resource_server_access_token_claims_mapping.rb +10 -0
  174. data/lib/auth0/types/resource_server_access_token_custom_claims_mapping.rb +23 -0
  175. data/lib/auth0/types/resource_server_access_token_custom_claims_mapping_rule.rb +11 -0
  176. data/lib/auth0/types/resource_server_search_response.rb +53 -0
  177. data/lib/auth0/types/resource_server_sort_field_enum.rb +13 -0
  178. data/lib/auth0/types/resource_server_subject_type_authorization.rb +2 -0
  179. data/lib/auth0/types/resource_server_subject_type_authorization_anonymous_user.rb +10 -0
  180. data/lib/auth0/types/resource_server_subject_type_authorization_anonymous_user_policy_enum.rb +12 -0
  181. data/lib/auth0/types/rotate_client_secret_response_content.rb +6 -0
  182. data/lib/auth0/types/search_organization.rb +23 -0
  183. data/lib/auth0/types/{list_template_organizations_paginated_response_content.rb → search_organizations_paginated_response_content.rb} +3 -3
  184. data/lib/auth0/types/search_parser_enum.rb +12 -0
  185. data/lib/auth0/types/search_resource_servers_response_content.rb +11 -0
  186. data/lib/auth0/types/set_email_factor_settings_response_content.rb +11 -0
  187. data/lib/auth0/types/set_guardian_settings_response_content.rb +15 -0
  188. data/lib/auth0/types/set_phone_factor_settings_response_content.rb +11 -0
  189. data/lib/auth0/types/tenant_settings_sessions.rb +2 -0
  190. data/lib/auth0/types/tenant_settings_sessions_anonymous.rb +12 -0
  191. data/lib/auth0/types/update_anonymous_sessions.rb +10 -0
  192. data/lib/auth0/types/update_client_response_content.rb +6 -0
  193. data/lib/auth0/types/update_connection_options.rb +4 -0
  194. data/lib/auth0/types/update_organization_all_connection_response_content.rb +2 -0
  195. data/lib/auth0/types/update_resource_server_response_content.rb +4 -0
  196. data/lib/auth0/types/update_tenant_settings_response_content.rb +2 -0
  197. data/lib/auth0/user_attribute_profiles/client.rb +40 -6
  198. data/lib/auth0/user_blocks/client.rb +20 -2
  199. data/lib/auth0/user_grants/client.rb +17 -1
  200. data/lib/auth0/users/authentication_methods/client.rb +57 -9
  201. data/lib/auth0/users/authenticators/client.rb +3 -0
  202. data/lib/auth0/users/client.rb +54 -9
  203. data/lib/auth0/users/connected_accounts/client.rb +8 -1
  204. data/lib/auth0/users/effective_permissions/client.rb +9 -1
  205. data/lib/auth0/users/effective_permissions/sources/roles/client.rb +10 -1
  206. data/lib/auth0/users/effective_roles/client.rb +8 -1
  207. data/lib/auth0/users/effective_roles/sources/groups/client.rb +9 -1
  208. data/lib/auth0/users/enrollments/client.rb +9 -4
  209. data/lib/auth0/users/groups/client.rb +11 -1
  210. data/lib/auth0/users/identities/client.rb +17 -5
  211. data/lib/auth0/users/logs/client.rb +10 -1
  212. data/lib/auth0/users/multifactor/client.rb +9 -0
  213. data/lib/auth0/users/organizations/client.rb +9 -1
  214. data/lib/auth0/users/permissions/client.rb +27 -1
  215. data/lib/auth0/users/refresh_token/client.rb +12 -1
  216. data/lib/auth0/users/risk_assessments/client.rb +7 -0
  217. data/lib/auth0/users/roles/client.rb +21 -1
  218. data/lib/auth0/users/sessions/client.rb +12 -1
  219. data/lib/auth0/verifiable_credentials/verification/templates/client.rb +32 -4
  220. data/lib/auth0/version.rb +1 -1
  221. data/lib/auth0.rb +46 -16
  222. data/wiremock/wiremock-mappings.json +333 -191
  223. metadata +40 -10
  224. data/lib/auth0/organization_templates/client.rb +0 -220
  225. data/lib/auth0/organization_templates/types/create_organization_template_request_content.rb +0 -35
  226. data/lib/auth0/organization_templates/types/list_organization_templates_request_parameters.rb +0 -13
  227. data/lib/auth0/organization_templates/types/list_template_organizations_request_parameters.rb +0 -15
  228. data/lib/auth0/organization_templates/types/update_organization_template_request_content.rb +0 -37
  229. data/lib/auth0/types/list_organization_templates_paginated_response_content.rb +0 -11
  230. data/lib/auth0/types/organization_template_assigned_organization.rb +0 -10
@@ -0,0 +1,12 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Auth0
4
+ module Types
5
+ module SearchParserEnum
6
+ extend Auth0::Internal::Types::Enum
7
+
8
+ SCIM = "scim"
9
+ LUCENE = "lucene"
10
+ end
11
+ end
12
+ end
@@ -0,0 +1,11 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Auth0
4
+ module Types
5
+ class SearchResourceServersResponseContent < Internal::Types::Model
6
+ field :resource_servers, -> { Internal::Types::Array[Auth0::Types::ResourceServerSearchResponse] }, optional: false, nullable: false
7
+
8
+ field :next_, -> { String }, optional: true, nullable: false, api_name: "next"
9
+ end
10
+ end
11
+ end
@@ -0,0 +1,11 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Auth0
4
+ module Types
5
+ class SetEmailFactorSettingsResponseContent < Internal::Types::Model
6
+ field :otp_length, -> { Integer }, optional: false, nullable: false
7
+
8
+ field :otp_expiration_time, -> { Integer }, optional: false, nullable: false
9
+ end
10
+ end
11
+ end
@@ -0,0 +1,15 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Auth0
4
+ module Types
5
+ class SetGuardianSettingsResponseContent < Internal::Types::Model
6
+ field :display_remember_me_checkbox, -> { Internal::Types::Boolean }, optional: false, nullable: false
7
+
8
+ field :remember_me_default_value, -> { Internal::Types::Boolean }, optional: false, nullable: false
9
+
10
+ field :mfa_session_inactivity_timeout, -> { Integer }, optional: false, nullable: false
11
+
12
+ field :mfa_session_overall_timeout, -> { Integer }, optional: false, nullable: false
13
+ end
14
+ end
15
+ end
@@ -0,0 +1,11 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Auth0
4
+ module Types
5
+ class SetPhoneFactorSettingsResponseContent < Internal::Types::Model
6
+ field :otp_length, -> { Integer }, optional: false, nullable: false
7
+
8
+ field :otp_expiration_time, -> { Integer }, optional: false, nullable: false
9
+ end
10
+ end
11
+ end
@@ -5,6 +5,8 @@ module Auth0
5
5
  # Sessions related settings for tenant
6
6
  class TenantSettingsSessions < Internal::Types::Model
7
7
  field :oidc_logout_prompt_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false
8
+
9
+ field :anonymous, -> { Auth0::Types::TenantSettingsSessionsAnonymous }, optional: true, nullable: false
8
10
  end
9
11
  end
10
12
  end
@@ -0,0 +1,12 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Auth0
4
+ module Types
5
+ # Anonymous session settings for tenant.
6
+ class TenantSettingsSessionsAnonymous < Internal::Types::Model
7
+ field :lifetime_in_minutes, -> { Integer }, optional: true, nullable: false
8
+
9
+ field :activate_cookie, -> { Internal::Types::Boolean }, optional: true, nullable: false
10
+ end
11
+ end
12
+ end
@@ -0,0 +1,10 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Auth0
4
+ module Types
5
+ # Anonymous sessions configuration for this client.
6
+ class UpdateAnonymousSessions < Internal::Types::Model
7
+ field :active, -> { Internal::Types::Boolean }, optional: false, nullable: false
8
+ end
9
+ end
10
+ end
@@ -5,6 +5,10 @@ module Auth0
5
5
  class UpdateClientResponseContent < Internal::Types::Model
6
6
  field :client_id, -> { String }, optional: true, nullable: false
7
7
 
8
+ field :created_at, -> { String }, optional: true, nullable: false
9
+
10
+ field :updated_at, -> { String }, optional: true, nullable: false
11
+
8
12
  field :tenant, -> { String }, optional: true, nullable: false
9
13
 
10
14
  field :name, -> { String }, optional: true, nullable: false
@@ -117,6 +121,8 @@ module Auth0
117
121
 
118
122
  field :identity_assertion_authorization_grant, -> { Auth0::Types::IdentityAssertionAuthorizationGrant }, optional: true, nullable: false
119
123
 
124
+ field :anonymous_sessions, -> { Auth0::Types::AnonymousSessions }, optional: true, nullable: false
125
+
120
126
  field :third_party_security_mode, -> { Auth0::Types::ClientThirdPartySecurityModeEnum }, optional: true, nullable: false
121
127
 
122
128
  field :redirection_policy, -> { Auth0::Types::ClientRedirectionPolicyEnum }, optional: true, nullable: false
@@ -90,6 +90,10 @@ module Auth0
90
90
  field :discovery_url, -> { String }, optional: true, nullable: false
91
91
 
92
92
  field :oidc_metadata, -> { Auth0::Types::ConnectionsOidcMetadata }, optional: true, nullable: false
93
+
94
+ field :thumbprints, -> { Internal::Types::Array[String] }, optional: true, nullable: false
95
+
96
+ field :thumbprints_sha384, -> { Internal::Types::Array[String] }, optional: true, nullable: false
93
97
  end
94
98
  end
95
99
  end
@@ -13,6 +13,8 @@ module Auth0
13
13
 
14
14
  field :organization_access_level, -> { Auth0::Types::OrganizationAccessLevelEnum }, optional: true, nullable: false
15
15
 
16
+ field :organization_member_access_level, -> { Auth0::Types::OrganizationMemberAccessLevelEnum }, optional: true, nullable: false
17
+
16
18
  field :is_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false
17
19
 
18
20
  field :connection_id, -> { String }, optional: false, nullable: false
@@ -31,8 +31,12 @@ module Auth0
31
31
 
32
32
  field :enforce_policies, -> { Internal::Types::Boolean }, optional: true, nullable: false
33
33
 
34
+ field :token_lifetime_for_anonymous_access_tokens, -> { Integer }, optional: true, nullable: false
35
+
34
36
  field :token_dialect, -> { Auth0::Types::ResourceServerTokenDialectResponseEnum }, optional: true, nullable: false
35
37
 
38
+ field :access_token, -> { Auth0::Types::ResourceServerAccessToken }, optional: true, nullable: false
39
+
36
40
  field :token_encryption, -> { Auth0::Types::ResourceServerTokenEncryption }, optional: true, nullable: false
37
41
 
38
42
  field :consent_policy, -> { Auth0::Types::ResourceServerConsentPolicyEnum }, optional: true, nullable: false
@@ -47,6 +47,8 @@ module Auth0
47
47
 
48
48
  field :enabled_locales, -> { Internal::Types::Array[Auth0::Types::SupportedLocales] }, optional: true, nullable: false
49
49
 
50
+ field :access_token, -> { Auth0::Types::ResourceServerAccessToken }, optional: true, nullable: false
51
+
50
52
  field :security_headers, -> { Auth0::Types::TenantSettingsNullableSecurityHeaders }, optional: true, nullable: false
51
53
 
52
54
  field :session_cookie, -> { Auth0::Types::SessionCookieSchema }, optional: true, nullable: false
@@ -22,6 +22,12 @@ module Auth0
22
22
  # @option params [String, nil] :from
23
23
  # @option params [Integer, nil] :take
24
24
  #
25
+ # @example
26
+ # client.user_attribute_profiles.list(
27
+ # from: "from",
28
+ # take: 1
29
+ # )
30
+ #
25
31
  # @return [Auth0::Types::ListUserAttributeProfilesPaginatedResponseContent]
26
32
  def list(request_options: {}, **params)
27
33
  params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -49,7 +55,7 @@ module Auth0
49
55
  end
50
56
  code = response.code.to_i
51
57
  if code.between?(200, 299)
52
- parsed_response = Auth0::Types::ListUserAttributeProfilesPaginatedResponseContent.load(response.body)
58
+ parsed_response = (response.body.to_s.empty? ? nil : Auth0::Types::ListUserAttributeProfilesPaginatedResponseContent.load(response.body))
53
59
  [parsed_response, response]
54
60
  else
55
61
  error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
@@ -68,6 +74,19 @@ module Auth0
68
74
  # @option request_options [Hash{String => Object}] :additional_body_parameters
69
75
  # @option request_options [Integer] :timeout_in_seconds
70
76
  #
77
+ # @example
78
+ # client.user_attribute_profiles.create(
79
+ # name: "name",
80
+ # user_attributes: {
81
+ # key: {
82
+ # description: "description",
83
+ # label: "label",
84
+ # profile_required: true,
85
+ # auth0mapping: "auth0_mapping"
86
+ # }
87
+ # }
88
+ # )
89
+ #
71
90
  # @return [Auth0::Types::CreateUserAttributeProfileResponseContent]
72
91
  def create(request_options: {}, **params)
73
92
  params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -85,7 +104,7 @@ module Auth0
85
104
  end
86
105
  code = response.code.to_i
87
106
  if code.between?(200, 299)
88
- Auth0::Types::CreateUserAttributeProfileResponseContent.load(response.body)
107
+ (response.body.to_s.empty? ? nil : Auth0::Types::CreateUserAttributeProfileResponseContent.load(response.body))
89
108
  else
90
109
  error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
91
110
  raise error_class.new(response.body, code: code)
@@ -102,6 +121,9 @@ module Auth0
102
121
  # @option request_options [Hash{String => Object}] :additional_body_parameters
103
122
  # @option request_options [Integer] :timeout_in_seconds
104
123
  #
124
+ # @example
125
+ # client.user_attribute_profiles.list_templates
126
+ #
105
127
  # @return [Auth0::Types::ListUserAttributeProfileTemplateResponseContent]
106
128
  def list_templates(request_options: {}, **_params)
107
129
  request = Auth0::Internal::JSON::Request.new(
@@ -117,7 +139,7 @@ module Auth0
117
139
  end
118
140
  code = response.code.to_i
119
141
  if code.between?(200, 299)
120
- Auth0::Types::ListUserAttributeProfileTemplateResponseContent.load(response.body)
142
+ (response.body.to_s.empty? ? nil : Auth0::Types::ListUserAttributeProfileTemplateResponseContent.load(response.body))
121
143
  else
122
144
  error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
123
145
  raise error_class.new(response.body, code: code)
@@ -135,6 +157,9 @@ module Auth0
135
157
  # @option request_options [Integer] :timeout_in_seconds
136
158
  # @option params [String] :id
137
159
  #
160
+ # @example
161
+ # client.user_attribute_profiles.get_template(id: "id")
162
+ #
138
163
  # @return [Auth0::Types::GetUserAttributeProfileTemplateResponseContent]
139
164
  def get_template(request_options: {}, **params)
140
165
  params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -151,7 +176,7 @@ module Auth0
151
176
  end
152
177
  code = response.code.to_i
153
178
  if code.between?(200, 299)
154
- Auth0::Types::GetUserAttributeProfileTemplateResponseContent.load(response.body)
179
+ (response.body.to_s.empty? ? nil : Auth0::Types::GetUserAttributeProfileTemplateResponseContent.load(response.body))
155
180
  else
156
181
  error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
157
182
  raise error_class.new(response.body, code: code)
@@ -169,6 +194,9 @@ module Auth0
169
194
  # @option request_options [Integer] :timeout_in_seconds
170
195
  # @option params [String] :id
171
196
  #
197
+ # @example
198
+ # client.user_attribute_profiles.get(id: "id")
199
+ #
172
200
  # @return [Auth0::Types::GetUserAttributeProfileResponseContent]
173
201
  def get(request_options: {}, **params)
174
202
  params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -185,7 +213,7 @@ module Auth0
185
213
  end
186
214
  code = response.code.to_i
187
215
  if code.between?(200, 299)
188
- Auth0::Types::GetUserAttributeProfileResponseContent.load(response.body)
216
+ (response.body.to_s.empty? ? nil : Auth0::Types::GetUserAttributeProfileResponseContent.load(response.body))
189
217
  else
190
218
  error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
191
219
  raise error_class.new(response.body, code: code)
@@ -203,6 +231,9 @@ module Auth0
203
231
  # @option request_options [Integer] :timeout_in_seconds
204
232
  # @option params [String] :id
205
233
  #
234
+ # @example
235
+ # client.user_attribute_profiles.delete(id: "id")
236
+ #
206
237
  # @return [untyped]
207
238
  def delete(request_options: {}, **params)
208
239
  params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -235,6 +266,9 @@ module Auth0
235
266
  # @option request_options [Integer] :timeout_in_seconds
236
267
  # @option params [String] :id
237
268
  #
269
+ # @example
270
+ # client.user_attribute_profiles.update(id: "id")
271
+ #
238
272
  # @return [Auth0::Types::UpdateUserAttributeProfileResponseContent]
239
273
  def update(request_options: {}, **params)
240
274
  params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -256,7 +290,7 @@ module Auth0
256
290
  end
257
291
  code = response.code.to_i
258
292
  if code.between?(200, 299)
259
- Auth0::Types::UpdateUserAttributeProfileResponseContent.load(response.body)
293
+ (response.body.to_s.empty? ? nil : Auth0::Types::UpdateUserAttributeProfileResponseContent.load(response.body))
260
294
  else
261
295
  error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
262
296
  raise error_class.new(response.body, code: code)
@@ -24,6 +24,12 @@ module Auth0
24
24
  # @option params [String] :identifier
25
25
  # @option params [Boolean, nil] :consider_brute_force_enablement
26
26
  #
27
+ # @example
28
+ # client.user_blocks.list_by_identifier(
29
+ # identifier: "identifier",
30
+ # consider_brute_force_enablement: true
31
+ # )
32
+ #
27
33
  # @return [Auth0::Types::ListUserBlocksByIdentifierResponseContent]
28
34
  def list_by_identifier(request_options: {}, **params)
29
35
  params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -45,7 +51,7 @@ module Auth0
45
51
  end
46
52
  code = response.code.to_i
47
53
  if code.between?(200, 299)
48
- Auth0::Types::ListUserBlocksByIdentifierResponseContent.load(response.body)
54
+ (response.body.to_s.empty? ? nil : Auth0::Types::ListUserBlocksByIdentifierResponseContent.load(response.body))
49
55
  else
50
56
  error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
51
57
  raise error_class.new(response.body, code: code)
@@ -67,6 +73,9 @@ module Auth0
67
73
  # @option request_options [Integer] :timeout_in_seconds
68
74
  # @option params [String] :identifier
69
75
  #
76
+ # @example
77
+ # client.user_blocks.delete_by_identifier(identifier: "identifier")
78
+ #
70
79
  # @return [untyped]
71
80
  def delete_by_identifier(request_options: {}, **params)
72
81
  params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -106,6 +115,12 @@ module Auth0
106
115
  # @option params [String] :id
107
116
  # @option params [Boolean, nil] :consider_brute_force_enablement
108
117
  #
118
+ # @example
119
+ # client.user_blocks.list(
120
+ # id: "id",
121
+ # consider_brute_force_enablement: true
122
+ # )
123
+ #
109
124
  # @return [Auth0::Types::ListUserBlocksResponseContent]
110
125
  def list(request_options: {}, **params)
111
126
  params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -126,7 +141,7 @@ module Auth0
126
141
  end
127
142
  code = response.code.to_i
128
143
  if code.between?(200, 299)
129
- Auth0::Types::ListUserBlocksResponseContent.load(response.body)
144
+ (response.body.to_s.empty? ? nil : Auth0::Types::ListUserBlocksResponseContent.load(response.body))
130
145
  else
131
146
  error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
132
147
  raise error_class.new(response.body, code: code)
@@ -148,6 +163,9 @@ module Auth0
148
163
  # @option request_options [Integer] :timeout_in_seconds
149
164
  # @option params [String] :id
150
165
  #
166
+ # @example
167
+ # client.user_blocks.delete(id: "id")
168
+ #
151
169
  # @return [untyped]
152
170
  def delete(request_options: {}, **params)
153
171
  params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -26,6 +26,16 @@ module Auth0
26
26
  # @option params [String, nil] :client_id
27
27
  # @option params [String, nil] :audience
28
28
  #
29
+ # @example
30
+ # client.user_grants.list(
31
+ # per_page: 1,
32
+ # page: 1,
33
+ # include_totals: true,
34
+ # user_id: "user_id",
35
+ # client_id: "client_id",
36
+ # audience: "audience"
37
+ # )
38
+ #
29
39
  # @return [Auth0::Types::ListUserGrantsOffsetPaginatedResponseContent]
30
40
  def list(request_options: {}, **params)
31
41
  params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -58,7 +68,7 @@ module Auth0
58
68
  end
59
69
  code = response.code.to_i
60
70
  if code.between?(200, 299)
61
- parsed_response = Auth0::Types::ListUserGrantsOffsetPaginatedResponseContent.load(response.body)
71
+ parsed_response = (response.body.to_s.empty? ? nil : Auth0::Types::ListUserGrantsOffsetPaginatedResponseContent.load(response.body))
62
72
  [parsed_response, response]
63
73
  else
64
74
  error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
@@ -78,6 +88,9 @@ module Auth0
78
88
  # @option request_options [Integer] :timeout_in_seconds
79
89
  # @option params [String] :user_id
80
90
  #
91
+ # @example
92
+ # client.user_grants.delete_by_user_id(user_id: "user_id")
93
+ #
81
94
  # @return [untyped]
82
95
  def delete_by_user_id(request_options: {}, **params)
83
96
  params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -114,6 +127,9 @@ module Auth0
114
127
  # @option request_options [Integer] :timeout_in_seconds
115
128
  # @option params [String] :id
116
129
  #
130
+ # @example
131
+ # client.user_grants.delete(id: "id")
132
+ #
117
133
  # @return [untyped]
118
134
  def delete(request_options: {}, **params)
119
135
  params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -25,6 +25,14 @@ module Auth0
25
25
  # @option params [Integer, nil] :per_page
26
26
  # @option params [Boolean, nil] :include_totals
27
27
  #
28
+ # @example
29
+ # client.users.authentication_methods.list(
30
+ # id: "id",
31
+ # page: 1,
32
+ # per_page: 1,
33
+ # include_totals: true
34
+ # )
35
+ #
28
36
  # @return [Auth0::Types::ListUserAuthenticationMethodsOffsetPaginatedResponseContent]
29
37
  def list(request_options: {}, **params)
30
38
  params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -54,7 +62,7 @@ module Auth0
54
62
  end
55
63
  code = response.code.to_i
56
64
  if code.between?(200, 299)
57
- parsed_response = Auth0::Types::ListUserAuthenticationMethodsOffsetPaginatedResponseContent.load(response.body)
65
+ parsed_response = (response.body.to_s.empty? ? nil : Auth0::Types::ListUserAuthenticationMethodsOffsetPaginatedResponseContent.load(response.body))
58
66
  [parsed_response, response]
59
67
  else
60
68
  error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
@@ -75,6 +83,12 @@ module Auth0
75
83
  # @option request_options [Integer] :timeout_in_seconds
76
84
  # @option params [String] :id
77
85
  #
86
+ # @example
87
+ # client.users.authentication_methods.create(
88
+ # id: "id",
89
+ # type: "phone"
90
+ # )
91
+ #
78
92
  # @return [Auth0::Types::CreateUserAuthenticationMethodResponseContent]
79
93
  def create(request_options: {}, **params)
80
94
  params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -96,7 +110,7 @@ module Auth0
96
110
  end
97
111
  code = response.code.to_i
98
112
  if code.between?(200, 299)
99
- Auth0::Types::CreateUserAuthenticationMethodResponseContent.load(response.body)
113
+ (response.body.to_s.empty? ? nil : Auth0::Types::CreateUserAuthenticationMethodResponseContent.load(response.body))
100
114
  else
101
115
  error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
102
116
  raise error_class.new(response.body, code: code)
@@ -119,14 +133,25 @@ module Auth0
119
133
  # @option request_options [Integer] :timeout_in_seconds
120
134
  # @option params [String] :id
121
135
  #
136
+ # @example
137
+ # client.users.authentication_methods.set(
138
+ # id: "id",
139
+ # request: [{
140
+ # type: "phone"
141
+ # }]
142
+ # )
143
+ #
122
144
  # @return [Array[Auth0::Types::SetUserAuthenticationMethodResponseContent]]
123
145
  def set(request_options: {}, **params)
124
146
  params = Auth0::Internal::Types::Utils.normalize_keys(params)
147
+ path_param_names = %i[id]
148
+ body_params = params.except(*path_param_names)
149
+
125
150
  request = Auth0::Internal::JSON::Request.new(
126
151
  base_url: request_options[:base_url],
127
152
  method: "PUT",
128
153
  path: "users/#{URI.encode_uri_component(params[:id].to_s)}/authentication-methods",
129
- body: params,
154
+ body: body_params,
130
155
  request_options: request_options
131
156
  )
132
157
  begin
@@ -135,10 +160,12 @@ module Auth0
135
160
  raise Auth0::Errors::TimeoutError
136
161
  end
137
162
  code = response.code.to_i
138
- return if code.between?(200, 299)
139
-
140
- error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
141
- raise error_class.new(response.body, code: code)
163
+ if code.between?(200, 299)
164
+ Auth0::Internal::Types::Utils.coerce(Internal::Types::Array[Auth0::Types::SetUserAuthenticationMethodResponseContent], (response.body.to_s.empty? ? nil : JSON.parse(response.body, symbolize_names: true)))
165
+ else
166
+ error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
167
+ raise error_class.new(response.body, code: code)
168
+ end
142
169
  end
143
170
 
144
171
  # Remove all authentication methods (i.e., enrolled MFA factors) from the specified user account. This action
@@ -153,6 +180,9 @@ module Auth0
153
180
  # @option request_options [Integer] :timeout_in_seconds
154
181
  # @option params [String] :id
155
182
  #
183
+ # @example
184
+ # client.users.authentication_methods.delete_all(id: "id")
185
+ #
156
186
  # @return [untyped]
157
187
  def delete_all(request_options: {}, **params)
158
188
  params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -184,6 +214,12 @@ module Auth0
184
214
  # @option params [String] :id
185
215
  # @option params [String] :authentication_method_id
186
216
  #
217
+ # @example
218
+ # client.users.authentication_methods.get(
219
+ # id: "id",
220
+ # authentication_method_id: "authentication_method_id"
221
+ # )
222
+ #
187
223
  # @return [Auth0::Types::GetUserAuthenticationMethodResponseContent]
188
224
  def get(request_options: {}, **params)
189
225
  params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -200,7 +236,7 @@ module Auth0
200
236
  end
201
237
  code = response.code.to_i
202
238
  if code.between?(200, 299)
203
- Auth0::Types::GetUserAuthenticationMethodResponseContent.load(response.body)
239
+ (response.body.to_s.empty? ? nil : Auth0::Types::GetUserAuthenticationMethodResponseContent.load(response.body))
204
240
  else
205
241
  error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
206
242
  raise error_class.new(response.body, code: code)
@@ -221,6 +257,12 @@ module Auth0
221
257
  # @option params [String] :id
222
258
  # @option params [String] :authentication_method_id
223
259
  #
260
+ # @example
261
+ # client.users.authentication_methods.delete(
262
+ # id: "id",
263
+ # authentication_method_id: "authentication_method_id"
264
+ # )
265
+ #
224
266
  # @return [untyped]
225
267
  def delete(request_options: {}, **params)
226
268
  params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -256,6 +298,12 @@ module Auth0
256
298
  # @option params [String] :id
257
299
  # @option params [String] :authentication_method_id
258
300
  #
301
+ # @example
302
+ # client.users.authentication_methods.update(
303
+ # id: "id",
304
+ # authentication_method_id: "authentication_method_id"
305
+ # )
306
+ #
259
307
  # @return [Auth0::Types::UpdateUserAuthenticationMethodResponseContent]
260
308
  def update(request_options: {}, **params)
261
309
  params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -277,7 +325,7 @@ module Auth0
277
325
  end
278
326
  code = response.code.to_i
279
327
  if code.between?(200, 299)
280
- Auth0::Types::UpdateUserAuthenticationMethodResponseContent.load(response.body)
328
+ (response.body.to_s.empty? ? nil : Auth0::Types::UpdateUserAuthenticationMethodResponseContent.load(response.body))
281
329
  else
282
330
  error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
283
331
  raise error_class.new(response.body, code: code)
@@ -24,6 +24,9 @@ module Auth0
24
24
  # @option request_options [Integer] :timeout_in_seconds
25
25
  # @option params [String] :id
26
26
  #
27
+ # @example
28
+ # client.users.authenticators.delete_all(id: "id")
29
+ #
27
30
  # @return [untyped]
28
31
  def delete_all(request_options: {}, **params)
29
32
  params = Auth0::Internal::Types::Utils.normalize_keys(params)