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
@@ -25,6 +25,15 @@ module Auth0
25
25
  # @option params [Boolean, nil] :include_totals
26
26
  # @option params [Boolean, nil] :include_fields
27
27
  #
28
+ # @example
29
+ # client.resource_servers.list(
30
+ # identifiers: ["identifiers"],
31
+ # page: 1,
32
+ # per_page: 1,
33
+ # include_totals: true,
34
+ # include_fields: true
35
+ # )
36
+ #
28
37
  # @return [Auth0::Types::ListResourceServerOffsetPaginatedResponseContent]
29
38
  def list(request_options: {}, **params)
30
39
  params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -56,7 +65,7 @@ module Auth0
56
65
  end
57
66
  code = response.code.to_i
58
67
  if code.between?(200, 299)
59
- parsed_response = Auth0::Types::ListResourceServerOffsetPaginatedResponseContent.load(response.body)
68
+ parsed_response = (response.body.to_s.empty? ? nil : Auth0::Types::ListResourceServerOffsetPaginatedResponseContent.load(response.body))
60
69
  [parsed_response, response]
61
70
  else
62
71
  error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
@@ -76,6 +85,9 @@ module Auth0
76
85
  # @option request_options [Hash{String => Object}] :additional_body_parameters
77
86
  # @option request_options [Integer] :timeout_in_seconds
78
87
  #
88
+ # @example
89
+ # client.resource_servers.create(identifier: "identifier")
90
+ #
79
91
  # @return [Auth0::Types::CreateResourceServerResponseContent]
80
92
  def create(request_options: {}, **params)
81
93
  params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -93,13 +105,87 @@ module Auth0
93
105
  end
94
106
  code = response.code.to_i
95
107
  if code.between?(200, 299)
96
- Auth0::Types::CreateResourceServerResponseContent.load(response.body)
108
+ (response.body.to_s.empty? ? nil : Auth0::Types::CreateResourceServerResponseContent.load(response.body))
97
109
  else
98
110
  error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
99
111
  raise error_class.new(response.body, code: code)
100
112
  end
101
113
  end
102
114
 
115
+ # Search resource servers using SCIM or Lucene filter syntax with low-latency, eventually consistent results. Use
116
+ # the parser parameter to specify "scim" or "lucene" syntax (default: "lucene"). This endpoint provides an
117
+ # alternative to the standard GET /resource-servers endpoint with better performance for complex queries.
118
+ # Results may not reflect recent updates immediately.
119
+ #
120
+ # The `signing_secret` field is not supported by this endpoint.
121
+ #
122
+ # @param request_options [Hash]
123
+ # @param params [Hash]
124
+ # @option request_options [String] :base_url
125
+ # @option request_options [Hash{String => Object}] :additional_headers
126
+ # @option request_options [Hash{String => Object}] :additional_query_parameters
127
+ # @option request_options [Hash{String => Object}] :additional_body_parameters
128
+ # @option request_options [Integer] :timeout_in_seconds
129
+ # @option params [String, nil] :q
130
+ # @option params [Auth0::Types::SearchParserEnum, nil] :parser
131
+ # @option params [String, nil] :fields
132
+ # @option params [Boolean, nil] :include_fields
133
+ # @option params [Integer, nil] :take
134
+ # @option params [String, nil] :from
135
+ # @option params [Auth0::Types::ResourceServerSortFieldEnum, nil] :sort
136
+ #
137
+ # @example
138
+ # client.resource_servers.search(
139
+ # q: "q",
140
+ # parser: "scim",
141
+ # fields: "fields",
142
+ # include_fields: true,
143
+ # take: 1,
144
+ # from: "from",
145
+ # sort: "identifier"
146
+ # )
147
+ #
148
+ # @return [Auth0::Types::SearchResourceServersResponseContent]
149
+ def search(request_options: {}, **params)
150
+ params = Auth0::Internal::Types::Utils.normalize_keys(params)
151
+ query_params = {}
152
+ query_params["q"] = params[:q] if params.key?(:q)
153
+ query_params["parser"] = params[:parser] if params.key?(:parser)
154
+ query_params["fields"] = params[:fields] if params.key?(:fields)
155
+ query_params["include_fields"] = params[:include_fields] if params.key?(:include_fields)
156
+ query_params["take"] = params.fetch(:take, 50)
157
+ query_params["from"] = params[:from] if params.key?(:from)
158
+ query_params["sort"] = params[:sort] if params.key?(:sort)
159
+
160
+ Auth0::Internal::CursorItemIterator.new(
161
+ cursor_field: :next_,
162
+ item_field: :resource_servers,
163
+ initial_cursor: query_params["from"]
164
+ ) do |next_cursor|
165
+ query_params["from"] = next_cursor
166
+ request = Auth0::Internal::JSON::Request.new(
167
+ base_url: request_options[:base_url],
168
+ method: "GET",
169
+ path: "resource-servers/search",
170
+ query: query_params,
171
+ request_options: request_options
172
+ )
173
+ begin
174
+ response = @client.send(request)
175
+ rescue Net::HTTPRequestTimeout
176
+ raise Auth0::Errors::TimeoutError
177
+ end
178
+ code = response.code.to_i
179
+ if code.between?(200, 299)
180
+ parsed_response = (response.body.to_s.empty? ? nil : Auth0::Types::SearchResourceServersResponseContent.load(response.body))
181
+ [parsed_response, response]
182
+ else
183
+ error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
184
+ raise error_class.new(response.body, code: code)
185
+ end
186
+ end
187
+ end
188
+
103
189
  # Retrieve <a href="https://auth0.com/docs/apis">API</a> details with the given ID.
