clerk-sdk-ruby 8.0.2 → 9.0.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 (356) hide show
  1. checksums.yaml +4 -4
  2. data/lib/clerk/actortokens.rb +9 -9
  3. data/lib/clerk/admin_portal_link_tokens.rb +18 -18
  4. data/lib/clerk/agenttasks.rb +9 -9
  5. data/lib/clerk/allowlistidentifiers.rb +13 -13
  6. data/lib/clerk/api_keys.rb +48 -48
  7. data/lib/clerk/betafeatures.rb +12 -10
  8. data/lib/clerk/billing.rb +68 -68
  9. data/lib/clerk/blocklistidentifiers.rb +13 -13
  10. data/lib/clerk/clients.rb +13 -13
  11. data/lib/clerk/directories.rb +342 -46
  12. data/lib/clerk/domains.rb +23 -20
  13. data/lib/clerk/emailaddresses.rb +37 -37
  14. data/lib/clerk/emailandsmstemplates.rb +5 -5
  15. data/lib/clerk/emailsmstemplates.rb +17 -17
  16. data/lib/clerk/enterpriseconnections.rb +31 -31
  17. data/lib/clerk/instancesettings.rb +52 -50
  18. data/lib/clerk/invitations.rb +166 -18
  19. data/lib/clerk/jwks.rb +3 -3
  20. data/lib/clerk/jwttemplates.rb +21 -21
  21. data/lib/clerk/logs.rb +683 -0
  22. data/lib/clerk/m2m.rb +27 -27
  23. data/lib/clerk/machines.rb +41 -41
  24. data/lib/clerk/miscellaneous.rb +2 -2
  25. data/lib/clerk/models/components/clerkerror.rb +1 -1
  26. data/lib/clerk/models/components/data.rb +27 -0
  27. data/lib/clerk/models/components/{type.rbi → data.rbi} +2 -2
  28. data/lib/clerk/models/components/directory.rb +8 -2
  29. data/lib/clerk/models/components/directory.rbi +2 -0
  30. data/lib/clerk/models/components/directorygroup.rb +44 -0
  31. data/lib/clerk/models/components/{directory_group.rbi → directorygroup.rbi} +4 -0
  32. data/lib/clerk/models/components/directorygroup_object.rb +19 -0
  33. data/lib/clerk/models/components/directorygroup_object.rbi +11 -0
  34. data/lib/clerk/models/components/directorygroupmember.rb +40 -0
  35. data/lib/clerk/models/components/directorygroupmember.rbi +17 -0
  36. data/lib/clerk/models/components/directorygroupmember_list.rb +36 -0
  37. data/lib/clerk/models/components/directorygroupmember_list.rbi +15 -0
  38. data/lib/clerk/models/components/directorygroupmember_list_cursor.rb +40 -0
  39. data/lib/clerk/models/components/directorygroupmember_list_cursor.rbi +17 -0
  40. data/lib/clerk/models/components/directorygroupmember_object.rb +19 -0
  41. data/lib/clerk/models/components/directorygroupmember_object.rbi +11 -0
  42. data/lib/clerk/models/components/directorygrouprolemapping_deleted.rb +1 -1
  43. data/lib/clerk/models/components/emailaddress_verification_saml_clerkerror.rb +1 -1
  44. data/lib/clerk/models/components/enterpriseaccount.rb +1 -1
  45. data/lib/clerk/models/components/enterpriseaccount_verification_oauth_clerkerror.rb +1 -1
  46. data/lib/clerk/models/components/enterpriseaccount_verification_saml_clerkerror.rb +1 -1
  47. data/lib/clerk/models/components/enterpriseconnection_idp_certificate.rb +40 -0
  48. data/lib/clerk/models/components/enterpriseconnection_idp_certificate.rbi +17 -0
  49. data/lib/clerk/models/components/enterpriseconnection_saml_connection.rb +18 -1
  50. data/lib/clerk/models/components/enterpriseconnection_saml_connection.rbi +8 -0
  51. data/lib/clerk/models/components/enterpriseconnectiontestrun.rb +1 -1
  52. data/lib/clerk/models/components/enterpriseconnectiontestrun_log.rb +44 -0
  53. data/lib/clerk/models/components/enterpriseconnectiontestrun_log.rbi +19 -0
  54. data/lib/clerk/models/components/externalaccountwithverification.rb +2 -2
  55. data/lib/clerk/models/components/externalaccountwithverification_verification_oauth_clerkerror.rb +1 -1
  56. data/lib/clerk/models/components/first_event.rb +115 -0
  57. data/lib/clerk/models/components/first_event.rbi +49 -0
  58. data/lib/clerk/models/components/instance.rb +5 -1
  59. data/lib/clerk/models/components/instance.rbi +2 -0
  60. data/lib/clerk/models/components/instanceprotect.rb +1 -1
  61. data/lib/clerk/models/components/invitation.rb +1 -1
  62. data/lib/clerk/models/components/invitation_revoked.rb +2 -2
  63. data/lib/clerk/models/components/log.rb +87 -18
  64. data/lib/clerk/models/components/log.rbi +38 -8
  65. data/lib/clerk/models/components/log_impersonator.rb +32 -0
  66. data/lib/clerk/models/components/log_impersonator.rbi +13 -0
  67. data/lib/clerk/models/components/log_list.rb +39 -0
  68. data/lib/clerk/models/components/log_list.rbi +15 -0
  69. data/lib/clerk/models/components/log_list_cursor.rb +72 -0
  70. data/lib/clerk/models/components/log_list_cursor.rbi +29 -0
  71. data/lib/clerk/models/components/logapplicationcontext.rb +36 -0
  72. data/lib/clerk/models/components/logapplicationcontext.rbi +15 -0
  73. data/lib/clerk/models/components/logbrowsercontext.rb +36 -0
  74. data/lib/clerk/models/components/logbrowsercontext.rbi +15 -0
  75. data/lib/clerk/models/components/logcontext.rb +36 -0
  76. data/lib/clerk/models/components/logcontext.rbi +15 -0
  77. data/lib/clerk/models/components/logdevicecontext.rb +60 -0
  78. data/lib/clerk/models/components/logdevicecontext.rbi +27 -0
  79. data/lib/clerk/models/components/logdomaincontext.rb +36 -0
  80. data/lib/clerk/models/components/logdomaincontext.rbi +15 -0
  81. data/lib/clerk/models/components/logenvironmentcontext.rb +44 -0
  82. data/lib/clerk/models/components/logenvironmentcontext.rbi +19 -0
  83. data/lib/clerk/models/components/loggroup.rb +89 -0
  84. data/lib/clerk/models/components/loggroup.rbi +37 -0
  85. data/lib/clerk/models/components/loggroup_impersonator.rb +32 -0
  86. data/lib/clerk/models/components/loggroup_impersonator.rbi +13 -0
  87. data/lib/clerk/models/components/loggroup_object.rb +19 -0
  88. data/lib/clerk/models/components/loggroup_object.rbi +11 -0
  89. data/lib/clerk/models/components/loglocationcontext.rb +41 -0
  90. data/lib/clerk/models/components/loglocationcontext.rbi +17 -0
  91. data/lib/clerk/models/components/logschema.rb +68 -0
  92. data/lib/clerk/models/components/logschema.rbi +25 -0
  93. data/lib/clerk/models/components/logschemafield.rb +49 -0
  94. data/lib/clerk/models/components/logschemafield.rbi +19 -0
  95. data/lib/clerk/models/components/logschemafield_type.rb +22 -0
  96. data/lib/clerk/models/components/logschemafield_type.rbi +11 -0
  97. data/lib/clerk/models/components/logwithpayload.rb +110 -0
  98. data/lib/clerk/models/components/logwithpayload.rbi +49 -0
  99. data/lib/clerk/models/components/logwithpayload_impersonator.rb +32 -0
  100. data/lib/clerk/models/components/logwithpayload_impersonator.rbi +13 -0
  101. data/lib/clerk/models/components/machine_deleted.rb +1 -1
  102. data/lib/clerk/models/components/machinescope_deleted.rb +1 -1
  103. data/lib/clerk/models/components/next_page_status.rb +21 -0
  104. data/lib/clerk/models/components/next_page_status.rbi +11 -0
  105. data/lib/clerk/models/components/oauthaccesstoken.rb +1 -1
  106. data/lib/clerk/models/components/oauthapplication.rb +9 -1
  107. data/lib/clerk/models/components/oauthapplication.rbi +4 -0
  108. data/lib/clerk/models/components/oauthapplicationsettings.rb +9 -1
  109. data/lib/clerk/models/components/oauthapplicationsettings.rbi +4 -0
  110. data/lib/clerk/models/components/oauthapplicationwithsecret.rb +9 -1
  111. data/lib/clerk/models/components/oauthapplicationwithsecret.rbi +4 -0
  112. data/lib/clerk/models/components/organization.rb +13 -8
  113. data/lib/clerk/models/components/organization.rbi +4 -2
  114. data/lib/clerk/models/components/organizationinvitation.rb +2 -2
  115. data/lib/clerk/models/components/organizationinvitationwithpublicorganizationdata.rb +2 -2
  116. data/lib/clerk/models/components/organizationmembership.rb +2 -2
  117. data/lib/clerk/models/components/organizationmembership_organization.rb +13 -8
  118. data/lib/clerk/models/components/organizationmembership_organization.rbi +4 -2
  119. data/lib/clerk/models/components/organizationwithlogo.rb +13 -8
  120. data/lib/clerk/models/components/organizationwithlogo.rbi +4 -2
  121. data/lib/clerk/models/components/role_set_migration.rb +1 -1
  122. data/lib/clerk/models/components/roleset.rb +1 -1
  123. data/lib/clerk/models/components/{type.rb → roleset_type.rb} +2 -2
  124. data/lib/clerk/models/components/roleset_type.rbi +11 -0
  125. data/lib/clerk/models/components/samlaccount.rb +1 -1
  126. data/lib/clerk/models/components/samlaccount_clerkerror.rb +1 -1
  127. data/lib/clerk/models/components/samlconnection_1.rb +6 -1
  128. data/lib/clerk/models/components/samlconnection_1.rbi +2 -0
  129. data/lib/clerk/models/components/samlconnection_2.rb +6 -1
  130. data/lib/clerk/models/components/samlconnection_2.rbi +2 -0
  131. data/lib/clerk/models/components/samlconnection_idp_certificate_1.rb +40 -0
  132. data/lib/clerk/models/components/samlconnection_idp_certificate_1.rbi +17 -0
  133. data/lib/clerk/models/components/samlconnection_idp_certificate_2.rb +40 -0
  134. data/lib/clerk/models/components/samlconnection_idp_certificate_2.rbi +17 -0
  135. data/lib/clerk/models/components/scimdirectory.rb +8 -2
  136. data/lib/clerk/models/components/scimdirectory.rbi +2 -0
  137. data/lib/clerk/models/components/scimgrouprolemapping_deleted.rb +1 -1
  138. data/lib/clerk/models/components/session.rb +2 -2
  139. data/lib/clerk/models/components/signup.rb +7 -3
  140. data/lib/clerk/models/components/signup.rbi +2 -0
  141. data/lib/clerk/models/components/signupverification.rb +1 -1
  142. data/lib/clerk/models/components/ssobypassallowlistpublicuserdata.rb +58 -0
  143. data/lib/clerk/models/components/ssobypassallowlistpublicuserdata.rbi +25 -0
  144. data/lib/clerk/models/components/ssobypassallowlistuser.rb +49 -0
  145. data/lib/clerk/models/components/ssobypassallowlistuser.rbi +21 -0
  146. data/lib/clerk/models/components/ssobypassallowlistuser_object.rb +19 -0
  147. data/lib/clerk/models/components/ssobypassallowlistuser_object.rbi +11 -0
  148. data/lib/clerk/models/components/user.rb +8 -4
  149. data/lib/clerk/models/components/user.rbi +2 -0
  150. data/lib/clerk/models/components/user_directory.rb +1 -1
  151. data/lib/clerk/models/components/{directory_group.rb → user_directory_group.rb} +1 -1
  152. data/lib/clerk/models/components/user_directory_group.rbi +15 -0
  153. data/lib/clerk/models/components/verification_from_oauth_clerkerror.rb +1 -1
  154. data/lib/clerk/models/components/verification_google_one_tap_clerkerror.rb +1 -1
  155. data/lib/clerk/models/components/waitlistentry_invitation.rb +1 -1
  156. data/lib/clerk/models/components.rb +37 -3
  157. data/lib/clerk/models/errors/apierror.rb +3 -3
  158. data/lib/clerk/models/errors/clerkerrors.rb +2 -2
  159. data/lib/clerk/models/errors/createadminportallinktoken_badrequest_error.rb +1 -1
  160. data/lib/clerk/models/errors/createadminportallinktoken_conflict_error.rb +1 -1
  161. data/lib/clerk/models/errors/createadminportallinktoken_forbidden_error.rb +1 -1
  162. data/lib/clerk/models/errors/createadminportallinktoken_unauthorized_error.rb +1 -1
  163. data/lib/clerk/models/errors/createapikey_badrequest_error.rb +1 -1
  164. data/lib/clerk/models/errors/createapikey_conflict_error.rb +1 -1
  165. data/lib/clerk/models/errors/createm2mtoken_badrequest_error.rb +1 -1
  166. data/lib/clerk/models/errors/createm2mtoken_conflict_error.rb +1 -1
  167. data/lib/clerk/models/errors/deleteapikey_badrequest_error.rb +1 -1
  168. data/lib/clerk/models/errors/deleteapikey_notfound_error.rb +1 -1
  169. data/lib/clerk/models/errors/getapikey_badrequest_error.rb +1 -1
  170. data/lib/clerk/models/errors/getapikey_notfound_error.rb +1 -1
  171. data/lib/clerk/models/errors/getapikeys_badrequest_error.rb +1 -1
  172. data/lib/clerk/models/errors/getapikeys_notfound_error.rb +1 -1
  173. data/lib/clerk/models/errors/getapikeysecret_badrequest_error.rb +1 -1
  174. data/lib/clerk/models/errors/getapikeysecret_notfound_error.rb +1 -1
  175. data/lib/clerk/models/errors/getm2mtokens_badrequest_error.rb +1 -1
  176. data/lib/clerk/models/errors/getm2mtokens_forbidden_error.rb +1 -1
  177. data/lib/clerk/models/errors/getm2mtokens_notfound_error.rb +1 -1
  178. data/lib/clerk/models/errors/revokeadminportallinktoken_badrequest_error.rb +1 -1
  179. data/lib/clerk/models/errors/revokeadminportallinktoken_forbidden_error.rb +1 -1
  180. data/lib/clerk/models/errors/revokeadminportallinktoken_notfound_error.rb +1 -1
  181. data/lib/clerk/models/errors/revokeadminportallinktoken_unauthorized_error.rb +1 -1
  182. data/lib/clerk/models/errors/revokeapikey_badrequest_error.rb +1 -1
  183. data/lib/clerk/models/errors/revokeapikey_notfound_error.rb +1 -1
  184. data/lib/clerk/models/errors/revokem2mtoken_badrequest_error.rb +1 -1
  185. data/lib/clerk/models/errors/revokem2mtoken_notfound_error.rb +1 -1
  186. data/lib/clerk/models/errors/updateapikey_badrequest_error.rb +1 -1
  187. data/lib/clerk/models/errors/updateapikey_notfound_error.rb +1 -1
  188. data/lib/clerk/models/errors/verifyapikey_badrequest_error.rb +1 -1
  189. data/lib/clerk/models/errors/verifyapikey_notfound_error.rb +1 -1
  190. data/lib/clerk/models/errors/verifym2mtoken_badrequest_error.rb +1 -1
  191. data/lib/clerk/models/errors/verifym2mtoken_notfound_error.rb +1 -1
  192. data/lib/clerk/models/errors/verifyoauthaccesstoken_badrequest_error.rb +1 -1
  193. data/lib/clerk/models/errors/verifyoauthaccesstoken_notfound_error.rb +1 -1
  194. data/lib/clerk/models/operations/act.rb +40 -0
  195. data/lib/clerk/models/operations/act.rbi +17 -0
  196. data/lib/clerk/models/operations/act_act.rb +36 -0
  197. data/lib/clerk/models/operations/act_act.rbi +15 -0
  198. data/lib/clerk/models/operations/actor.rb +1 -1
  199. data/lib/clerk/models/operations/attemptemailaddressverification_requestbody.rb +7 -1
  200. data/lib/clerk/models/operations/attemptemailaddressverification_requestbody.rbi +2 -0
  201. data/lib/clerk/models/operations/attemptphonenumberverification_requestbody.rb +7 -1
  202. data/lib/clerk/models/operations/attemptphonenumberverification_requestbody.rbi +2 -0
  203. data/lib/clerk/models/operations/clerkidpoauthaccesstoken.rb +5 -1
  204. data/lib/clerk/models/operations/clerkidpoauthaccesstoken.rbi +2 -0
  205. data/lib/clerk/models/operations/createbulkinvitations_requestbody.rb +1 -1
  206. data/lib/clerk/models/operations/createenterpriseconnection_saml.rb +8 -2
  207. data/lib/clerk/models/operations/createenterpriseconnection_saml.rbi +2 -0
  208. data/lib/clerk/models/operations/createinvitation_request.rb +1 -1
  209. data/lib/clerk/models/operations/createoauthapplication_request.rb +13 -1
  210. data/lib/clerk/models/operations/createoauthapplication_request.rbi +6 -0
  211. data/lib/clerk/models/operations/createorganization_request.rb +2 -2
  212. data/lib/clerk/models/operations/createorganizationinvitation_requestbody.rb +2 -2
  213. data/lib/clerk/models/operations/createorganizationinvitationbulk_requestbody.rb +2 -2
  214. data/lib/clerk/models/operations/createorganizationmembership_requestbody.rb +2 -2
  215. data/lib/clerk/models/operations/createsamlconnection_requestbody_1.rb +8 -2
  216. data/lib/clerk/models/operations/createsamlconnection_requestbody_1.rbi +2 -0
  217. data/lib/clerk/models/operations/createsamlconnection_requestbody_2.rb +8 -2
  218. data/lib/clerk/models/operations/createsamlconnection_requestbody_2.rbi +2 -0
  219. data/lib/clerk/models/operations/createsignintoken_request.rb +17 -2
  220. data/lib/clerk/models/operations/createsignintoken_request.rbi +4 -0
  221. data/lib/clerk/models/operations/createssobypassallowlistuser_request.rb +32 -0
  222. data/lib/clerk/models/operations/createssobypassallowlistuser_request.rbi +13 -0
  223. data/lib/clerk/models/operations/createssobypassallowlistuser_response.rb +44 -0
  224. data/lib/clerk/models/operations/createssobypassallowlistuser_response.rbi +19 -0
  225. data/lib/clerk/models/operations/createuser_request.rb +8 -4
  226. data/lib/clerk/models/operations/createuser_request.rbi +2 -0
  227. data/lib/clerk/models/operations/deleteapikey_responsebody.rb +1 -1
  228. data/lib/clerk/models/operations/deleteinvitation_request.rb +32 -0
  229. data/lib/clerk/models/operations/deleteinvitation_request.rbi +13 -0
  230. data/lib/clerk/models/operations/deleteinvitation_response.rb +44 -0
  231. data/lib/clerk/models/operations/deleteinvitation_response.rbi +19 -0
  232. data/lib/clerk/models/operations/deletessobypassallowlistuser_request.rb +32 -0
  233. data/lib/clerk/models/operations/deletessobypassallowlistuser_request.rbi +13 -0
  234. data/lib/clerk/models/operations/deletessobypassallowlistuser_response.rb +44 -0
  235. data/lib/clerk/models/operations/deletessobypassallowlistuser_response.rbi +19 -0
  236. data/lib/clerk/models/operations/filter_match.rb +27 -0
  237. data/lib/clerk/models/operations/filter_match.rbi +11 -0
  238. data/lib/clerk/models/operations/getdirectorygroup_request.rb +36 -0
  239. data/lib/clerk/models/operations/getdirectorygroup_request.rbi +15 -0
  240. data/lib/clerk/models/operations/getdirectorygroup_response.rb +44 -0
  241. data/lib/clerk/models/operations/getdirectorygroup_response.rbi +19 -0
  242. data/lib/clerk/models/operations/getlog_request.rb +34 -0
  243. data/lib/clerk/models/operations/getlog_request.rbi +13 -0
  244. data/lib/clerk/models/operations/getlog_response.rb +44 -0
  245. data/lib/clerk/models/operations/getlog_response.rbi +19 -0
  246. data/lib/clerk/models/operations/getlogschema_request.rb +35 -0
  247. data/lib/clerk/models/operations/getlogschema_request.rbi +13 -0
  248. data/lib/clerk/models/operations/getlogschema_response.rb +44 -0
  249. data/lib/clerk/models/operations/getlogschema_response.rbi +19 -0
  250. data/lib/clerk/models/operations/listdirectorygroupmembers_request.rb +45 -0
  251. data/lib/clerk/models/operations/listdirectorygroupmembers_request.rbi +19 -0
  252. data/lib/clerk/models/operations/listdirectorygroupmembers_response.rb +44 -0
  253. data/lib/clerk/models/operations/listdirectorygroupmembers_response.rbi +19 -0
  254. data/lib/clerk/models/operations/listinvitations_request.rb +6 -1
  255. data/lib/clerk/models/operations/listinvitations_request.rbi +2 -0
  256. data/lib/clerk/models/operations/listloggroupevents_request.rb +47 -0
  257. data/lib/clerk/models/operations/listloggroupevents_request.rbi +19 -0
  258. data/lib/clerk/models/operations/listloggroupevents_response.rb +44 -0
  259. data/lib/clerk/models/operations/listloggroupevents_response.rbi +19 -0
  260. data/lib/clerk/models/operations/listlogs_request.rb +228 -0
  261. data/lib/clerk/models/operations/listlogs_request.rbi +55 -0
  262. data/lib/clerk/models/operations/listlogs_response.rb +44 -0
  263. data/lib/clerk/models/operations/listlogs_response.rbi +19 -0
  264. data/lib/clerk/models/operations/listssobypassallowlistusers_request.rb +32 -0
  265. data/lib/clerk/models/operations/listssobypassallowlistusers_request.rbi +13 -0
  266. data/lib/clerk/models/operations/listssobypassallowlistusers_response.rb +44 -0
  267. data/lib/clerk/models/operations/listssobypassallowlistusers_response.rbi +19 -0
  268. data/lib/clerk/models/operations/mergeorganizationmetadata_requestbody.rb +2 -2
  269. data/lib/clerk/models/operations/mergeuser_request.rb +36 -0
  270. data/lib/clerk/models/operations/mergeuser_request.rbi +15 -0
  271. data/lib/clerk/models/operations/mergeuser_requestbody.rb +36 -0
  272. data/lib/clerk/models/operations/mergeuser_requestbody.rbi +15 -0
  273. data/lib/clerk/models/operations/mergeuser_response.rb +44 -0
  274. data/lib/clerk/models/operations/mergeuser_response.rbi +19 -0
  275. data/lib/clerk/models/operations/mergeuser_responsebody.rb +36 -0
  276. data/lib/clerk/models/operations/mergeuser_responsebody.rbi +15 -0
  277. data/lib/clerk/models/operations/refreshsession_requestbody.rb +1 -1
  278. data/lib/clerk/models/operations/replaceorganizationmetadata_requestbody.rb +2 -2
  279. data/lib/clerk/models/operations/replaceroleset_requestbody.rb +1 -1
  280. data/lib/clerk/models/operations/replaceusermetadata_requestbody.rb +3 -3
  281. data/lib/clerk/models/operations/responsebody.rb +1 -1
  282. data/lib/clerk/models/operations/revokesession_request.rb +5 -1
  283. data/lib/clerk/models/operations/revokesession_request.rbi +2 -0
  284. data/lib/clerk/models/operations/revokesession_requestbody.rb +36 -0
  285. data/lib/clerk/models/operations/revokesession_requestbody.rbi +13 -0
  286. data/lib/clerk/models/operations/second_factor_verification.rb +25 -0
  287. data/lib/clerk/models/operations/second_factor_verification.rbi +11 -0
  288. data/lib/clerk/models/operations/updatedirectory_requestbody.rb +8 -2
  289. data/lib/clerk/models/operations/updatedirectory_requestbody.rbi +2 -0
  290. data/lib/clerk/models/operations/updateenterpriseconnection_saml.rb +8 -2
  291. data/lib/clerk/models/operations/updateenterpriseconnection_saml.rbi +2 -0
  292. data/lib/clerk/models/operations/updateinstance_request.rb +1 -1
  293. data/lib/clerk/models/operations/updateinstanceoauthapplicationsettings_request.rb +9 -1
  294. data/lib/clerk/models/operations/updateinstanceoauthapplicationsettings_request.rbi +4 -0
  295. data/lib/clerk/models/operations/updateinstanceprotect_request.rb +1 -5
  296. data/lib/clerk/models/operations/updateinstanceprotect_request.rbi +0 -2
  297. data/lib/clerk/models/operations/updateoauthapplication_requestbody.rb +13 -1
  298. data/lib/clerk/models/operations/updateoauthapplication_requestbody.rbi +6 -0
  299. data/lib/clerk/models/operations/updateorganization_requestbody.rb +12 -2
  300. data/lib/clerk/models/operations/updateorganization_requestbody.rbi +4 -0
  301. data/lib/clerk/models/operations/updateorganizationmembershipmetadata_requestbody.rb +2 -2
  302. data/lib/clerk/models/operations/updatesamlconnection_requestbody.rb +8 -2
  303. data/lib/clerk/models/operations/updatesamlconnection_requestbody.rbi +2 -0
  304. data/lib/clerk/models/operations/updatescimdirectory_requestbody.rb +8 -2
  305. data/lib/clerk/models/operations/updatescimdirectory_requestbody.rbi +2 -0
  306. data/lib/clerk/models/operations/updatesession_request.rb +36 -0
  307. data/lib/clerk/models/operations/updatesession_request.rbi +15 -0
  308. data/lib/clerk/models/operations/updatesession_requestbody.rb +33 -0
  309. data/lib/clerk/models/operations/updatesession_requestbody.rbi +13 -0
  310. data/lib/clerk/models/operations/updatesession_response.rb +44 -0
  311. data/lib/clerk/models/operations/updatesession_response.rbi +19 -0
  312. data/lib/clerk/models/operations/updateuser_requestbody.rb +5 -1
  313. data/lib/clerk/models/operations/updateuser_requestbody.rbi +2 -0
  314. data/lib/clerk/models/operations/updateusermetadata_requestbody.rb +3 -3
  315. data/lib/clerk/models/operations/verifypassword_requestbody.rb +7 -1
  316. data/lib/clerk/models/operations/verifypassword_requestbody.rbi +2 -0
  317. data/lib/clerk/models/operations/verifytotp_requestbody.rb +7 -1
  318. data/lib/clerk/models/operations/verifytotp_requestbody.rbi +2 -0
  319. data/lib/clerk/models/operations/view.rb +38 -0
  320. data/lib/clerk/models/operations/view.rbi +11 -0
  321. data/lib/clerk/models/operations.rb +33 -0
  322. data/lib/clerk/oauthaccesstokens.rb +7 -7
  323. data/lib/clerk/oauthapplications.rb +37 -37
  324. data/lib/clerk/openapiclient.rb +3 -1
  325. data/lib/clerk/organizationdomains.rb +28 -28
  326. data/lib/clerk/organizationinvitations.rb +35 -35
  327. data/lib/clerk/organizationmemberships.rb +25 -25
  328. data/lib/clerk/organizationpermissions.rb +24 -24
  329. data/lib/clerk/organizationroles.rb +32 -32
  330. data/lib/clerk/organizations.rb +61 -61
  331. data/lib/clerk/phonenumbers.rb +36 -36
  332. data/lib/clerk/proxychecks.rb +5 -5
  333. data/lib/clerk/redirecturls.rb +16 -16
  334. data/lib/clerk/rolesets.rb +38 -38
  335. data/lib/clerk/samlconnections.rb +23 -23
  336. data/lib/clerk/scimdirectories.rb +46 -46
  337. data/lib/clerk/sdk_hooks/types.rb +4 -4
  338. data/lib/clerk/sdkconfiguration.rb +4 -4
  339. data/lib/clerk/sessions.rb +219 -42
  340. data/lib/clerk/signintokens.rb +9 -9
  341. data/lib/clerk/signups.rb +9 -9
  342. data/lib/clerk/ssobypassallowlistusers.rb +477 -0
  343. data/lib/clerk/templates.rb +5 -5
  344. data/lib/clerk/testingtokens.rb +3 -3
  345. data/lib/clerk/users.rb +376 -189
  346. data/lib/clerk/utils/forms.rb +9 -9
  347. data/lib/clerk/utils/headers.rb +2 -2
  348. data/lib/clerk/utils/query_params.rb +6 -6
  349. data/lib/clerk/utils/request_bodies.rb +2 -2
  350. data/lib/clerk/utils/retries.rb +5 -5
  351. data/lib/clerk/utils/security.rb +4 -4
  352. data/lib/clerk/utils/utils.rb +13 -13
  353. data/lib/clerk/waitlistentries.rb +26 -26
  354. data/lib/clerk/webhooks.rb +11 -11
  355. data/lib/clerk_sdk_ruby.rb +2 -0
  356. metadata +142 -6
@@ -16,7 +16,7 @@ module Clerk
16
16
  # The ID of the actor.
17
17
  field :sub, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('sub'), required: true } }
18
18
 
19
- field :additional_properties, Crystalline::Nilable.new(Crystalline::Hash.new(Symbol, ::Object)), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('additional_properties'), 'additional_properties': true } }
19
+ field :additional_properties, Crystalline::Nilable.new(Crystalline::Hash.new(::Symbol, ::Object)), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('additional_properties'), 'additional_properties': true } }
20
20
 
21
21
 
22
22
  def initialize(sub:, additional_properties: nil)
@@ -16,11 +16,16 @@ module Clerk
16
16
  field :verification_id, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('verification_id'), required: true } }
17
17
  # The verification code that was sent to the email address
18
18
  field :code, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('code'), required: true } }
19
+ # When `true`, a wrong code counts toward the user's lockout, and a locked user is rejected with a `user_locked` error before the code is checked.
20
+ # Has no effect on instances with user lockout disabled.
21
+ # To enforce lockout across a password check and a sign-in token, set this parameter on both requests.
22
+ field :honor_lockout, Crystalline::Nilable.new(Crystalline::Boolean.new), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('honor_lockout') } }
19
23
 
20
24
 
21
- def initialize(verification_id:, code:)
25
+ def initialize(verification_id:, code:, honor_lockout: false)
22
26
  @verification_id = verification_id