104
190
  #
105
191
  # @param request_options [Hash]
@@ -112,6 +198,12 @@ module Auth0
112
198
  # @option params [String] :id
113
199
  # @option params [Boolean, nil] :include_fields
114
200
  #
201
+ # @example
202
+ # client.resource_servers.get(
203
+ # id: "id",
204
+ # include_fields: true
205
+ # )
206
+ #
115
207
  # @return [Auth0::Types::GetResourceServerResponseContent]
116
208
  def get(request_options: {}, **params)
117
209
  params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -132,7 +224,7 @@ module Auth0
132
224
  end
133
225
  code = response.code.to_i
134
226
  if code.between?(200, 299)
135
- Auth0::Types::GetResourceServerResponseContent.load(response.body)
227
+ (response.body.to_s.empty? ? nil : Auth0::Types::GetResourceServerResponseContent.load(response.body))
136
228
  else
137
229
  error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
138
230
  raise error_class.new(response.body, code: code)
@@ -151,6 +243,9 @@ module Auth0
151
243
  # @option request_options [Integer] :timeout_in_seconds
152
244
  # @option params [String] :id
153
245
  #
246
+ # @example
247
+ # client.resource_servers.delete(id: "id")
248
+ #
154
249
  # @return [untyped]
155
250
  def delete(request_options: {}, **params)
156
251
  params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -184,6 +279,9 @@ module Auth0
184
279
  # @option request_options [Integer] :timeout_in_seconds
185
280
  # @option params [String] :id
186
281
  #
282
+ # @example
283
+ # client.resource_servers.update(id: "id")
284
+ #
187
285
  # @return [Auth0::Types::UpdateResourceServerResponseContent]
188
286
  def update(request_options: {}, **params)
189
287
  params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -205,7 +303,7 @@ module Auth0
205
303
  end
206
304
  code = response.code.to_i
207
305
  if code.between?(200, 299)
208
- Auth0::Types::UpdateResourceServerResponseContent.load(response.body)
306
+ (response.body.to_s.empty? ? nil : Auth0::Types::UpdateResourceServerResponseContent.load(response.body))
209
307
  else
210
308
  error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
211
309
  raise error_class.new(response.body, code: code)
@@ -22,12 +22,16 @@ module Auth0
22
22
 
23
23
  field :token_lifetime, -> { Integer }, optional: true, nullable: false
24
24
 