23
27
  @code = code
28
+ @honor_lockout = honor_lockout
24
29
  end
25
30
 
26
31
 
@@ -28,6 +33,7 @@ module Clerk
28
33
  return false unless other.is_a? self.class
29
34
  return false unless @verification_id == other.verification_id
30
35
  return false unless @code == other.code
36
+ return false unless @honor_lockout == other.honor_lockout
31
37
  true
32
38
  end
33
39
  end
@@ -12,4 +12,6 @@ class Clerk::Models::Operations::AttemptEmailAddressVerificationRequestBody
12
12
  def verification_id=(str_); end
13
13
  def code(); end
14
14
  def code=(str_); end
15
+ def honor_lockout(); end
16
+ def honor_lockout=(str_); end
15
17
  end
@@ -16,11 +16,16 @@ module Clerk
16
16
  field :verification_id, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('verification_id'), required: true } }
17
17
  # The verification code that was sent to the phone number
18
18
  field :code, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('code'), required: true } }
19
+ # When `true`, a wrong code counts toward the user's lockout, and a locked user is rejected with a `user_locked` error before the code is checked.
20
+ # Has no effect on instances with user lockout disabled.
21
+ # To enforce lockout across a password check and a sign-in token, set this parameter on both requests.
22
+ field :honor_lockout, Crystalline::Nilable.new(Crystalline::Boolean.new), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('honor_lockout') } }
19
23
 
20
24
 
21
- def initialize(verification_id:, code:)
25
+ def initialize(verification_id:, code:, honor_lockout: false)
22
26
  @verification_id = verification_id
23
27
  @code = code
28
+ @honor_lockout = honor_lockout
24
29
  end
25
30
 
26
31
 
@@ -28,6 +33,7 @@ module Clerk
28
33
  return false unless other.is_a? self.class
29
34
  return false unless @verification_id == other.verification_id
30
35
  return false unless @code == other.code
36
+ return false unless @honor_lockout == other.honor_lockout
31
37
  true
32
38
  end
33
39
  end
@@ -12,4 +12,6 @@ class Clerk::Models::Operations::AttemptPhoneNumberVerificationRequestBody
12
12
  def verification_id=(str_); end
13
13
  def code(); end
14
14
  def code=(str_); end
15
+ def honor_lockout(); end
16
+ def honor_lockout=(str_); end
15
17
  end
@@ -32,13 +32,15 @@ module Clerk
32
32
  field :updated_at, ::Float, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('updated_at'), required: true } }
33
33
  # The audiences of the access token. Omitted when no audience is set.
34
34
  field :aud, Crystalline::Nilable.new(Crystalline::Array.new(::String)), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('aud') } }
35
+ # The actor chain of an access token issued by an OAuth 2.0 Token Exchange (RFC 8693 section 4.1). Omitted for other access tokens.
36
+ field :act, Crystalline::Nilable.new(Models::Operations::Act), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('act') } }
35
37
 