25
+ field :token_lifetime_for_anonymous_access_tokens, -> { Integer }, optional: true, nullable: false
26
+
25
27
  field :token_dialect, -> { Auth0::Types::ResourceServerTokenDialectSchemaEnum }, optional: true, nullable: false
26
28
 
27
29
  field :skip_consent_for_verifiable_first_party_clients, -> { Internal::Types::Boolean }, optional: true, nullable: false
28
30
 
29
31
  field :enforce_policies, -> { Internal::Types::Boolean }, optional: true, nullable: false
30
32
 
33
+ field :access_token, -> { Auth0::Types::ResourceServerAccessToken }, optional: true, nullable: false
34
+
31
35
  field :token_encryption, -> { Auth0::Types::ResourceServerTokenEncryption }, optional: true, nullable: false
32
36
 
33
37
  field :consent_policy, -> { Auth0::Types::ResourceServerConsentPolicyEnum }, optional: true, nullable: false
@@ -0,0 +1,23 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Auth0
4
+ module ResourceServers
5
+ module Types
6
+ class SearchResourceServersRequestParameters < Internal::Types::Model
7
+ field :q, -> { String }, optional: true, nullable: false
8
+
9
+ field :parser, -> { Auth0::Types::SearchParserEnum }, optional: true, nullable: false
10
+
11
+ field :fields, -> { String }, optional: true, nullable: false
12
+
13
+ field :include_fields, -> { Internal::Types::Boolean }, optional: true, nullable: false
14
+
15
+ field :take, -> { Integer }, optional: true, nullable: false
16
+
17
+ field :from, -> { String }, optional: true, nullable: false
18
+
19
+ field :sort, -> { Auth0::Types::ResourceServerSortFieldEnum }, optional: true, nullable: false
20
+ end
21
+ end
22
+ end
23
+ end
@@ -24,10 +24,14 @@ module Auth0
24
24
 
25
25
  field :token_lifetime, -> { Integer }, optional: true, nullable: false
26
26
 
27
+ field :token_lifetime_for_anonymous_access_tokens, -> { Integer }, optional: true, nullable: false
28
+
27
29
  field :token_dialect, -> { Auth0::Types::ResourceServerTokenDialectSchemaEnum }, optional: true, nullable: false
28
30
 
29
31
  field :enforce_policies, -> { Internal::Types::Boolean }, optional: true, nullable: false
30
32
 
33
+ field :access_token, -> { Auth0::Types::ResourceServerAccessToken }, optional: true, nullable: false
34
+
31
35
  field :token_encryption, -> { Auth0::Types::ResourceServerTokenEncryption }, optional: true, nullable: false
32
36
 
33
37
  field :consent_policy, -> { Auth0::Types::ResourceServerConsentPolicyEnum }, optional: true, nullable: false
@@ -21,6 +21,9 @@ module Auth0
21
21
  # @option request_options [Hash{String => Object}] :additional_body_parameters
22
22
  # @option request_options [Integer] :timeout_in_seconds
23
23
  #
24
+ # @example
25
+ # client.risk_assessments.settings.get
26
+ #
24
27
  # @return [Auth0::Types::GetRiskAssessmentsSettingsResponseContent]
25
28
  def get(request_options: {}, **_params)