36
38
  field :revocation_reason, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('revocation_reason'), required: true } }
37
39
 
38
40
  field :expiration, Crystalline::Nilable.new(::Float), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('expiration'), required: true } }
39
41
 
40
42
 
41
- def initialize(object:, id:, client_id:, subject:, scopes:, revoked:, expired:, created_at:, updated_at:, aud: nil, revocation_reason: nil, expiration: nil)
43
+ def initialize(object:, id:, client_id:, subject:, scopes:, revoked:, expired:, created_at:, updated_at:, aud: nil, act: nil, revocation_reason: nil, expiration: nil)
42
44
  @object = object
43
45
  @id = id
44
46
  @client_id = client_id
@@ -49,6 +51,7 @@ module Clerk
49
51
  @created_at = created_at
50
52
  @updated_at = updated_at
51
53
  @aud = aud
54
+ @act = act
52
55
  @revocation_reason = revocation_reason
53
56
  @expiration = expiration
54
57
  end
@@ -66,6 +69,7 @@ module Clerk
66
69
  return false unless @created_at == other.created_at
67
70
  return false unless @updated_at == other.updated_at
68
71
  return false unless @aud == other.aud
72
+ return false unless @act == other.act
69
73
  return false unless @revocation_reason == other.revocation_reason
70
74
  return false unless @expiration == other.expiration
71
75
  true
@@ -28,6 +28,8 @@ class Clerk::Models::Operations::ClerkIdpOauthAccessToken
28
28
  def updated_at=(str_); end
29
29
  def aud(); end
30
30
  def aud=(str_); end
31
+ def act(); end
32
+ def act=(str_); end
31
33
  def revocation_reason(); end
32
34
  def revocation_reason=(str_); end
33
35
  def expiration(); end
@@ -17,7 +17,7 @@ module Clerk
17
17
  # Metadata that will be attached to the newly created invitation.
18
18
  # The value of this property should be a well-formed JSON object.
19
19
  # Once the user accepts the invitation and signs up, these metadata will end up in the user's public metadata.
20
- field :public_metadata, Crystalline::Nilable.new(Crystalline::Hash.new(Symbol, ::Object)), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('public_metadata') } }
20
+ field :public_metadata, Crystalline::Nilable.new(Crystalline::Hash.new(::Symbol, ::Object)), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('public_metadata') } }
21
21
  # The URL where the user is redirected upon visiting the invitation link, where they can accept the invitation. Required if you have implemented a [custom flow for handling application invitations](/docs/custom-flows/invitations).
22
22
  field :redirect_url, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('redirect_url') } }
23
23
  # The number of days the invitation will be valid for. By default, the invitation expires after 30 days.
@@ -13,11 +13,15 @@ module Clerk
13
13
 
14
14
  include Crystalline::MetadataFields
15
15
 
16
+ # The IdP X.509 signing certificates the connection trusts, one per entry, in PEM or bare base64. Replaces the connection's whole certificate set and takes precedence over idp_certificate
17
+ field :idp_certificates, Crystalline::Nilable.new(Crystalline::Array.new(::String)), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('idp_certificates') } }
16
18
  # IdP entity ID
17
19
  field :idp_entity_id, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('idp_entity_id') } }
18
20
  # IdP SSO URL
19
21
  field :idp_sso_url, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('idp_sso_url') } }
20
- # IdP certificate (PEM)
22
+ # Deprecated, use idp_certificates. One X.509 certificate, PEM or bare base64, or several concatenated PEM certificates; replaces the connection's whole certificate set
23
+ #
24
+ # @deprecated true: This will be removed in a future release, please migrate away from it as soon as possible.
21
25
  field :idp_certificate, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('idp_certificate') } }
22
26
  # URL to IdP metadata
23
27
  field :idp_metadata_url, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('idp_metadata_url') } }
@@ -35,7 +39,8 @@ module Clerk
35
39
  field :login_hint, Crystalline::Nilable.new(Models::Operations::CreateEnterpriseConnectionLoginHint), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('login_hint') } }
36
40
 
37
41
 
38
- def initialize(idp_entity_id: nil, idp_sso_url: nil, idp_certificate: nil, idp_metadata_url: nil, idp_metadata: nil, attribute_mapping: nil, allow_subdomains: nil, allow_idp_initiated: nil, force_authn: nil, login_hint: nil)
42
+ def initialize(idp_certificates: nil, idp_entity_id: nil, idp_sso_url: nil, idp_certificate: nil, idp_metadata_url: nil, idp_metadata: nil, attribute_mapping: nil, allow_subdomains: nil, allow_idp_initiated: nil, force_authn: nil, login_hint: nil)
43
+ @idp_certificates = idp_certificates
39
44
  @idp_entity_id = idp_entity_id
40
45
  @idp_sso_url = idp_sso_url
41
46
  @idp_certificate = idp_certificate
@@ -51,6 +56,7 @@ module Clerk
51
56
 
52
57
  def ==(other)
53
58
  return false unless other.is_a? self.class
59
+ return false unless @idp_certificates == other.idp_certificates
54
60
  return false unless @idp_entity_id == other.idp_entity_id
55
61
  return false unless @idp_sso_url == other.idp_sso_url
56
62
  return false unless @idp_certificate == other.idp_certificate
@@ -8,6 +8,8 @@ end
8
8
 
9
9
 
10
10
  class Clerk::Models::Operations::CreateEnterpriseConnectionSaml
11
+ def idp_certificates(); end
12
+ def idp_certificates=(str_); end
11
13
  def idp_entity_id(); end
12
14
  def idp_entity_id=(str_); end
13
15
  def idp_sso_url(); end
@@ -17,7 +17,7 @@ module Clerk
17
17
  # Metadata that will be attached to the newly created invitation.
18
18
  # The value of this property should be a well-formed JSON object.
19
19
  # Once the user accepts the invitation and signs up, these metadata will end up in the user's public metadata.
20
- field :public_metadata, Crystalline::Nilable.new(Crystalline::Hash.new(Symbol, ::Object)), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('public_metadata') } }
20
+ field :public_metadata, Crystalline::Nilable.new(Crystalline::Hash.new(::Symbol, ::Object)), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('public_metadata') } }
21
21
  # Optional URL which specifies where to redirect the user once they click the invitation link.
22
22
  # This is only required if you have implemented a [custom flow](https://clerk.com/docs/authentication/invitations#custom-flow) and you're not using Clerk Hosted Pages or Clerk Components.
23
23
  field :redirect_url, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('redirect_url') } }
@@ -15,12 +15,18 @@ module Clerk
15
15
  # The name of the new OAuth application.
16
16
  # Max length: 256
17
17
  field :name, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('name'), required: true } }
18
+ # Enable exchanges from the active audience. Requires an audience URI. Disabling preserves target configuration.
19
+ field :token_exchange_enabled, Crystalline::Nilable.new(Crystalline::Boolean.new), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('token_exchange_enabled') } }
20
+ # Confirm adoption of an existing unowned resource, preserving its accepted scopes and target references. Does not override another application's reservation.
21
+ field :adopt_audience_resource, Crystalline::Nilable.new(Crystalline::Boolean.new), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('adopt_audience_resource') } }
18
22
  # An array of redirect URIs of the new OAuth application
19
23
  field :redirect_uris, Crystalline::Nilable.new(Crystalline::Array.new(::String)), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('redirect_uris') } }
20
24
  # The callback URL of the new OAuth application
21
25
  #
22
26
  # @deprecated true: This will be removed in a future release, please migrate away from it as soon as possible.
23
27
  field :callback_url, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('callback_url') } }
28
+ # An absolute resource URI for a confidential application (RFC 8707 section 2). Registers a resource with no accepted scopes, or adopts an unowned resource with confirmation. Every claimed URI remains permanently reserved to this app, including retirement and deletion, and counts toward the instance resource quota. Changing it stops new exchanges from the old audience immediately. Already-issued tokens retain their lifetime. Clearing requires exchange disabled in an earlier update.
29
+ field :audience_uri, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('audience_uri') } }
24
30
  # If true, this client is public and you can use the Proof Key of Code Exchange (PKCE) flow.
25
31
  field :public, Crystalline::Nilable.new(Crystalline::Boolean.new), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('public') } }
26
32
  # Define the application's built-in and custom scope ceiling. Provide scope keys as a space-delimited string. Custom keys must exist in the instance OAuth scope catalog.
@@ -33,10 +39,13 @@ module Clerk
33
39
  field :device_authorization_grant_enabled, Crystalline::Nilable.new(Crystalline::Boolean.new), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('device_authorization_grant_enabled') } }
34
40
 
35
41
 
36
- def initialize(name:, redirect_uris: nil, callback_url: nil, public: nil, scopes: 'profile email', consent_screen_enabled: true, pkce_required: false, device_authorization_grant_enabled: false)
42
+ def initialize(name:, token_exchange_enabled: nil, adopt_audience_resource: nil, redirect_uris: nil, callback_url: nil, audience_uri: nil, public: nil, scopes: 'profile email', consent_screen_enabled: true, pkce_required: false, device_authorization_grant_enabled: false)
37
43
  @name = name
44
+ @token_exchange_enabled = token_exchange_enabled
45
+ @adopt_audience_resource = adopt_audience_resource
38
46
  @redirect_uris = redirect_uris
39
47
  @callback_url = callback_url
48
+ @audience_uri = audience_uri
40
49
  @public = public
41
50
  @scopes = scopes
42
51
  @consent_screen_enabled = consent_screen_enabled
@@ -48,8 +57,11 @@ module Clerk
48
57
  def ==(other)
49
58
  return false unless other.is_a? self.class
50
59
  return false unless @name == other.name
60
+ return false unless @token_exchange_enabled == other.token_exchange_enabled
61
+ return false unless @adopt_audience_resource == other.adopt_audience_resource
51
62
  return false unless @redirect_uris == other.redirect_uris
52
63
  return false unless @callback_url == other.callback_url
64
+ return false unless @audience_uri == other.audience_uri
53
65
  return false unless @public == other.public
54
66
  return false unless @scopes == other.scopes
55
67
  return false unless @consent_screen_enabled == other.consent_screen_enabled
@@ -10,10 +10,16 @@ end
10
10
  class Clerk::Models::Operations::CreateOAuthApplicationRequest
11
11
  def name(); end
12
12
  def name=(str_); end
13
+ def token_exchange_enabled(); end
14
+ def token_exchange_enabled=(str_); end
15
+ def adopt_audience_resource(); end
16
+ def adopt_audience_resource=(str_); end
13
17
  def redirect_uris(); end
14
18
  def redirect_uris=(str_); end
15
19
  def callback_url(); end
16
20
  def callback_url=(str_); end
21
+ def audience_uri(); end
22
+ def audience_uri=(str_); end
17
23
  def public(); end
18
24
  def public=(str_); end
19
25
  def scopes(); end
@@ -19,9 +19,9 @@ module Clerk
19
19
  # The ID of the User who will become the administrator for the new organization
20
20
  field :created_by, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('created_by') } }
21
21
  # Metadata saved on the organization, accessible only from the Backend API
22
- field :private_metadata, Crystalline::Nilable.new(Crystalline::Hash.new(Symbol, ::Object)), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('private_metadata') } }
22
+ field :private_metadata, Crystalline::Nilable.new(Crystalline::Hash.new(::Symbol, ::Object)), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('private_metadata') } }
23
23
  # Metadata saved on the organization, read-only from the Frontend API and fully accessible (read/write) from the Backend API
24
- field :public_metadata, Crystalline::Nilable.new(Crystalline::Hash.new(Symbol, ::Object)), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('public_metadata') } }
24
+ field :public_metadata, Crystalline::Nilable.new(Crystalline::Hash.new(::Symbol, ::Object)), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('public_metadata') } }
25
25
  # A slug for the new organization.
26
26
  # Can contain only lowercase alphanumeric characters and the dash "-".
27
27
  # Must be unique for the instance.
@@ -21,10 +21,10 @@ module Clerk
21
21
  field :inviter_user_id, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('inviter_user_id') } }
22
22
  # Metadata saved on the organization invitation, read-only from the Frontend API and fully accessible (read/write) from the Backend API.
23
23
  # When the organization invitation is accepted, the metadata will be transferred to the newly created organization membership.
24
- field :public_metadata, Crystalline::Nilable.new(Crystalline::Hash.new(Symbol, ::Object)), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('public_metadata') } }
24
+ field :public_metadata, Crystalline::Nilable.new(Crystalline::Hash.new(::Symbol, ::Object)), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('public_metadata') } }
25
25
  # Metadata saved on the organization invitation, fully accessible (read/write) from the Backend API but not visible from the Frontend API.
26
26
  # When the organization invitation is accepted, the metadata will be transferred to the newly created organization membership.
27
- field :private_metadata, Crystalline::Nilable.new(Crystalline::Hash.new(Symbol, ::Object)), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('private_metadata') } }
27
+ field :private_metadata, Crystalline::Nilable.new(Crystalline::Hash.new(::Symbol, ::Object)), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('private_metadata') } }
28
28
  # Optional URL that the invitee will be redirected to once they accept the invitation by clicking the join link in the invitation email.
29
29
  field :redirect_url, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('redirect_url') } }
30
30
  # The number of days the invitation will be valid for. By default, the invitation has a 30 days expire.
@@ -21,10 +21,10 @@ module Clerk
21
21
  field :inviter_user_id, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('inviter_user_id') } }
22
22
  # Metadata saved on the organization invitation, read-only from the Frontend API and fully accessible (read/write) from the Backend API.
23
23
  # When the organization invitation is accepted, the metadata will be transferred to the newly created organization membership.
24
- field :public_metadata, Crystalline::Nilable.new(Crystalline::Hash.new(Symbol, ::Object)), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('public_metadata') } }
24
+ field :public_metadata, Crystalline::Nilable.new(Crystalline::Hash.new(::Symbol, ::Object)), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('public_metadata') } }
25
25
  # Metadata saved on the organization invitation, fully accessible (read/write) from the Backend API but not visible from the Frontend API.