26
29
  request = Auth0::Internal::JSON::Request.new(
@@ -36,7 +39,7 @@ module Auth0
36
39
  end
37
40
  code = response.code.to_i
38
41
  if code.between?(200, 299)
39
- Auth0::Types::GetRiskAssessmentsSettingsResponseContent.load(response.body)
42
+ (response.body.to_s.empty? ? nil : Auth0::Types::GetRiskAssessmentsSettingsResponseContent.load(response.body))
40
43
  else
41
44
  error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
42
45
  raise error_class.new(response.body, code: code)
@@ -53,6 +56,9 @@ module Auth0
53
56
  # @option request_options [Hash{String => Object}] :additional_body_parameters
54
57
  # @option request_options [Integer] :timeout_in_seconds
55
58
  #
59
+ # @example
60
+ # client.risk_assessments.settings.update(enabled: true)
61
+ #
56
62
  # @return [Auth0::Types::UpdateRiskAssessmentsSettingsResponseContent]
57
63
  def update(request_options: {}, **params)
58
64
  params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -70,7 +76,7 @@ module Auth0
70
76
  end
71
77
  code = response.code.to_i
72
78
  if code.between?(200, 299)
73
- Auth0::Types::UpdateRiskAssessmentsSettingsResponseContent.load(response.body)
79
+ (response.body.to_s.empty? ? nil : Auth0::Types::UpdateRiskAssessmentsSettingsResponseContent.load(response.body))
74
80
  else
75
81
  error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
76
82
  raise error_class.new(response.body, code: code)
@@ -22,6 +22,9 @@ module Auth0
22
22
  # @option request_options [Hash{String => Object}] :additional_body_parameters
23
23
  # @option request_options [Integer] :timeout_in_seconds
24
24
  #
25
+ # @example
26
+ # client.risk_assessments.settings.new_device.get
27
+ #
25
28
  # @return [Auth0::Types::GetRiskAssessmentsSettingsNewDeviceResponseContent]
26
29
  def get(request_options: {}, **_params)
27
30
  request = Auth0::Internal::JSON::Request.new(
@@ -37,7 +40,7 @@ module Auth0
37
40
  end
38
41
  code = response.code.to_i
39
42
  if code.between?(200, 299)
40
- Auth0::Types::GetRiskAssessmentsSettingsNewDeviceResponseContent.load(response.body)
43
+ (response.body.to_s.empty? ? nil : Auth0::Types::GetRiskAssessmentsSettingsNewDeviceResponseContent.load(response.body))
41
44
  else
42
45
  error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
43
46
  raise error_class.new(response.body, code: code)
@@ -54,6 +57,9 @@ module Auth0
54
57
  # @option request_options [Hash{String => Object}] :additional_body_parameters
55
58
  # @option request_options [Integer] :timeout_in_seconds
56
59
  #
60
+ # @example
61
+ # client.risk_assessments.settings.new_device.update(remember_for: 1)
62
+ #
57
63
  # @return [Auth0::Types::UpdateRiskAssessmentsSettingsNewDeviceResponseContent]
58
64
  def update(request_options: {}, **params)
59
65
  params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -71,7 +77,7 @@ module Auth0
71
77
  end
72
78
  code = response.code.to_i
73
79
  if code.between?(200, 299)
74
- Auth0::Types::UpdateRiskAssessmentsSettingsNewDeviceResponseContent.load(response.body)
80
+ (response.body.to_s.empty? ? nil : Auth0::Types::UpdateRiskAssessmentsSettingsNewDeviceResponseContent.load(response.body))
75
81
  else
76
82
  error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
77
83
  raise error_class.new(response.body, code: code)
@@ -29,6 +29,16 @@ module Auth0
29
29
  # @option params [Auth0::Types::RoleTypeEnum, nil] :type
30
30
  # @option params [String, nil] :owner_id
31
31
  #
32
+ # @example
33
+ # client.roles.list(
34
+ # per_page: 1,
35
+ # page: 1,
36
+ # include_totals: true,
37
+ # name_filter: "name_filter",
38
+ # type: "tenant",
39
+ # owner_id: "owner_id"
40
+ # )
41
+ #
32
42
  # @return [Auth0::Types::ListRolesOffsetPaginatedResponseContent]
33
43
  def list(request_options: {}, **params)
34
44
  params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -61,7 +71,7 @@ module Auth0
61
71
  end
62
72
  code = response.code.to_i
63
73
  if code.between?(200, 299)
64
- parsed_response = Auth0::Types::ListRolesOffsetPaginatedResponseContent.load(response.body)
74
+ parsed_response = (response.body.to_s.empty? ? nil : Auth0::Types::ListRolesOffsetPaginatedResponseContent.load(response.body))
65
75
  [parsed_response, response]
66
76
  else
67
77
  error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
@@ -83,6 +93,9 @@ module Auth0
83
93
  # @option request_options [Hash{String => Object}] :additional_body_parameters
84
94
  # @option request_options [Integer] :timeout_in_seconds
85
95
  #
96
+ # @example
97
+ # client.roles.create(name: "name")
98
+ #
86
99
  # @return [Auth0::Types::CreateRoleResponseContent]
87
100
  def create(request_options: {}, **params)
88
101
  params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -100,7 +113,7 @@ module Auth0
100
113
  end
101
114
  code = response.code.to_i
102
115
  if code.between?(200, 299)
103
- Auth0::Types::CreateRoleResponseContent.load(response.body)
116
+ (response.body.to_s.empty? ? nil : Auth0::Types::CreateRoleResponseContent.load(response.body))
104
117
  else
105
118
  error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
106
119
  raise error_class.new(response.body, code: code)
@@ -119,6 +132,9 @@ module Auth0
119
132
  # @option request_options [Integer] :timeout_in_seconds
120
133
  # @option params [String] :id
121
134
  #
135
+ # @example
136
+ # client.roles.get(id: "id")
137
+ #
122
138
  # @return [Auth0::Types::GetRoleResponseContent]
123
139
  def get(request_options: {}, **params)
124
140
  params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -135,7 +151,7 @@ module Auth0
135
151
  end
136
152
  code = response.code.to_i
137
153
  if code.between?(200, 299)
138
- Auth0::Types::GetRoleResponseContent.load(response.body)
154
+ (response.body.to_s.empty? ? nil : Auth0::Types::GetRoleResponseContent.load(response.body))
139
155
  else
140
156
  error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
141
157
  raise error_class.new(response.body, code: code)
@@ -154,6 +170,9 @@ module Auth0
154
170
  # @option request_options [Integer] :timeout_in_seconds
155
171
  # @option params [String] :id
156
172
  #
173
+ # @example
174
+ # client.roles.delete(id: "id")
175
+ #
157
176
  # @return [untyped]
158
177
  def delete(request_options: {}, **params)
159
178
  params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -187,6 +206,9 @@ module Auth0
187
206
  # @option request_options [Integer] :timeout_in_seconds
188
207
  # @option params [String] :id
189
208
  #
209
+ # @example
210
+ # client.roles.update(id: "id")
211
+ #
190
212
  # @return [Auth0::Types::UpdateRoleResponseContent]
191
213
  def update(request_options: {}, **params)
192
214
  params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -208,7 +230,7 @@ module Auth0
208
230
  end
209
231
  code = response.code.to_i
210
232
  if code.between?(200, 299)
211
- Auth0::Types::UpdateRoleResponseContent.load(response.body)
233
+ (response.body.to_s.empty? ? nil : Auth0::Types::UpdateRoleResponseContent.load(response.body))
212
234
  else
213
235
  error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
214
236
  raise error_class.new(response.body, code: code)
@@ -24,6 +24,13 @@ module Auth0
24
24
  # @option params [String, nil] :from
25
25
  # @option params [Integer, nil] :take
26
26
  #
27
+ # @example
28
+ # client.roles.groups.get(
29
+ # id: "id",
30
+ # from: "from",
31
+ # take: 1
32
+ # )
33
+ #
27
34
  # @return [Auth0::Types::ListRoleGroupsResponseContent]
28
35
  def get(request_options: {}, **params)
29
36
  params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -51,7 +58,7 @@ module Auth0
51
58
  end
52
59
  code = response.code.to_i
53
60
  if code.between?(200, 299)
54
- parsed_response = Auth0::Types::ListRoleGroupsResponseContent.load(response.body)
61
+ parsed_response = (response.body.to_s.empty? ? nil : Auth0::Types::ListRoleGroupsResponseContent.load(response.body))
55
62
  [parsed_response, response]
56
63
  else
57
64
  error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
@@ -71,6 +78,12 @@ module Auth0
71
78
  # @option request_options [Integer] :timeout_in_seconds
72
79
  # @option params [String] :id
73
80
  #
81
+ # @example
82
+ # client.roles.groups.create(
83
+ # id: "id",
84
+ # groups: ["groups"]
85
+ # )
86
+ #
74
87
  # @return [untyped]
75
88
  def create(request_options: {}, **params)
76
89
  params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -108,6 +121,12 @@ module Auth0
108
121
  # @option request_options [Integer] :timeout_in_seconds
109
122
  # @option params [String] :id
110
123
  #
124
+ # @example
125
+ # client.roles.groups.delete(
126
+ # id: "id",
127
+ # groups: ["groups"]
128
+ # )
129
+ #
111
130
  # @return [untyped]
112
131
  def delete(request_options: {}, **params)
113
132
  params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -25,6 +25,14 @@ module Auth0
25
25
  # @option params [Integer, nil] :page
26
26
  # @option params [Boolean, nil] :include_totals
27
27
  #
28
+ # @example
29
+ # client.roles.permissions.list(
30
+ # id: "id",
31
+ # per_page: 1,
32
+ # page: 1,
33
+ # include_totals: true
34
+ # )
35
+ #
28
36
  # @return [Auth0::Types::ListRolePermissionsOffsetPaginatedResponseContent]
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::ListRolePermissionsOffsetPaginatedResponseContent.load(response.body)
65
+ parsed_response = (response.body.to_s.empty? ? nil : Auth0::Types::ListRolePermissionsOffsetPaginatedResponseContent.load(response.body))
58
66
  [parsed_response, response]
59
67
  else
60
68
  error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
@@ -76,6 +84,15 @@ module Auth0
76
84
  # @option request_options [Integer] :timeout_in_seconds
77
85
  # @option params [String] :id
78
86
  #
87
+ # @example
88
+ # client.roles.permissions.add(
89
+ # id: "id",
90
+ # permissions: [{
91
+ # resource_server_identifier: "resource_server_identifier",
92
+ # permission_name: "permission_name"
93
+ # }]
94
+ # )
95
+ #
79
96
  # @return [untyped]
80
97
  def add(request_options: {}, **params)
81
98
  params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -115,6 +132,15 @@ module Auth0
115
132
  # @option request_options [Integer] :timeout_in_seconds
116
133
  # @option params [String] :id
117
134
  #
135
+ # @example
136
+ # client.roles.permissions.delete(
137
+ # id: "id",
138
+ # permissions: [{
139
+ # resource_server_identifier: "resource_server_identifier",
140
+ # permission_name: "permission_name"
141
+ # }]
142
+ # )
143
+ #
118
144
  # @return [untyped]
119
145
  def delete(request_options: {}, **params)
120
146
  params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -48,6 +48,14 @@ module Auth0
48
48
  # @option params [String, nil] :from
49
49
  # @option params [Integer, nil] :take
50
50
  #
51
+ # @example
52
+ # client.roles.users.list(
53
+ # id: "id",
54
+ # include_totals: true,
55
+ # from: "from",
56
+ # take: 1
57
+ # )
58
+ #
51
59
  # @return [Auth0::Types::ListRoleUsersPaginatedResponseContent]
52
60
  def list(request_options: {}, **params)
53
61
  params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -76,7 +84,7 @@ module Auth0
76
84
  end
77
85
  code = response.code.to_i
78
86
  if code.between?(200, 299)
79
- parsed_response = Auth0::Types::ListRoleUsersPaginatedResponseContent.load(response.body)
87
+ parsed_response = (response.body.to_s.empty? ? nil : Auth0::Types::ListRoleUsersPaginatedResponseContent.load(response.body))
80
88
  [parsed_response, response]
81
89
  else
82
90
  error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
@@ -99,6 +107,12 @@ module Auth0
99
107
  # @option request_options [Integer] :timeout_in_seconds
100
108
  # @option params [String] :id
101
109
  #
110
+ # @example
111
+ # client.roles.users.assign(
112
+ # id: "id",
113
+ # users: ["users"]
114
+ # )
115
+ #
102
116
  # @return [untyped]
103
117
  def assign(request_options: {}, **params)
104
118
  params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -27,6 +27,16 @@ module Auth0
27
27
  # @option params [String, nil] :fields
28
28
  # @option params [Boolean, nil] :include_fields
29
29
  #
30
+ # @example
31
+ # client.rules.list(
32
+ # page: 1,
33
+ # per_page: 1,
34
+ # include_totals: true,
35
+ # enabled: true,
36
+ # fields: "fields",
37
+ # include_fields: true
38
+ # )
39
+ #
30
40
  # @return [Auth0::Types::ListRulesOffsetPaginatedResponseContent]
31
41
  def list(request_options: {}, **params)
32
42
  params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -59,7 +69,7 @@ module Auth0
59
69
  end
60
70
  code = response.code.to_i
61
71
  if code.between?(200, 299)
62
- parsed_response = Auth0::Types::ListRulesOffsetPaginatedResponseContent.load(response.body)
72
+ parsed_response = (response.body.to_s.empty? ? nil : Auth0::Types::ListRulesOffsetPaginatedResponseContent.load(response.body))
63
73
  [parsed_response, response]
64
74
  else
65
75
  error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
@@ -81,6 +91,12 @@ module Auth0
81
91
  # @option request_options [Hash{String => Object}] :additional_body_parameters
82
92
  # @option request_options [Integer] :timeout_in_seconds
83
93
  #
94
+ # @example
95
+ # client.rules.create(
96
+ # name: "name",
97
+ # script: "script"
98
+ # )
99
+ #
84
100
  # @return [Auth0::Types::CreateRuleResponseContent]
85
101
  def create(request_options: {}, **params)
86
102
  params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -98,7 +114,7 @@ module Auth0
98
114
  end
99
115
  code = response.code.to_i
100
116
  if code.between?(200, 299)
101
- Auth0::Types::CreateRuleResponseContent.load(response.body)
117
+ (response.body.to_s.empty? ? nil : Auth0::Types::CreateRuleResponseContent.load(response.body))
102
118
  else
103
119
  error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
104
120
  raise error_class.new(response.body, code: code)
@@ -119,6 +135,13 @@ module Auth0
119
135
  # @option params [String, nil] :fields
120
136
  # @option params [Boolean, nil] :include_fields
121
137
  #
138
+ # @example
139
+ # client.rules.get(
140
+ # id: "id",
141
+ # fields: "fields",
142
+ # include_fields: true
143
+ # )
144
+ #
122
145
  # @return [Auth0::Types::GetRuleResponseContent]
123
146
  def get(request_options: {}, **params)
124
147
  params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -140,7 +163,7 @@ module Auth0
140
163
  end
141
164
  code = response.code.to_i
142
165
  if code.between?(200, 299)
143
- Auth0::Types::GetRuleResponseContent.load(response.body)
166
+ (response.body.to_s.empty? ? nil : Auth0::Types::GetRuleResponseContent.load(response.body))
144
167
  else
145
168
  error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
146
169
  raise error_class.new(response.body, code: code)
@@ -158,6 +181,9 @@ module Auth0
158
181
  # @option request_options [Integer] :timeout_in_seconds
159
182
  # @option params [String] :id
160
183
  #
184
+ # @example
185
+ # client.rules.delete(id: "id")
186
+ #
161
187
  # @return [untyped]
162
188
  def delete(request_options: {}, **params)
163
189
  params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -190,6 +216,9 @@ module Auth0
190
216
  # @option request_options [Integer] :timeout_in_seconds
191
217
  # @option params [String] :id
192
218
  #
219
+ # @example
220
+ # client.rules.update(id: "id")
221
+ #
193
222
  # @return [Auth0::Types::UpdateRuleResponseContent]
194
223
  def update(request_options: {}, **params)
195
224
  params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -211,7 +240,7 @@ module Auth0
211
240
  end
212
241
  code = response.code.to_i
213
242
  if code.between?(200, 299)
214
- Auth0::Types::UpdateRuleResponseContent.load(response.body)
243
+ (response.body.to_s.empty? ? nil : Auth0::Types::UpdateRuleResponseContent.load(response.body))
215
244
  else
216
245
  error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
217
246
  raise error_class.new(response.body, code: code)