26
26
  # When the organization invitation is accepted, the metadata will be transferred to the newly created organization membership.
27
- field :private_metadata, Crystalline::Nilable.new(Crystalline::Hash.new(Symbol, ::Object)), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('private_metadata') } }
27
+ field :private_metadata, Crystalline::Nilable.new(Crystalline::Hash.new(::Symbol, ::Object)), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('private_metadata') } }
28
28
  # Optional URL that the invitee will be redirected to once they accept the invitation by clicking the join link in the invitation email.
29
29
  field :redirect_url, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('redirect_url') } }
30
30
  # The number of days the invitation will be valid for. By default, the invitation has a 30 days expire.
@@ -18,9 +18,9 @@ module Clerk
18
18
  # The role that the new member will have in the organization.
19
19
  field :role, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('role'), required: true } }
20
20
  # Metadata saved on the organization membership, that is visible to both your frontend and backend.
21
- field :public_metadata, Crystalline::Nilable.new(Crystalline::Hash.new(Symbol, ::Object)), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('public_metadata') } }
21
+ field :public_metadata, Crystalline::Nilable.new(Crystalline::Hash.new(::Symbol, ::Object)), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('public_metadata') } }
22
22
  # Metadata saved on the organization membership that is only visible to your backend.
23
- field :private_metadata, Crystalline::Nilable.new(Crystalline::Hash.new(Symbol, ::Object)), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('private_metadata') } }
23
+ field :private_metadata, Crystalline::Nilable.new(Crystalline::Hash.new(::Symbol, ::Object)), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('private_metadata') } }
24
24
 
25
25
 
26
26
  def initialize(user_id:, role:, public_metadata: nil, private_metadata: nil)
@@ -22,13 +22,17 @@ module Clerk
22
22
  field :provider, Models::Operations::CreateSAMLConnectionProvider1, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('provider'), required: true, 'decoder': ::Clerk::Utils.enum_from_string(Models::Operations::CreateSAMLConnectionProvider1, false) } }
23
23
  # The domains of your organization. Sign in flows using an email with one of these domains, will use this SAML Connection.
24
24
  field :domains, Crystalline::Nilable.new(Crystalline::Array.new(::String)), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('domains') } }
25
+ # The IdP X.509 signing certificates the connection trusts, one per entry, in PEM or bare base64. Replaces the connection's whole certificate set and takes precedence over idp_certificate
26
+ field :idp_certificates, Crystalline::Nilable.new(Crystalline::Array.new(::String)), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('idp_certificates') } }
25
27
  # Enable or deactivate ForceAuthn
26
28
  field :force_authn, Crystalline::Nilable.new(Crystalline::Boolean.new), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('force_authn') } }
27
29
  # The Entity ID as provided by the IdP
28
30
  field :idp_entity_id, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('idp_entity_id') } }
29
31
  # The Single-Sign On URL as provided by the IdP
30
32
  field :idp_sso_url, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('idp_sso_url') } }
31
- # The X.509 certificate as provided by the IdP
33
+ # Deprecated, use idp_certificates. One X.509 certificate, PEM or bare base64, or several concatenated PEM certificates; replaces the connection's whole certificate set
34
+ #
35
+ # @deprecated true: This will be removed in a future release, please migrate away from it as soon as possible.
32
36
  field :idp_certificate, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('idp_certificate') } }
33
37
  # The URL which serves the IdP metadata. If present, it takes priority over the corresponding individual properties
34
38
  field :idp_metadata_url, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('idp_metadata_url') } }
@@ -42,11 +46,12 @@ module Clerk
42
46
  field :login_hint, Crystalline::Nilable.new(Models::Operations::CreateSAMLConnectionLoginHint1), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('login_hint') } }
43
47
 
44
48
 
45
- def initialize(name:, domain:, provider:, domains: nil, force_authn: nil, idp_entity_id: nil, idp_sso_url: nil, idp_certificate: nil, idp_metadata_url: nil, idp_metadata: nil, organization_id: nil, attribute_mapping: nil, login_hint: nil)
49
+ def initialize(name:, domain:, provider:, domains: nil, idp_certificates: nil, force_authn: nil, idp_entity_id: nil, idp_sso_url: nil, idp_certificate: nil, idp_metadata_url: nil, idp_metadata: nil, organization_id: nil, attribute_mapping: nil, login_hint: nil)
46
50
  @name = name
47
51
  @domain = domain
48
52
  @provider = provider
49
53
  @domains = domains
54
+ @idp_certificates = idp_certificates
50
55
  @force_authn = force_authn
51
56
  @idp_entity_id = idp_entity_id
52
57
  @idp_sso_url = idp_sso_url
@@ -65,6 +70,7 @@ module Clerk
65
70
  return false unless @domain == other.domain
66
71
  return false unless @provider == other.provider
67
72
  return false unless @domains == other.domains
73
+ return false unless @idp_certificates == other.idp_certificates
68
74
  return false unless @force_authn == other.force_authn
69
75
  return false unless @idp_entity_id == other.idp_entity_id
70
76
  return false unless @idp_sso_url == other.idp_sso_url
@@ -16,6 +16,8 @@ class Clerk::Models::Operations::CreateSAMLConnectionRequestBody1
16
16
  def provider=(str_); end
17
17
  def domains(); end
18
18
  def domains=(str_); end
19
+ def idp_certificates(); end
20
+ def idp_certificates=(str_); end
19
21
  def force_authn(); end
20
22
  def force_authn=(str_); end
21
23
  def idp_entity_id(); end
@@ -22,13 +22,17 @@ module Clerk
22
22
  #
23
23
  # @deprecated true: This will be removed in a future release, please migrate away from it as soon as possible.
24
24
  field :domain, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('domain') } }
25
+ # The IdP X.509 signing certificates the connection trusts, one per entry, in PEM or bare base64. Replaces the connection's whole certificate set and takes precedence over idp_certificate
26
+ field :idp_certificates, Crystalline::Nilable.new(Crystalline::Array.new(::String)), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('idp_certificates') } }
25
27
  # Enable or deactivate ForceAuthn
26
28
  field :force_authn, Crystalline::Nilable.new(Crystalline::Boolean.new), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('force_authn') } }
27
29
  # The Entity ID as provided by the IdP
28
30
  field :idp_entity_id, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('idp_entity_id') } }
29
31
  # The Single-Sign On URL as provided by the IdP
30
32
  field :idp_sso_url, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('idp_sso_url') } }
31
- # The X.509 certificate as provided by the IdP
33
+ # Deprecated, use idp_certificates. One X.509 certificate, PEM or bare base64, or several concatenated PEM certificates; replaces the connection's whole certificate set
34
+ #
35
+ # @deprecated true: This will be removed in a future release, please migrate away from it as soon as possible.
32
36
  field :idp_certificate, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('idp_certificate') } }
33
37
  # The URL which serves the IdP metadata. If present, it takes priority over the corresponding individual properties
34
38
  field :idp_metadata_url, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('idp_metadata_url') } }
@@ -42,11 +46,12 @@ module Clerk
42
46
  field :login_hint, Crystalline::Nilable.new(Models::Operations::CreateSAMLConnectionLoginHint2), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('login_hint') } }
43
47
 
44
48
 
45
- def initialize(name:, domains:, provider:, domain: nil, force_authn: nil, idp_entity_id: nil, idp_sso_url: nil, idp_certificate: nil, idp_metadata_url: nil, idp_metadata: nil, organization_id: nil, attribute_mapping: nil, login_hint: nil)
49
+ def initialize(name:, domains:, provider:, domain: nil, idp_certificates: nil, force_authn: nil, idp_entity_id: nil, idp_sso_url: nil, idp_certificate: nil, idp_metadata_url: nil, idp_metadata: nil, organization_id: nil, attribute_mapping: nil, login_hint: nil)
46
50
  @name = name
47
51
  @domains = domains
48
52
  @provider = provider
49
53
  @domain = domain
54
+ @idp_certificates = idp_certificates
50
55
  @force_authn = force_authn
51
56
  @idp_entity_id = idp_entity_id
52
57
  @idp_sso_url = idp_sso_url
@@ -65,6 +70,7 @@ module Clerk
65
70
  return false unless @domains == other.domains
66
71
  return false unless @provider == other.provider
67
72
  return false unless @domain == other.domain
73
+ return false unless @idp_certificates == other.idp_certificates
68
74
  return false unless @force_authn == other.force_authn
69
75
  return false unless @idp_entity_id == other.idp_entity_id
70
76
  return false unless @idp_sso_url == other.idp_sso_url
@@ -16,6 +16,8 @@ class Clerk::Models::Operations::CreateSAMLConnectionRequestBody2
16
16
  def provider=(str_); end
17
17
  def domain(); end
18
18
  def domain=(str_); end
19
+ def idp_certificates(); end
20
+ def idp_certificates=(str_); end
19
21
  def force_authn(); end
20
22
  def force_authn=(str_); end
21
23
  def idp_entity_id(); end
@@ -18,14 +18,27 @@ module Clerk
18
18
  # Organizations must be enabled for the instance, and the user must be a member of the organization.
19
19
  field :org_id, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('org_id') } }
20
20
  # Optional parameter to specify the life duration of the sign in token in seconds.
21
- # By default, the duration is 30 days.
21
+ # By default, the duration is 30 days, or 10 minutes when `second_factor_verification` is set.
22
22
  field :expires_in_seconds, Crystalline::Nilable.new(::Integer), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('expires_in_seconds') } }
23
+ # Optional parameter that lets a user with a second factor enabled complete the sign in without being prompted for it.
24
+ # When omitted, redeeming the token completes only the first factor, and the user must still complete their second factor.
25
+ # `fresh`: the second factor is treated as verified at sign in. The session token's `fva` claim reports a second factor age of 0.
26
+ # `stale`: the second factor is treated as unverified. The session token's `fva` claim reports the maximum second factor age of 99999, so any reverification that requires a second factor prompts the user to complete one.
27
+ # Has no effect for users without a second factor enabled.
28
+ # A token created with this parameter signs in a user with a second factor enabled without prompting for it, so `expires_in_seconds` defaults to 10 minutes. We recommend keeping it short.
29
+ field :second_factor_verification, Crystalline::Nilable.new(Models::Operations::SecondFactorVerification), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('second_factor_verification'), 'decoder': ::Clerk::Utils.enum_from_string(Models::Operations::SecondFactorVerification, true) } }
30
+ # When `true`, creating the token is rejected with a `user_locked` error if the user is locked, and so is redeeming it. A token rejected on redemption stays pending and can be redeemed once the user is unlocked.
31
+ # Has no effect on instances with user lockout disabled.
32
+ # To enforce lockout across a password check and a sign-in token, set this parameter on both requests.
33
+ field :honor_lockout, Crystalline::Nilable.new(Crystalline::Boolean.new), { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('honor_lockout') } }
23
34
 
24
35
 
25
- def initialize(user_id:, org_id: nil, expires_in_seconds: 2_592_000)
36
+ def initialize(user_id:, org_id: nil, expires_in_seconds: nil, second_factor_verification: nil, honor_lockout: false)
26
37
  @user_id = user_id
27
38
  @org_id = org_id
28
39
  @expires_in_seconds = expires_in_seconds
40
+ @second_factor_verification = second_factor_verification
41
+ @honor_lockout = honor_lockout
29
42
  end
30
43
 
31
44
 
@@ -34,6 +47,8 @@ module Clerk
34
47
  return false unless @user_id == other.user_id
35
48
  return false unless @org_id == other.org_id
36
49
  return false unless @expires_in_seconds == other.expires_in_seconds
50
+ return false unless @second_factor_verification == other.second_factor_verification
51
+ return false unless @honor_lockout == other.honor_lockout
37
52
  true
38
53
  end
39
54
  end
@@ -14,4 +14,8 @@ class Clerk::Models::Operations::CreateSignInTokenRequest
14
14
  def org_id=(str_); end
15
15
  def expires_in_seconds(); end
16
16
  def expires_in_seconds=(str_); end
17
+ def second_factor_verification(); end
18
+ def second_factor_verification=(str_); end
19
+ def honor_lockout(); end
20
+ def honor_lockout=(str_); end
17
21
  end
@@ -0,0 +1,32 @@
1
+ # Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
2
+
3
+ # typed: false
4
+ # frozen_string_literal: true
5
+
6
+
7
+ module Clerk
8
+ module Models
9
+ module Operations
10
+
11
+ class CreateSSOBypassAllowlistUserRequest
12
+
13
+ include Crystalline::MetadataFields
14
+
15
+ # The ID of the user to allowlist.
16
+ field :user_id, ::String, { 'format_json': { 'letter_case': ::Clerk::Utils.field_name('user_id'), required: true } }
17
+
18
+
19
+ def initialize(user_id:)
20
+ @user_id = user_id
21
+ end
22
+
23
+
24
+ def ==(other)
25
+ return false unless other.is_a? self.class
26
+ return false unless @user_id == other.user_id
27
+ true
28
+ end
29
+ end
30
+ end
31
+ end
32
+ end
@@ -0,0 +1,13 @@
1
+ # typed: false
2
+ # frozen_string_literal: true
3
+
4
+
5
+ class Clerk::Models::Operations::CreateSSOBypassAllowlistUserRequest
6
+ extend ::Crystalline::MetadataFields::ClassMethods
7
+ end
8
+
9
+
10
+ class Clerk::Models::Operations::CreateSSOBypassAllowlistUserRequest
11
+ def user_id(); end
12
+ def user_id=(str_); end
13
+ end
@@ -0,0 +1,44 @@
1
+ # Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
2
+
3
+ # typed: false
4
+ # frozen_string_literal: true
5
+
6
+
7
+ module Clerk
8
+ module Models
9
+ module Operations
10
+
11
+ class CreateSSOBypassAllowlistUserResponse
12
+
13
+ include Crystalline::MetadataFields
14
+
15
+ # HTTP response content type for this operation
16
+ field :content_type, ::String
17
+ # HTTP response status code for this operation
18
+ field :status_code, ::Integer
19
+ # Raw HTTP response; suitable for custom response parsing
20
+ field :raw_response, ::Faraday::Response
21
+ # An SSO bypass allowlist entry
22
+ field :sso_bypass_allowlist_user, Crystalline::Nilable.new(Models::Components::SSOBypassAllowlistUser)
23
+
24
+
25
+ def initialize(content_type:, status_code:, raw_response:, sso_bypass_allowlist_user: nil)
26
+ @content_type = content_type
27
+ @status_code = status_code
28
+ @raw_response = raw_response
29
+ @sso_bypass_allowlist_user = sso_bypass_allowlist_user
30
+ end
31
+
32
+
33
+ def ==(other)
34
+ return false unless other.is_a? self.class
35
+ return false unless @content_type == other.content_type
36
+ return false unless @status_code == other.status_code
37
+ return false unless @raw_response == other.raw_response
38
+ return false unless @sso_bypass_allowlist_user == other.sso_bypass_allowlist_user
39
+ true
40
+ end
41
+ end
42
+ end
43
+ end
44
+ end
@@ -0,0 +1,19 @@
1
+ # typed: false
2
+ # frozen_string_literal: true
3
+
4
+
5
+ class Clerk::Models::Operations::CreateSSOBypassAllowlistUserResponse
6
+ extend ::Crystalline::MetadataFields::ClassMethods
7
+ end
8
+
9
+
10
+ class Clerk::Models::Operations::CreateSSOBypassAllowlistUserResponse
11
+ def content_type(); end
12
+ def content_type=(str_); end
13
+ def status_code(); end
14
+ def status_code=(str_); end
15
+ def raw_response(); end
16
+ def raw_response=(str_); end
17
+ def sso_bypass_allowlist_user(); end
18
+ def sso_bypass_allowlist_user=(str_); end
19
+ end