ory-client 1.22.39 → 1.22.40

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 (813) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/README.md +64 -10
  4. data/docs/APIKeysApi.md +1229 -0
  5. data/docs/AdminRevokeAPIKeyBody.md +20 -0
  6. data/docs/AdminRotateIssuedAPIKeyBody.md +28 -0
  7. data/docs/AdminUpdateImportedAPIKeyRequest.md +44 -0
  8. data/docs/AdminUpdateIssuedAPIKeyRequest.md +44 -0
  9. data/docs/Any.md +18 -0
  10. data/docs/BatchImportAPIKeysRequest.md +18 -0
  11. data/docs/BatchImportAPIKeysResponse.md +22 -0
  12. data/docs/BatchImportErrorCode.md +15 -0
  13. data/docs/BatchImportResult.md +24 -0
  14. data/docs/BatchVerifyAPIKeysRequest.md +18 -0
  15. data/docs/BatchVerifyAPIKeysResponse.md +18 -0
  16. data/docs/DeriveTokenRequest.md +26 -0
  17. data/docs/DeriveTokenResponse.md +18 -0
  18. data/docs/GetJWKSResponse.md +18 -0
  19. data/docs/IPRestriction.md +18 -0
  20. data/docs/ImportAPIKeyRequest.md +36 -0
  21. data/docs/ImportedAPIKey.md +46 -0
  22. data/docs/IssueAPIKeyRequest.md +34 -0
  23. data/docs/IssueAPIKeyResponse.md +20 -0
  24. data/docs/IssuedAPIKey.md +46 -0
  25. data/docs/KeyStatus.md +15 -0
  26. data/docs/KeyVisibility.md +15 -0
  27. data/docs/ListImportedAPIKeysResponse.md +20 -0
  28. data/docs/ListIssuedAPIKeysResponse.md +20 -0
  29. data/docs/NullValue.md +15 -0
  30. data/docs/RateLimitPolicy.md +22 -0
  31. data/docs/RevocationReason.md +15 -0
  32. data/docs/RotateIssuedAPIKeyResponse.md +22 -0
  33. data/docs/SelfRevokeAPIKeyRequest.md +20 -0
  34. data/docs/Status.md +22 -0
  35. data/docs/Token.md +24 -0
  36. data/docs/TokenAlgorithm.md +15 -0
  37. data/docs/ValidateBaseURLRewriteRequest.md +22 -0
  38. data/docs/ValidateBaseURLRewriteResponse.md +20 -0
  39. data/docs/VerificationErrorCode.md +15 -0
  40. data/docs/VerifyAPIKeyRequest.md +18 -0
  41. data/docs/VerifyAPIKeyResponse.md +44 -0
  42. data/lib/ory-client/api/api_keys_api.rb +1190 -0
  43. data/lib/ory-client/api/courier_api.rb +1 -1
  44. data/lib/ory-client/api/events_api.rb +1 -1
  45. data/lib/ory-client/api/frontend_api.rb +1 -1
  46. data/lib/ory-client/api/identity_api.rb +1 -1
  47. data/lib/ory-client/api/jwk_api.rb +1 -1
  48. data/lib/ory-client/api/metadata_api.rb +1 -1
  49. data/lib/ory-client/api/o_auth2_api.rb +1 -1
  50. data/lib/ory-client/api/oidc_api.rb +1 -1
  51. data/lib/ory-client/api/permission_api.rb +1 -1
  52. data/lib/ory-client/api/project_api.rb +1 -1
  53. data/lib/ory-client/api/relationship_api.rb +1 -1
  54. data/lib/ory-client/api/wellknown_api.rb +1 -1
  55. data/lib/ory-client/api/workspace_api.rb +1 -1
  56. data/lib/ory-client/api_client.rb +1 -1
  57. data/lib/ory-client/api_error.rb +1 -1
  58. data/lib/ory-client/api_model_base.rb +1 -1
  59. data/lib/ory-client/configuration.rb +1 -1
  60. data/lib/ory-client/models/accept_device_user_code_request.rb +1 -1
  61. data/lib/ory-client/models/accept_o_auth2_consent_request.rb +1 -1
  62. data/lib/ory-client/models/accept_o_auth2_consent_request_session.rb +1 -1
  63. data/lib/ory-client/models/accept_o_auth2_login_request.rb +1 -1
  64. data/lib/ory-client/models/account_experience_colors.rb +1 -1
  65. data/lib/ory-client/models/account_experience_configuration.rb +1 -1
  66. data/lib/ory-client/models/add_project_to_workspace_body.rb +1 -1
  67. data/lib/ory-client/models/admin_identity_import_credentials_lookup_secret.rb +1 -1
  68. data/lib/ory-client/models/admin_identity_import_credentials_lookup_secret_config.rb +1 -1
  69. data/lib/ory-client/models/admin_revoke_api_key_body.rb +181 -0
  70. data/lib/ory-client/models/admin_rotate_issued_api_key_body.rb +222 -0
  71. data/lib/ory-client/models/admin_update_imported_api_key_request.rb +297 -0
  72. data/lib/ory-client/models/admin_update_issued_api_key_request.rb +297 -0
  73. data/lib/ory-client/models/any.rb +147 -0
  74. data/lib/ory-client/models/attribute.rb +1 -1
  75. data/lib/ory-client/models/attribute_filter.rb +1 -1
  76. data/lib/ory-client/models/attributes_count_datapoint.rb +1 -1
  77. data/lib/ory-client/models/authenticator_assurance_level.rb +1 -1
  78. data/lib/ory-client/models/basic_organization.rb +1 -1
  79. data/lib/ory-client/models/batch_check_permission_body.rb +1 -1
  80. data/lib/ory-client/models/batch_check_permission_result.rb +1 -1
  81. data/lib/ory-client/models/batch_import_api_keys_request.rb +150 -0
  82. data/lib/ory-client/models/batch_import_api_keys_response.rb +168 -0
  83. data/lib/ory-client/models/batch_import_error_code.rb +43 -0
  84. data/lib/ory-client/models/batch_import_result.rb +199 -0
  85. data/lib/ory-client/models/batch_patch_identities_response.rb +1 -1
  86. data/lib/ory-client/models/batch_verify_api_keys_request.rb +149 -0
  87. data/lib/ory-client/models/batch_verify_api_keys_response.rb +149 -0
  88. data/lib/ory-client/models/billing_period_bucket.rb +1 -1
  89. data/lib/ory-client/models/check_opl_syntax_result.rb +1 -1
  90. data/lib/ory-client/models/check_permission_result.rb +1 -1
  91. data/lib/ory-client/models/check_permission_result_with_error.rb +1 -1
  92. data/lib/ory-client/models/cloud_account.rb +1 -1
  93. data/lib/ory-client/models/consistency_request_parameters.rb +1 -1
  94. data/lib/ory-client/models/continue_with.rb +1 -1
  95. data/lib/ory-client/models/continue_with_recovery_ui.rb +1 -1
  96. data/lib/ory-client/models/continue_with_recovery_ui_flow.rb +1 -1
  97. data/lib/ory-client/models/continue_with_redirect_browser_to.rb +1 -1
  98. data/lib/ory-client/models/continue_with_set_ory_session_token.rb +1 -1
  99. data/lib/ory-client/models/continue_with_settings_ui.rb +1 -1
  100. data/lib/ory-client/models/continue_with_settings_ui_flow.rb +1 -1
  101. data/lib/ory-client/models/continue_with_verification_ui.rb +1 -1
  102. data/lib/ory-client/models/continue_with_verification_ui_flow.rb +1 -1
  103. data/lib/ory-client/models/courier_message_status.rb +1 -1
  104. data/lib/ory-client/models/courier_message_type.rb +1 -1
  105. data/lib/ory-client/models/create_custom_domain_body.rb +1 -1
  106. data/lib/ory-client/models/create_event_stream_body.rb +1 -1
  107. data/lib/ory-client/models/create_fedcm_flow_response.rb +1 -1
  108. data/lib/ory-client/models/create_identity_body.rb +1 -1
  109. data/lib/ory-client/models/create_invite_response.rb +1 -1
  110. data/lib/ory-client/models/create_json_web_key_set.rb +1 -1
  111. data/lib/ory-client/models/create_onboarding_link_response.rb +1 -1
  112. data/lib/ory-client/models/create_organization_onboarding_portal_link_body.rb +1 -1
  113. data/lib/ory-client/models/create_project_api_key_request.rb +1 -1
  114. data/lib/ory-client/models/create_project_body.rb +1 -1
  115. data/lib/ory-client/models/create_project_branding.rb +1 -1
  116. data/lib/ory-client/models/create_project_member_invite_body.rb +1 -1
  117. data/lib/ory-client/models/create_project_normalized_payload.rb +1 -1
  118. data/lib/ory-client/models/create_recovery_code_for_identity_body.rb +1 -1
  119. data/lib/ory-client/models/create_recovery_link_for_identity_body.rb +1 -1
  120. data/lib/ory-client/models/create_relationship_body.rb +1 -1
  121. data/lib/ory-client/models/create_subscription_body.rb +1 -1
  122. data/lib/ory-client/models/create_subscription_common.rb +1 -1
  123. data/lib/ory-client/models/create_test_login_flow_body.rb +1 -1
  124. data/lib/ory-client/models/create_verifiable_credential_request_body.rb +1 -1
  125. data/lib/ory-client/models/create_workspace_api_key_body.rb +1 -1
  126. data/lib/ory-client/models/create_workspace_body.rb +1 -1
  127. data/lib/ory-client/models/create_workspace_member_invite_body.rb +1 -1
  128. data/lib/ory-client/models/create_workspace_organization_body.rb +1 -1
  129. data/lib/ory-client/models/create_workspace_subscription_body.rb +1 -1
  130. data/lib/ory-client/models/credential_supported_draft00.rb +1 -1
  131. data/lib/ory-client/models/custom_domain.rb +1 -1
  132. data/lib/ory-client/models/customer_portal_availability.rb +1 -1
  133. data/lib/ory-client/models/delete_my_sessions_count.rb +1 -1
  134. data/lib/ory-client/models/derive_token_request.rb +211 -0
  135. data/lib/ory-client/models/derive_token_response.rb +147 -0
  136. data/lib/ory-client/models/device_authn_android_authorization_list.rb +1 -1
  137. data/lib/ory-client/models/device_authn_android_key_description.rb +1 -1
  138. data/lib/ory-client/models/device_authn_android_root_of_trust.rb +1 -1
  139. data/lib/ory-client/models/device_authn_attestation.rb +1 -1
  140. data/lib/ory-client/models/device_authn_ios_att_stmt.rb +1 -1
  141. data/lib/ory-client/models/device_authn_ios_attestation.rb +1 -1
  142. data/lib/ory-client/models/device_authn_key.rb +1 -1
  143. data/lib/ory-client/models/device_authorization.rb +1 -1
  144. data/lib/ory-client/models/device_user_auth_request.rb +1 -1
  145. data/lib/ory-client/models/email_template_data.rb +1 -1
  146. data/lib/ory-client/models/email_template_data_body.rb +1 -1
  147. data/lib/ory-client/models/error_authenticator_assurance_level_not_satisfied.rb +1 -1
  148. data/lib/ory-client/models/error_browser_location_change_required.rb +1 -1
  149. data/lib/ory-client/models/error_flow_replaced.rb +1 -1
  150. data/lib/ory-client/models/error_generic.rb +1 -1
  151. data/lib/ory-client/models/error_o_auth2.rb +1 -1
  152. data/lib/ory-client/models/event_stream.rb +1 -1
  153. data/lib/ory-client/models/expanded_permission_tree.rb +1 -1
  154. data/lib/ory-client/models/flow_error.rb +1 -1
  155. data/lib/ory-client/models/generic_error.rb +1 -1
  156. data/lib/ory-client/models/generic_error_content.rb +1 -1
  157. data/lib/ory-client/models/generic_oidc_provider.rb +1 -1
  158. data/lib/ory-client/models/generic_usage.rb +1 -1
  159. data/lib/ory-client/models/get_attributes_count.rb +1 -1
  160. data/lib/ory-client/models/get_jwks_response.rb +148 -0
  161. data/lib/ory-client/models/get_managed_identity_schema_location.rb +1 -1
  162. data/lib/ory-client/models/get_metrics_count.rb +1 -1
  163. data/lib/ory-client/models/get_metrics_event_attributes.rb +1 -1
  164. data/lib/ory-client/models/get_metrics_event_types.rb +1 -1
  165. data/lib/ory-client/models/get_organization_response.rb +1 -1
  166. data/lib/ory-client/models/get_project_events.rb +1 -1
  167. data/lib/ory-client/models/get_project_events_body.rb +1 -1
  168. data/lib/ory-client/models/get_project_metrics.rb +1 -1
  169. data/lib/ory-client/models/get_session_activity.rb +1 -1
  170. data/lib/ory-client/models/get_version200_response.rb +1 -1
  171. data/lib/ory-client/models/health_not_ready_status.rb +1 -1
  172. data/lib/ory-client/models/health_status.rb +1 -1
  173. data/lib/ory-client/models/identity.rb +1 -1
  174. data/lib/ory-client/models/identity_credentials.rb +1 -1
  175. data/lib/ory-client/models/identity_credentials_code.rb +1 -1
  176. data/lib/ory-client/models/identity_credentials_code_address.rb +1 -1
  177. data/lib/ory-client/models/identity_credentials_lookup_secret_code.rb +1 -1
  178. data/lib/ory-client/models/identity_credentials_oidc.rb +1 -1
  179. data/lib/ory-client/models/identity_credentials_oidc_provider.rb +1 -1
  180. data/lib/ory-client/models/identity_credentials_password.rb +1 -1
  181. data/lib/ory-client/models/identity_credentials_web_authn.rb +1 -1
  182. data/lib/ory-client/models/identity_credentials_web_authn_attestation.rb +1 -1
  183. data/lib/ory-client/models/identity_credentials_web_authn_authenticator.rb +1 -1
  184. data/lib/ory-client/models/identity_credentials_web_authn_flags.rb +1 -1
  185. data/lib/ory-client/models/identity_patch.rb +1 -1
  186. data/lib/ory-client/models/identity_patch_response.rb +1 -1
  187. data/lib/ory-client/models/identity_schema_container.rb +1 -1
  188. data/lib/ory-client/models/identity_schema_preset.rb +1 -1
  189. data/lib/ory-client/models/identity_with_credentials.rb +1 -1
  190. data/lib/ory-client/models/identity_with_credentials_oidc.rb +1 -1
  191. data/lib/ory-client/models/identity_with_credentials_oidc_config.rb +1 -1
  192. data/lib/ory-client/models/identity_with_credentials_oidc_config_provider.rb +1 -1
  193. data/lib/ory-client/models/identity_with_credentials_passkey.rb +1 -1
  194. data/lib/ory-client/models/identity_with_credentials_passkey_config.rb +1 -1
  195. data/lib/ory-client/models/identity_with_credentials_password.rb +1 -1
  196. data/lib/ory-client/models/identity_with_credentials_password_config.rb +1 -1
  197. data/lib/ory-client/models/identity_with_credentials_saml.rb +1 -1
  198. data/lib/ory-client/models/identity_with_credentials_saml_config.rb +1 -1
  199. data/lib/ory-client/models/identity_with_credentials_saml_config_provider.rb +1 -1
  200. data/lib/ory-client/models/identity_with_credentials_totp.rb +1 -1
  201. data/lib/ory-client/models/identity_with_credentials_totp_config.rb +1 -1
  202. data/lib/ory-client/models/identity_with_credentials_web_authn.rb +1 -1
  203. data/lib/ory-client/models/identity_with_credentials_web_authn_config.rb +1 -1
  204. data/lib/ory-client/models/import_api_key_request.rb +258 -0
  205. data/lib/ory-client/models/imported_api_key.rb +306 -0
  206. data/lib/ory-client/models/internal_get_project_branding_body.rb +1 -1
  207. data/lib/ory-client/models/internal_is_ax_welcome_screen_enabled_for_project_body.rb +1 -1
  208. data/lib/ory-client/models/internal_is_owner_for_project_by_slug.rb +1 -1
  209. data/lib/ory-client/models/internal_is_owner_for_project_by_slug_body.rb +1 -1
  210. data/lib/ory-client/models/introspected_o_auth2_token.rb +1 -1
  211. data/lib/ory-client/models/invite_token_body.rb +1 -1
  212. data/lib/ory-client/models/invoice.rb +1 -1
  213. data/lib/ory-client/models/invoice_data_v1.rb +1 -1
  214. data/lib/ory-client/models/ip_restriction.rb +151 -0
  215. data/lib/ory-client/models/is_owner_for_project_by_slug.rb +1 -1
  216. data/lib/ory-client/models/issue_api_key_request.rb +247 -0
  217. data/lib/ory-client/models/issue_api_key_response.rb +156 -0
  218. data/lib/ory-client/models/issued_api_key.rb +306 -0
  219. data/lib/ory-client/models/json_patch.rb +1 -1
  220. data/lib/ory-client/models/json_web_key.rb +1 -1
  221. data/lib/ory-client/models/json_web_key_set.rb +1 -1
  222. data/lib/ory-client/models/keto_namespace.rb +1 -1
  223. data/lib/ory-client/models/key_status.rb +42 -0
  224. data/lib/ory-client/models/key_visibility.rb +41 -0
  225. data/lib/ory-client/models/keyset_pagination_request_parameters.rb +1 -1
  226. data/lib/ory-client/models/keyset_pagination_response_headers.rb +1 -1
  227. data/lib/ory-client/models/line_item_v1.rb +1 -1
  228. data/lib/ory-client/models/list_event_streams.rb +1 -1
  229. data/lib/ory-client/models/list_imported_api_keys_response.rb +158 -0
  230. data/lib/ory-client/models/list_invoices_response.rb +1 -1
  231. data/lib/ory-client/models/list_issued_api_keys_response.rb +158 -0
  232. data/lib/ory-client/models/list_organizations_response.rb +1 -1
  233. data/lib/ory-client/models/list_workspace_projects.rb +1 -1
  234. data/lib/ory-client/models/list_workspaces.rb +1 -1
  235. data/lib/ory-client/models/login_flow.rb +1 -1
  236. data/lib/ory-client/models/login_flow_state.rb +1 -1
  237. data/lib/ory-client/models/login_flow_test_context.rb +1 -1
  238. data/lib/ory-client/models/login_flow_test_debug_payload.rb +1 -1
  239. data/lib/ory-client/models/login_flow_test_schema_validation_error.rb +1 -1
  240. data/lib/ory-client/models/login_flow_test_step_error.rb +1 -1
  241. data/lib/ory-client/models/logout_flow.rb +1 -1
  242. data/lib/ory-client/models/manage_sessions_body.rb +1 -1
  243. data/lib/ory-client/models/manage_sessions_response.rb +1 -1
  244. data/lib/ory-client/models/managed_identity_schema.rb +1 -1
  245. data/lib/ory-client/models/managed_identity_schema_validation_result.rb +1 -1
  246. data/lib/ory-client/models/member_invite.rb +1 -1
  247. data/lib/ory-client/models/message.rb +1 -1
  248. data/lib/ory-client/models/message_dispatch.rb +1 -1
  249. data/lib/ory-client/models/metrics_datapoint.rb +1 -1
  250. data/lib/ory-client/models/money.rb +1 -1
  251. data/lib/ory-client/models/namespace.rb +1 -1
  252. data/lib/ory-client/models/needs_privileged_session_error.rb +1 -1
  253. data/lib/ory-client/models/normalized_project.rb +1 -1
  254. data/lib/ory-client/models/normalized_project_revision.rb +1 -1
  255. data/lib/ory-client/models/normalized_project_revision_courier_channel.rb +1 -1
  256. data/lib/ory-client/models/normalized_project_revision_hook.rb +1 -1
  257. data/lib/ory-client/models/normalized_project_revision_identity_schema.rb +1 -1
  258. data/lib/ory-client/models/normalized_project_revision_saml_provider.rb +1 -1
  259. data/lib/ory-client/models/normalized_project_revision_scim_client.rb +1 -1
  260. data/lib/ory-client/models/normalized_project_revision_third_party_provider.rb +1 -1
  261. data/lib/ory-client/models/normalized_project_revision_tokenizer_template.rb +1 -1
  262. data/lib/ory-client/models/null_value.rb +39 -0
  263. data/lib/ory-client/models/o_auth2_client.rb +1 -1
  264. data/lib/ory-client/models/o_auth2_client_token_lifespans.rb +1 -1
  265. data/lib/ory-client/models/o_auth2_consent_request.rb +1 -1
  266. data/lib/ory-client/models/o_auth2_consent_request_open_id_connect_context.rb +1 -1
  267. data/lib/ory-client/models/o_auth2_consent_session.rb +1 -1
  268. data/lib/ory-client/models/o_auth2_login_request.rb +1 -1
  269. data/lib/ory-client/models/o_auth2_logout_request.rb +1 -1
  270. data/lib/ory-client/models/o_auth2_redirect_to.rb +1 -1
  271. data/lib/ory-client/models/o_auth2_token_exchange.rb +1 -1
  272. data/lib/ory-client/models/oidc_configuration.rb +1 -1
  273. data/lib/ory-client/models/oidc_user_info.rb +1 -1
  274. data/lib/ory-client/models/onboarding_portal_link.rb +1 -1
  275. data/lib/ory-client/models/onboarding_portal_organization.rb +1 -1
  276. data/lib/ory-client/models/organization.rb +1 -1
  277. data/lib/ory-client/models/organization_body.rb +1 -1
  278. data/lib/ory-client/models/organization_onboarding_portal_links_response.rb +1 -1
  279. data/lib/ory-client/models/parse_error.rb +1 -1
  280. data/lib/ory-client/models/patch_identities_body.rb +1 -1
  281. data/lib/ory-client/models/patch_workspace_member_body.rb +1 -1
  282. data/lib/ory-client/models/perform_native_logout_body.rb +1 -1
  283. data/lib/ory-client/models/permissions_on_workspace.rb +1 -1
  284. data/lib/ory-client/models/plan.rb +1 -1
  285. data/lib/ory-client/models/plan_details.rb +1 -1
  286. data/lib/ory-client/models/post_check_permission_body.rb +1 -1
  287. data/lib/ory-client/models/post_check_permission_or_error_body.rb +1 -1
  288. data/lib/ory-client/models/project.rb +1 -1
  289. data/lib/ory-client/models/project_api_key.rb +1 -1
  290. data/lib/ory-client/models/project_branding.rb +1 -1
  291. data/lib/ory-client/models/project_branding_colors.rb +1 -1
  292. data/lib/ory-client/models/project_branding_theme.rb +1 -1
  293. data/lib/ory-client/models/project_cors.rb +1 -1
  294. data/lib/ory-client/models/project_events_datapoint.rb +1 -1
  295. data/lib/ory-client/models/project_host.rb +1 -1
  296. data/lib/ory-client/models/project_member.rb +1 -1
  297. data/lib/ory-client/models/project_metadata.rb +1 -1
  298. data/lib/ory-client/models/project_service_account_experience.rb +1 -1
  299. data/lib/ory-client/models/project_service_identity.rb +1 -1
  300. data/lib/ory-client/models/project_service_o_auth2.rb +1 -1
  301. data/lib/ory-client/models/project_service_permission.rb +1 -1
  302. data/lib/ory-client/models/project_services.rb +1 -1
  303. data/lib/ory-client/models/provider.rb +1 -1
  304. data/lib/ory-client/models/quota_usage.rb +1 -1
  305. data/lib/ory-client/models/rate_limit_policy.rb +168 -0
  306. data/lib/ory-client/models/recovery_code_for_identity.rb +1 -1
  307. data/lib/ory-client/models/recovery_flow.rb +1 -1
  308. data/lib/ory-client/models/recovery_flow_state.rb +1 -1
  309. data/lib/ory-client/models/recovery_identity_address.rb +1 -1
  310. data/lib/ory-client/models/recovery_link_for_identity.rb +1 -1
  311. data/lib/ory-client/models/registration_flow.rb +1 -1
  312. data/lib/ory-client/models/registration_flow_state.rb +1 -1
  313. data/lib/ory-client/models/reject_o_auth2_request.rb +1 -1
  314. data/lib/ory-client/models/relation_query.rb +1 -1
  315. data/lib/ory-client/models/relationship.rb +1 -1
  316. data/lib/ory-client/models/relationship_namespaces.rb +1 -1
  317. data/lib/ory-client/models/relationship_patch.rb +1 -1
  318. data/lib/ory-client/models/relationships.rb +1 -1
  319. data/lib/ory-client/models/revision_account_experience_custom_translation.rb +1 -1
  320. data/lib/ory-client/models/revocation_reason.rb +43 -0
  321. data/lib/ory-client/models/rfc6749_error_json.rb +1 -1
  322. data/lib/ory-client/models/rotate_issued_api_key_response.rb +165 -0
  323. data/lib/ory-client/models/schema_patch.rb +1 -1
  324. data/lib/ory-client/models/self_revoke_api_key_request.rb +181 -0
  325. data/lib/ory-client/models/self_service_flow_expired_error.rb +1 -1
  326. data/lib/ory-client/models/session.rb +1 -1
  327. data/lib/ory-client/models/session_activity_datapoint.rb +1 -1
  328. data/lib/ory-client/models/session_authentication_method.rb +1 -1
  329. data/lib/ory-client/models/session_device.rb +1 -1
  330. data/lib/ory-client/models/set_custom_domain_body.rb +1 -1
  331. data/lib/ory-client/models/set_event_stream_body.rb +1 -1
  332. data/lib/ory-client/models/set_organization_from_onboarding_portal_link_body.rb +1 -1
  333. data/lib/ory-client/models/set_project.rb +1 -1
  334. data/lib/ory-client/models/set_project_branding_theme_body.rb +1 -1
  335. data/lib/ory-client/models/settings_flow.rb +1 -1
  336. data/lib/ory-client/models/settings_flow_state.rb +1 -1
  337. data/lib/ory-client/models/source_position.rb +1 -1
  338. data/lib/ory-client/models/status.rb +167 -0
  339. data/lib/ory-client/models/subject_set.rb +1 -1
  340. data/lib/ory-client/models/subscription.rb +1 -1
  341. data/lib/ory-client/models/successful_code_exchange_response.rb +1 -1
  342. data/lib/ory-client/models/successful_native_login.rb +1 -1
  343. data/lib/ory-client/models/successful_native_registration.rb +1 -1
  344. data/lib/ory-client/models/successful_project_update.rb +1 -1
  345. data/lib/ory-client/models/tax_line_item.rb +1 -1
  346. data/lib/ory-client/models/time_interval.rb +1 -1
  347. data/lib/ory-client/models/token.rb +178 -0
  348. data/lib/ory-client/models/token_algorithm.rb +41 -0
  349. data/lib/ory-client/models/token_pagination.rb +1 -1
  350. data/lib/ory-client/models/token_pagination_headers.rb +1 -1
  351. data/lib/ory-client/models/token_pagination_request_parameters.rb +1 -1
  352. data/lib/ory-client/models/token_pagination_response_headers.rb +1 -1
  353. data/lib/ory-client/models/trust_o_auth2_jwt_grant_issuer.rb +1 -1
  354. data/lib/ory-client/models/trusted_o_auth2_jwt_grant_issuer.rb +1 -1
  355. data/lib/ory-client/models/trusted_o_auth2_jwt_grant_json_web_key.rb +1 -1
  356. data/lib/ory-client/models/ui_container.rb +1 -1
  357. data/lib/ory-client/models/ui_node.rb +1 -1
  358. data/lib/ory-client/models/ui_node_anchor_attributes.rb +1 -1
  359. data/lib/ory-client/models/ui_node_attributes.rb +1 -1
  360. data/lib/ory-client/models/ui_node_division_attributes.rb +1 -1
  361. data/lib/ory-client/models/ui_node_image_attributes.rb +1 -1
  362. data/lib/ory-client/models/ui_node_input_attributes.rb +1 -1
  363. data/lib/ory-client/models/ui_node_input_attributes_option.rb +1 -1
  364. data/lib/ory-client/models/ui_node_meta.rb +1 -1
  365. data/lib/ory-client/models/ui_node_script_attributes.rb +1 -1
  366. data/lib/ory-client/models/ui_node_text_attributes.rb +1 -1
  367. data/lib/ory-client/models/ui_text.rb +1 -1
  368. data/lib/ory-client/models/update_fedcm_flow_body.rb +1 -1
  369. data/lib/ory-client/models/update_identity_body.rb +1 -1
  370. data/lib/ory-client/models/update_login_flow_body.rb +1 -1
  371. data/lib/ory-client/models/update_login_flow_with_code_method.rb +1 -1
  372. data/lib/ory-client/models/update_login_flow_with_identifier_first_method.rb +1 -1
  373. data/lib/ory-client/models/update_login_flow_with_lookup_secret_method.rb +1 -1
  374. data/lib/ory-client/models/update_login_flow_with_oidc_method.rb +1 -1
  375. data/lib/ory-client/models/update_login_flow_with_passkey_method.rb +1 -1
  376. data/lib/ory-client/models/update_login_flow_with_password_method.rb +1 -1
  377. data/lib/ory-client/models/update_login_flow_with_saml_method.rb +1 -1
  378. data/lib/ory-client/models/update_login_flow_with_totp_method.rb +1 -1
  379. data/lib/ory-client/models/update_login_flow_with_web_authn_method.rb +1 -1
  380. data/lib/ory-client/models/update_organization_onboarding_portal_link_body.rb +1 -1
  381. data/lib/ory-client/models/update_recovery_flow_body.rb +1 -1
  382. data/lib/ory-client/models/update_recovery_flow_with_code_method.rb +1 -1
  383. data/lib/ory-client/models/update_recovery_flow_with_link_method.rb +1 -1
  384. data/lib/ory-client/models/update_registration_flow_body.rb +1 -1
  385. data/lib/ory-client/models/update_registration_flow_with_code_method.rb +1 -1
  386. data/lib/ory-client/models/update_registration_flow_with_oidc_method.rb +1 -1
  387. data/lib/ory-client/models/update_registration_flow_with_passkey_method.rb +1 -1
  388. data/lib/ory-client/models/update_registration_flow_with_password_method.rb +1 -1
  389. data/lib/ory-client/models/update_registration_flow_with_profile_method.rb +1 -1
  390. data/lib/ory-client/models/update_registration_flow_with_saml_method.rb +1 -1
  391. data/lib/ory-client/models/update_registration_flow_with_web_authn_method.rb +1 -1
  392. data/lib/ory-client/models/update_settings_flow_body.rb +1 -1
  393. data/lib/ory-client/models/update_settings_flow_with_lookup_method.rb +1 -1
  394. data/lib/ory-client/models/update_settings_flow_with_oidc_method.rb +1 -1
  395. data/lib/ory-client/models/update_settings_flow_with_passkey_method.rb +1 -1
  396. data/lib/ory-client/models/update_settings_flow_with_password_method.rb +1 -1
  397. data/lib/ory-client/models/update_settings_flow_with_profile_method.rb +1 -1
  398. data/lib/ory-client/models/update_settings_flow_with_saml_method.rb +1 -1
  399. data/lib/ory-client/models/update_settings_flow_with_totp_method.rb +1 -1
  400. data/lib/ory-client/models/update_settings_flow_with_web_authn_method.rb +1 -1
  401. data/lib/ory-client/models/update_subscription_body.rb +1 -1
  402. data/lib/ory-client/models/update_verification_flow_body.rb +1 -1
  403. data/lib/ory-client/models/update_verification_flow_with_code_method.rb +1 -1
  404. data/lib/ory-client/models/update_verification_flow_with_link_method.rb +1 -1
  405. data/lib/ory-client/models/update_workspace_body.rb +1 -1
  406. data/lib/ory-client/models/usage.rb +1 -1
  407. data/lib/ory-client/models/validate_base_url_rewrite_request.rb +220 -0
  408. data/lib/ory-client/models/validate_base_url_rewrite_response.rb +176 -0
  409. data/lib/ory-client/models/verifiable_credential_priming_response.rb +1 -1
  410. data/lib/ory-client/models/verifiable_credential_proof.rb +1 -1
  411. data/lib/ory-client/models/verifiable_credential_response.rb +1 -1
  412. data/lib/ory-client/models/verifiable_identity_address.rb +1 -1
  413. data/lib/ory-client/models/verification_error_code.rb +47 -0
  414. data/lib/ory-client/models/verification_flow.rb +1 -1
  415. data/lib/ory-client/models/verification_flow_state.rb +1 -1
  416. data/lib/ory-client/models/verify_api_key_request.rb +147 -0
  417. data/lib/ory-client/models/verify_api_key_response.rb +299 -0
  418. data/lib/ory-client/models/verify_user_code_request.rb +1 -1
  419. data/lib/ory-client/models/version.rb +1 -1
  420. data/lib/ory-client/models/warning.rb +1 -1
  421. data/lib/ory-client/models/workspace.rb +1 -1
  422. data/lib/ory-client/models/workspace_api_key.rb +1 -1
  423. data/lib/ory-client/models/workspace_organization.rb +1 -1
  424. data/lib/ory-client/version.rb +2 -2
  425. data/lib/ory-client.rb +39 -1
  426. data/ory-client.gemspec +1 -1
  427. data/spec/api/api_keys_api_spec.rb +252 -0
  428. data/spec/api/courier_api_spec.rb +1 -1
  429. data/spec/api/events_api_spec.rb +1 -1
  430. data/spec/api/frontend_api_spec.rb +1 -1
  431. data/spec/api/identity_api_spec.rb +1 -1
  432. data/spec/api/jwk_api_spec.rb +1 -1
  433. data/spec/api/metadata_api_spec.rb +1 -1
  434. data/spec/api/o_auth2_api_spec.rb +1 -1
  435. data/spec/api/oidc_api_spec.rb +1 -1
  436. data/spec/api/permission_api_spec.rb +1 -1
  437. data/spec/api/project_api_spec.rb +1 -1
  438. data/spec/api/relationship_api_spec.rb +1 -1
  439. data/spec/api/wellknown_api_spec.rb +1 -1
  440. data/spec/api/workspace_api_spec.rb +1 -1
  441. data/spec/models/accept_device_user_code_request_spec.rb +1 -1
  442. data/spec/models/accept_o_auth2_consent_request_session_spec.rb +1 -1
  443. data/spec/models/accept_o_auth2_consent_request_spec.rb +1 -1
  444. data/spec/models/accept_o_auth2_login_request_spec.rb +1 -1
  445. data/spec/models/account_experience_colors_spec.rb +1 -1
  446. data/spec/models/account_experience_configuration_spec.rb +1 -1
  447. data/spec/models/add_project_to_workspace_body_spec.rb +1 -1
  448. data/spec/models/admin_identity_import_credentials_lookup_secret_config_spec.rb +1 -1
  449. data/spec/models/admin_identity_import_credentials_lookup_secret_spec.rb +1 -1
  450. data/spec/models/admin_revoke_api_key_body_spec.rb +42 -0
  451. data/spec/models/admin_rotate_issued_api_key_body_spec.rb +66 -0
  452. data/spec/models/admin_update_imported_api_key_request_spec.rb +114 -0
  453. data/spec/models/admin_update_issued_api_key_request_spec.rb +114 -0
  454. data/spec/models/any_spec.rb +36 -0
  455. data/spec/models/attribute_filter_spec.rb +1 -1
  456. data/spec/models/attribute_spec.rb +1 -1
  457. data/spec/models/attributes_count_datapoint_spec.rb +1 -1
  458. data/spec/models/authenticator_assurance_level_spec.rb +1 -1
  459. data/spec/models/basic_organization_spec.rb +1 -1
  460. data/spec/models/batch_check_permission_body_spec.rb +1 -1
  461. data/spec/models/batch_check_permission_result_spec.rb +1 -1
  462. data/spec/models/batch_import_api_keys_request_spec.rb +36 -0
  463. data/spec/models/batch_import_api_keys_response_spec.rb +48 -0
  464. data/spec/models/batch_import_error_code_spec.rb +30 -0
  465. data/spec/models/batch_import_result_spec.rb +54 -0
  466. data/spec/models/batch_patch_identities_response_spec.rb +1 -1
  467. data/spec/models/batch_verify_api_keys_request_spec.rb +36 -0
  468. data/spec/models/batch_verify_api_keys_response_spec.rb +36 -0
  469. data/spec/models/billing_period_bucket_spec.rb +1 -1
  470. data/spec/models/check_opl_syntax_result_spec.rb +1 -1
  471. data/spec/models/check_permission_result_spec.rb +1 -1
  472. data/spec/models/check_permission_result_with_error_spec.rb +1 -1
  473. data/spec/models/cloud_account_spec.rb +1 -1
  474. data/spec/models/consistency_request_parameters_spec.rb +1 -1
  475. data/spec/models/continue_with_recovery_ui_flow_spec.rb +1 -1
  476. data/spec/models/continue_with_recovery_ui_spec.rb +1 -1
  477. data/spec/models/continue_with_redirect_browser_to_spec.rb +1 -1
  478. data/spec/models/continue_with_set_ory_session_token_spec.rb +1 -1
  479. data/spec/models/continue_with_settings_ui_flow_spec.rb +1 -1
  480. data/spec/models/continue_with_settings_ui_spec.rb +1 -1
  481. data/spec/models/continue_with_spec.rb +1 -1
  482. data/spec/models/continue_with_verification_ui_flow_spec.rb +1 -1
  483. data/spec/models/continue_with_verification_ui_spec.rb +1 -1
  484. data/spec/models/courier_message_status_spec.rb +1 -1
  485. data/spec/models/courier_message_type_spec.rb +1 -1
  486. data/spec/models/create_custom_domain_body_spec.rb +1 -1
  487. data/spec/models/create_event_stream_body_spec.rb +1 -1
  488. data/spec/models/create_fedcm_flow_response_spec.rb +1 -1
  489. data/spec/models/create_identity_body_spec.rb +1 -1
  490. data/spec/models/create_invite_response_spec.rb +1 -1
  491. data/spec/models/create_json_web_key_set_spec.rb +1 -1
  492. data/spec/models/create_onboarding_link_response_spec.rb +1 -1
  493. data/spec/models/create_organization_onboarding_portal_link_body_spec.rb +1 -1
  494. data/spec/models/create_project_api_key_request_spec.rb +1 -1
  495. data/spec/models/create_project_body_spec.rb +1 -1
  496. data/spec/models/create_project_branding_spec.rb +1 -1
  497. data/spec/models/create_project_member_invite_body_spec.rb +1 -1
  498. data/spec/models/create_project_normalized_payload_spec.rb +1 -1
  499. data/spec/models/create_recovery_code_for_identity_body_spec.rb +1 -1
  500. data/spec/models/create_recovery_link_for_identity_body_spec.rb +1 -1
  501. data/spec/models/create_relationship_body_spec.rb +1 -1
  502. data/spec/models/create_subscription_body_spec.rb +1 -1
  503. data/spec/models/create_subscription_common_spec.rb +1 -1
  504. data/spec/models/create_test_login_flow_body_spec.rb +1 -1
  505. data/spec/models/create_verifiable_credential_request_body_spec.rb +1 -1
  506. data/spec/models/create_workspace_api_key_body_spec.rb +1 -1
  507. data/spec/models/create_workspace_body_spec.rb +1 -1
  508. data/spec/models/create_workspace_member_invite_body_spec.rb +1 -1
  509. data/spec/models/create_workspace_organization_body_spec.rb +1 -1
  510. data/spec/models/create_workspace_subscription_body_spec.rb +1 -1
  511. data/spec/models/credential_supported_draft00_spec.rb +1 -1
  512. data/spec/models/custom_domain_spec.rb +1 -1
  513. data/spec/models/customer_portal_availability_spec.rb +1 -1
  514. data/spec/models/delete_my_sessions_count_spec.rb +1 -1
  515. data/spec/models/derive_token_request_spec.rb +60 -0
  516. data/spec/models/derive_token_response_spec.rb +36 -0
  517. data/spec/models/device_authn_android_authorization_list_spec.rb +1 -1
  518. data/spec/models/device_authn_android_key_description_spec.rb +1 -1
  519. data/spec/models/device_authn_android_root_of_trust_spec.rb +1 -1
  520. data/spec/models/device_authn_attestation_spec.rb +1 -1
  521. data/spec/models/device_authn_ios_att_stmt_spec.rb +1 -1
  522. data/spec/models/device_authn_ios_attestation_spec.rb +1 -1
  523. data/spec/models/device_authn_key_spec.rb +1 -1
  524. data/spec/models/device_authorization_spec.rb +1 -1
  525. data/spec/models/device_user_auth_request_spec.rb +1 -1
  526. data/spec/models/email_template_data_body_spec.rb +1 -1
  527. data/spec/models/email_template_data_spec.rb +1 -1
  528. data/spec/models/error_authenticator_assurance_level_not_satisfied_spec.rb +1 -1
  529. data/spec/models/error_browser_location_change_required_spec.rb +1 -1
  530. data/spec/models/error_flow_replaced_spec.rb +1 -1
  531. data/spec/models/error_generic_spec.rb +1 -1
  532. data/spec/models/error_o_auth2_spec.rb +1 -1
  533. data/spec/models/event_stream_spec.rb +1 -1
  534. data/spec/models/expanded_permission_tree_spec.rb +1 -1
  535. data/spec/models/flow_error_spec.rb +1 -1
  536. data/spec/models/generic_error_content_spec.rb +1 -1
  537. data/spec/models/generic_error_spec.rb +1 -1
  538. data/spec/models/generic_oidc_provider_spec.rb +1 -1
  539. data/spec/models/generic_usage_spec.rb +1 -1
  540. data/spec/models/get_attributes_count_spec.rb +1 -1
  541. data/spec/models/get_jwks_response_spec.rb +36 -0
  542. data/spec/models/get_managed_identity_schema_location_spec.rb +1 -1
  543. data/spec/models/get_metrics_count_spec.rb +1 -1
  544. data/spec/models/get_metrics_event_attributes_spec.rb +1 -1
  545. data/spec/models/get_metrics_event_types_spec.rb +1 -1
  546. data/spec/models/get_organization_response_spec.rb +1 -1
  547. data/spec/models/get_project_events_body_spec.rb +1 -1
  548. data/spec/models/get_project_events_spec.rb +1 -1
  549. data/spec/models/get_project_metrics_spec.rb +1 -1
  550. data/spec/models/get_session_activity_spec.rb +1 -1
  551. data/spec/models/get_version200_response_spec.rb +1 -1
  552. data/spec/models/health_not_ready_status_spec.rb +1 -1
  553. data/spec/models/health_status_spec.rb +1 -1
  554. data/spec/models/identity_credentials_code_address_spec.rb +1 -1
  555. data/spec/models/identity_credentials_code_spec.rb +1 -1
  556. data/spec/models/identity_credentials_lookup_secret_code_spec.rb +1 -1
  557. data/spec/models/identity_credentials_oidc_provider_spec.rb +1 -1
  558. data/spec/models/identity_credentials_oidc_spec.rb +1 -1
  559. data/spec/models/identity_credentials_password_spec.rb +1 -1
  560. data/spec/models/identity_credentials_spec.rb +1 -1
  561. data/spec/models/identity_credentials_web_authn_attestation_spec.rb +1 -1
  562. data/spec/models/identity_credentials_web_authn_authenticator_spec.rb +1 -1
  563. data/spec/models/identity_credentials_web_authn_flags_spec.rb +1 -1
  564. data/spec/models/identity_credentials_web_authn_spec.rb +1 -1
  565. data/spec/models/identity_patch_response_spec.rb +1 -1
  566. data/spec/models/identity_patch_spec.rb +1 -1
  567. data/spec/models/identity_schema_container_spec.rb +1 -1
  568. data/spec/models/identity_schema_preset_spec.rb +1 -1
  569. data/spec/models/identity_spec.rb +1 -1
  570. data/spec/models/identity_with_credentials_oidc_config_provider_spec.rb +1 -1
  571. data/spec/models/identity_with_credentials_oidc_config_spec.rb +1 -1
  572. data/spec/models/identity_with_credentials_oidc_spec.rb +1 -1
  573. data/spec/models/identity_with_credentials_passkey_config_spec.rb +1 -1
  574. data/spec/models/identity_with_credentials_passkey_spec.rb +1 -1
  575. data/spec/models/identity_with_credentials_password_config_spec.rb +1 -1
  576. data/spec/models/identity_with_credentials_password_spec.rb +1 -1
  577. data/spec/models/identity_with_credentials_saml_config_provider_spec.rb +1 -1
  578. data/spec/models/identity_with_credentials_saml_config_spec.rb +1 -1
  579. data/spec/models/identity_with_credentials_saml_spec.rb +1 -1
  580. data/spec/models/identity_with_credentials_spec.rb +1 -1
  581. data/spec/models/identity_with_credentials_totp_config_spec.rb +1 -1
  582. data/spec/models/identity_with_credentials_totp_spec.rb +1 -1
  583. data/spec/models/identity_with_credentials_web_authn_config_spec.rb +1 -1
  584. data/spec/models/identity_with_credentials_web_authn_spec.rb +1 -1
  585. data/spec/models/import_api_key_request_spec.rb +90 -0
  586. data/spec/models/imported_api_key_spec.rb +120 -0
  587. data/spec/models/internal_get_project_branding_body_spec.rb +1 -1
  588. data/spec/models/internal_is_ax_welcome_screen_enabled_for_project_body_spec.rb +1 -1
  589. data/spec/models/internal_is_owner_for_project_by_slug_body_spec.rb +1 -1
  590. data/spec/models/internal_is_owner_for_project_by_slug_spec.rb +1 -1
  591. data/spec/models/introspected_o_auth2_token_spec.rb +1 -1
  592. data/spec/models/invite_token_body_spec.rb +1 -1
  593. data/spec/models/invoice_data_v1_spec.rb +1 -1
  594. data/spec/models/invoice_spec.rb +1 -1
  595. data/spec/models/ip_restriction_spec.rb +36 -0
  596. data/spec/models/is_owner_for_project_by_slug_spec.rb +1 -1
  597. data/spec/models/issue_api_key_request_spec.rb +84 -0
  598. data/spec/models/issue_api_key_response_spec.rb +42 -0
  599. data/spec/models/issued_api_key_spec.rb +120 -0
  600. data/spec/models/json_patch_spec.rb +1 -1
  601. data/spec/models/json_web_key_set_spec.rb +1 -1
  602. data/spec/models/json_web_key_spec.rb +1 -1
  603. data/spec/models/keto_namespace_spec.rb +1 -1
  604. data/spec/models/key_status_spec.rb +30 -0
  605. data/spec/models/key_visibility_spec.rb +30 -0
  606. data/spec/models/keyset_pagination_request_parameters_spec.rb +1 -1
  607. data/spec/models/keyset_pagination_response_headers_spec.rb +1 -1
  608. data/spec/models/line_item_v1_spec.rb +1 -1
  609. data/spec/models/list_event_streams_spec.rb +1 -1
  610. data/spec/models/list_imported_api_keys_response_spec.rb +42 -0
  611. data/spec/models/list_invoices_response_spec.rb +1 -1
  612. data/spec/models/list_issued_api_keys_response_spec.rb +42 -0
  613. data/spec/models/list_organizations_response_spec.rb +1 -1
  614. data/spec/models/list_workspace_projects_spec.rb +1 -1
  615. data/spec/models/list_workspaces_spec.rb +1 -1
  616. data/spec/models/login_flow_spec.rb +1 -1
  617. data/spec/models/login_flow_state_spec.rb +1 -1
  618. data/spec/models/login_flow_test_context_spec.rb +1 -1
  619. data/spec/models/login_flow_test_debug_payload_spec.rb +1 -1
  620. data/spec/models/login_flow_test_schema_validation_error_spec.rb +1 -1
  621. data/spec/models/login_flow_test_step_error_spec.rb +1 -1
  622. data/spec/models/logout_flow_spec.rb +1 -1
  623. data/spec/models/manage_sessions_body_spec.rb +1 -1
  624. data/spec/models/manage_sessions_response_spec.rb +1 -1
  625. data/spec/models/managed_identity_schema_spec.rb +1 -1
  626. data/spec/models/managed_identity_schema_validation_result_spec.rb +1 -1
  627. data/spec/models/member_invite_spec.rb +1 -1
  628. data/spec/models/message_dispatch_spec.rb +1 -1
  629. data/spec/models/message_spec.rb +1 -1
  630. data/spec/models/metrics_datapoint_spec.rb +1 -1
  631. data/spec/models/money_spec.rb +1 -1
  632. data/spec/models/namespace_spec.rb +1 -1
  633. data/spec/models/needs_privileged_session_error_spec.rb +1 -1
  634. data/spec/models/normalized_project_revision_courier_channel_spec.rb +1 -1
  635. data/spec/models/normalized_project_revision_hook_spec.rb +1 -1
  636. data/spec/models/normalized_project_revision_identity_schema_spec.rb +1 -1
  637. data/spec/models/normalized_project_revision_saml_provider_spec.rb +1 -1
  638. data/spec/models/normalized_project_revision_scim_client_spec.rb +1 -1
  639. data/spec/models/normalized_project_revision_spec.rb +1 -1
  640. data/spec/models/normalized_project_revision_third_party_provider_spec.rb +1 -1
  641. data/spec/models/normalized_project_revision_tokenizer_template_spec.rb +1 -1
  642. data/spec/models/normalized_project_spec.rb +1 -1
  643. data/spec/models/null_value_spec.rb +30 -0
  644. data/spec/models/o_auth2_client_spec.rb +1 -1
  645. data/spec/models/o_auth2_client_token_lifespans_spec.rb +1 -1
  646. data/spec/models/o_auth2_consent_request_open_id_connect_context_spec.rb +1 -1
  647. data/spec/models/o_auth2_consent_request_spec.rb +1 -1
  648. data/spec/models/o_auth2_consent_session_spec.rb +1 -1
  649. data/spec/models/o_auth2_login_request_spec.rb +1 -1
  650. data/spec/models/o_auth2_logout_request_spec.rb +1 -1
  651. data/spec/models/o_auth2_redirect_to_spec.rb +1 -1
  652. data/spec/models/o_auth2_token_exchange_spec.rb +1 -1
  653. data/spec/models/oidc_configuration_spec.rb +1 -1
  654. data/spec/models/oidc_user_info_spec.rb +1 -1
  655. data/spec/models/onboarding_portal_link_spec.rb +1 -1
  656. data/spec/models/onboarding_portal_organization_spec.rb +1 -1
  657. data/spec/models/organization_body_spec.rb +1 -1
  658. data/spec/models/organization_onboarding_portal_links_response_spec.rb +1 -1
  659. data/spec/models/organization_spec.rb +1 -1
  660. data/spec/models/parse_error_spec.rb +1 -1
  661. data/spec/models/patch_identities_body_spec.rb +1 -1
  662. data/spec/models/patch_workspace_member_body_spec.rb +1 -1
  663. data/spec/models/perform_native_logout_body_spec.rb +1 -1
  664. data/spec/models/permissions_on_workspace_spec.rb +1 -1
  665. data/spec/models/plan_details_spec.rb +1 -1
  666. data/spec/models/plan_spec.rb +1 -1
  667. data/spec/models/post_check_permission_body_spec.rb +1 -1
  668. data/spec/models/post_check_permission_or_error_body_spec.rb +1 -1
  669. data/spec/models/project_api_key_spec.rb +1 -1
  670. data/spec/models/project_branding_colors_spec.rb +1 -1
  671. data/spec/models/project_branding_spec.rb +1 -1
  672. data/spec/models/project_branding_theme_spec.rb +1 -1
  673. data/spec/models/project_cors_spec.rb +1 -1
  674. data/spec/models/project_events_datapoint_spec.rb +1 -1
  675. data/spec/models/project_host_spec.rb +1 -1
  676. data/spec/models/project_member_spec.rb +1 -1
  677. data/spec/models/project_metadata_spec.rb +1 -1
  678. data/spec/models/project_service_account_experience_spec.rb +1 -1
  679. data/spec/models/project_service_identity_spec.rb +1 -1
  680. data/spec/models/project_service_o_auth2_spec.rb +1 -1
  681. data/spec/models/project_service_permission_spec.rb +1 -1
  682. data/spec/models/project_services_spec.rb +1 -1
  683. data/spec/models/project_spec.rb +1 -1
  684. data/spec/models/provider_spec.rb +1 -1
  685. data/spec/models/quota_usage_spec.rb +1 -1
  686. data/spec/models/rate_limit_policy_spec.rb +48 -0
  687. data/spec/models/recovery_code_for_identity_spec.rb +1 -1
  688. data/spec/models/recovery_flow_spec.rb +1 -1
  689. data/spec/models/recovery_flow_state_spec.rb +1 -1
  690. data/spec/models/recovery_identity_address_spec.rb +1 -1
  691. data/spec/models/recovery_link_for_identity_spec.rb +1 -1
  692. data/spec/models/registration_flow_spec.rb +1 -1
  693. data/spec/models/registration_flow_state_spec.rb +1 -1
  694. data/spec/models/reject_o_auth2_request_spec.rb +1 -1
  695. data/spec/models/relation_query_spec.rb +1 -1
  696. data/spec/models/relationship_namespaces_spec.rb +1 -1
  697. data/spec/models/relationship_patch_spec.rb +1 -1
  698. data/spec/models/relationship_spec.rb +1 -1
  699. data/spec/models/relationships_spec.rb +1 -1
  700. data/spec/models/revision_account_experience_custom_translation_spec.rb +1 -1
  701. data/spec/models/revocation_reason_spec.rb +30 -0
  702. data/spec/models/rfc6749_error_json_spec.rb +1 -1
  703. data/spec/models/rotate_issued_api_key_response_spec.rb +48 -0
  704. data/spec/models/schema_patch_spec.rb +1 -1
  705. data/spec/models/self_revoke_api_key_request_spec.rb +42 -0
  706. data/spec/models/self_service_flow_expired_error_spec.rb +1 -1
  707. data/spec/models/session_activity_datapoint_spec.rb +1 -1
  708. data/spec/models/session_authentication_method_spec.rb +1 -1
  709. data/spec/models/session_device_spec.rb +1 -1
  710. data/spec/models/session_spec.rb +1 -1
  711. data/spec/models/set_custom_domain_body_spec.rb +1 -1
  712. data/spec/models/set_event_stream_body_spec.rb +1 -1
  713. data/spec/models/set_organization_from_onboarding_portal_link_body_spec.rb +1 -1
  714. data/spec/models/set_project_branding_theme_body_spec.rb +1 -1
  715. data/spec/models/set_project_spec.rb +1 -1
  716. data/spec/models/settings_flow_spec.rb +1 -1
  717. data/spec/models/settings_flow_state_spec.rb +1 -1
  718. data/spec/models/source_position_spec.rb +1 -1
  719. data/spec/models/status_spec.rb +48 -0
  720. data/spec/models/subject_set_spec.rb +1 -1
  721. data/spec/models/subscription_spec.rb +1 -1
  722. data/spec/models/successful_code_exchange_response_spec.rb +1 -1
  723. data/spec/models/successful_native_login_spec.rb +1 -1
  724. data/spec/models/successful_native_registration_spec.rb +1 -1
  725. data/spec/models/successful_project_update_spec.rb +1 -1
  726. data/spec/models/tax_line_item_spec.rb +1 -1
  727. data/spec/models/time_interval_spec.rb +1 -1
  728. data/spec/models/token_algorithm_spec.rb +30 -0
  729. data/spec/models/token_pagination_headers_spec.rb +1 -1
  730. data/spec/models/token_pagination_request_parameters_spec.rb +1 -1
  731. data/spec/models/token_pagination_response_headers_spec.rb +1 -1
  732. data/spec/models/token_pagination_spec.rb +1 -1
  733. data/spec/models/token_spec.rb +54 -0
  734. data/spec/models/trust_o_auth2_jwt_grant_issuer_spec.rb +1 -1
  735. data/spec/models/trusted_o_auth2_jwt_grant_issuer_spec.rb +1 -1
  736. data/spec/models/trusted_o_auth2_jwt_grant_json_web_key_spec.rb +1 -1
  737. data/spec/models/ui_container_spec.rb +1 -1
  738. data/spec/models/ui_node_anchor_attributes_spec.rb +1 -1
  739. data/spec/models/ui_node_attributes_spec.rb +1 -1
  740. data/spec/models/ui_node_division_attributes_spec.rb +1 -1
  741. data/spec/models/ui_node_image_attributes_spec.rb +1 -1
  742. data/spec/models/ui_node_input_attributes_option_spec.rb +1 -1
  743. data/spec/models/ui_node_input_attributes_spec.rb +1 -1
  744. data/spec/models/ui_node_meta_spec.rb +1 -1
  745. data/spec/models/ui_node_script_attributes_spec.rb +1 -1
  746. data/spec/models/ui_node_spec.rb +1 -1
  747. data/spec/models/ui_node_text_attributes_spec.rb +1 -1
  748. data/spec/models/ui_text_spec.rb +1 -1
  749. data/spec/models/update_fedcm_flow_body_spec.rb +1 -1
  750. data/spec/models/update_identity_body_spec.rb +1 -1
  751. data/spec/models/update_login_flow_body_spec.rb +1 -1
  752. data/spec/models/update_login_flow_with_code_method_spec.rb +1 -1
  753. data/spec/models/update_login_flow_with_identifier_first_method_spec.rb +1 -1
  754. data/spec/models/update_login_flow_with_lookup_secret_method_spec.rb +1 -1
  755. data/spec/models/update_login_flow_with_oidc_method_spec.rb +1 -1
  756. data/spec/models/update_login_flow_with_passkey_method_spec.rb +1 -1
  757. data/spec/models/update_login_flow_with_password_method_spec.rb +1 -1
  758. data/spec/models/update_login_flow_with_saml_method_spec.rb +1 -1
  759. data/spec/models/update_login_flow_with_totp_method_spec.rb +1 -1
  760. data/spec/models/update_login_flow_with_web_authn_method_spec.rb +1 -1
  761. data/spec/models/update_organization_onboarding_portal_link_body_spec.rb +1 -1
  762. data/spec/models/update_recovery_flow_body_spec.rb +1 -1
  763. data/spec/models/update_recovery_flow_with_code_method_spec.rb +1 -1
  764. data/spec/models/update_recovery_flow_with_link_method_spec.rb +1 -1
  765. data/spec/models/update_registration_flow_body_spec.rb +1 -1
  766. data/spec/models/update_registration_flow_with_code_method_spec.rb +1 -1
  767. data/spec/models/update_registration_flow_with_oidc_method_spec.rb +1 -1
  768. data/spec/models/update_registration_flow_with_passkey_method_spec.rb +1 -1
  769. data/spec/models/update_registration_flow_with_password_method_spec.rb +1 -1
  770. data/spec/models/update_registration_flow_with_profile_method_spec.rb +1 -1
  771. data/spec/models/update_registration_flow_with_saml_method_spec.rb +1 -1
  772. data/spec/models/update_registration_flow_with_web_authn_method_spec.rb +1 -1
  773. data/spec/models/update_settings_flow_body_spec.rb +1 -1
  774. data/spec/models/update_settings_flow_with_lookup_method_spec.rb +1 -1
  775. data/spec/models/update_settings_flow_with_oidc_method_spec.rb +1 -1
  776. data/spec/models/update_settings_flow_with_passkey_method_spec.rb +1 -1
  777. data/spec/models/update_settings_flow_with_password_method_spec.rb +1 -1
  778. data/spec/models/update_settings_flow_with_profile_method_spec.rb +1 -1
  779. data/spec/models/update_settings_flow_with_saml_method_spec.rb +1 -1
  780. data/spec/models/update_settings_flow_with_totp_method_spec.rb +1 -1
  781. data/spec/models/update_settings_flow_with_web_authn_method_spec.rb +1 -1
  782. data/spec/models/update_subscription_body_spec.rb +1 -1
  783. data/spec/models/update_verification_flow_body_spec.rb +1 -1
  784. data/spec/models/update_verification_flow_with_code_method_spec.rb +1 -1
  785. data/spec/models/update_verification_flow_with_link_method_spec.rb +1 -1
  786. data/spec/models/update_workspace_body_spec.rb +1 -1
  787. data/spec/models/usage_spec.rb +1 -1
  788. data/spec/models/validate_base_url_rewrite_request_spec.rb +48 -0
  789. data/spec/models/validate_base_url_rewrite_response_spec.rb +42 -0
  790. data/spec/models/verifiable_credential_priming_response_spec.rb +1 -1
  791. data/spec/models/verifiable_credential_proof_spec.rb +1 -1
  792. data/spec/models/verifiable_credential_response_spec.rb +1 -1
  793. data/spec/models/verifiable_identity_address_spec.rb +1 -1
  794. data/spec/models/verification_error_code_spec.rb +30 -0
  795. data/spec/models/verification_flow_spec.rb +1 -1
  796. data/spec/models/verification_flow_state_spec.rb +1 -1
  797. data/spec/models/verify_api_key_request_spec.rb +36 -0
  798. data/spec/models/verify_api_key_response_spec.rb +114 -0
  799. data/spec/models/verify_user_code_request_spec.rb +1 -1
  800. data/spec/models/version_spec.rb +1 -1
  801. data/spec/models/warning_spec.rb +1 -1
  802. data/spec/models/workspace_api_key_spec.rb +1 -1
  803. data/spec/models/workspace_organization_spec.rb +1 -1
  804. data/spec/models/workspace_spec.rb +1 -1
  805. data/spec/spec_helper.rb +1 -1
  806. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux-gnu/3.2.0/byebug-13.0.0/gem_make.out +5 -5
  807. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux-gnu/3.2.0/io-console-0.8.2/gem_make.out +5 -5
  808. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux-gnu/3.2.0/io-console-0.8.2/mkmf.log +3 -3
  809. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux-gnu/3.2.0/jaro_winkler-1.5.6/gem_make.out +5 -5
  810. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux-gnu/3.2.0/psych-4.0.6/gem_make.out +5 -5
  811. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux-gnu/3.2.0/racc-1.8.1/gem_make.out +5 -5
  812. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux-gnu/3.2.0/stringio-3.2.0/gem_make.out +5 -5
  813. metadata +155 -3
@@ -0,0 +1,1229 @@
1
+ # OryClient::APIKeysApi
2
+
3
+ All URIs are relative to *https://playground.projects.oryapis.com*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**admin_batch_import_api_keys**](APIKeysApi.md#admin_batch_import_api_keys) | **POST** /v2alpha1/admin/importedApiKeys:batchImport | Batch Import API Keys |
8
+ | [**admin_batch_verify_api_keys**](APIKeysApi.md#admin_batch_verify_api_keys) | **POST** /v2alpha1/admin/apiKeys:batchVerify | Batch Verify API Keys |
9
+ | [**admin_delete_imported_api_key**](APIKeysApi.md#admin_delete_imported_api_key) | **DELETE** /v2alpha1/admin/importedApiKeys/{key_id} | Delete Imported API Key |
10
+ | [**admin_derive_token**](APIKeysApi.md#admin_derive_token) | **POST** /v2alpha1/admin/apiKeys:derive | Derive Token |
11
+ | [**admin_get_imported_api_key**](APIKeysApi.md#admin_get_imported_api_key) | **GET** /v2alpha1/admin/importedApiKeys/{key_id} | Get Imported API Key |
12
+ | [**admin_get_issued_api_key**](APIKeysApi.md#admin_get_issued_api_key) | **GET** /v2alpha1/admin/issuedApiKeys/{key_id} | Get Issued API Key |
13
+ | [**admin_get_jwks**](APIKeysApi.md#admin_get_jwks) | **GET** /v2alpha1/admin/derivedKeys/jwks.json | Get JWKS |
14
+ | [**admin_import_api_key**](APIKeysApi.md#admin_import_api_key) | **POST** /v2alpha1/admin/importedApiKeys | Import API Key |
15
+ | [**admin_issue_api_key**](APIKeysApi.md#admin_issue_api_key) | **POST** /v2alpha1/admin/issuedApiKeys | Issue API Key |
16
+ | [**admin_list_imported_api_keys**](APIKeysApi.md#admin_list_imported_api_keys) | **GET** /v2alpha1/admin/importedApiKeys | List Imported API Keys |
17
+ | [**admin_list_issued_api_keys**](APIKeysApi.md#admin_list_issued_api_keys) | **GET** /v2alpha1/admin/issuedApiKeys | List Issued API Keys |
18
+ | [**admin_revoke_api_key**](APIKeysApi.md#admin_revoke_api_key) | **POST** /v2alpha1/admin/apiKeys/{key_id}:revoke | Revoke API Key |
19
+ | [**admin_rotate_issued_api_key**](APIKeysApi.md#admin_rotate_issued_api_key) | **POST** /v2alpha1/admin/issuedApiKeys/{key_id}:rotate | Rotate Issued API Key |
20
+ | [**admin_update_imported_api_key**](APIKeysApi.md#admin_update_imported_api_key) | **PATCH** /v2alpha1/admin/importedApiKeys/{key_id} | Update Imported API Key |
21
+ | [**admin_update_issued_api_key**](APIKeysApi.md#admin_update_issued_api_key) | **PATCH** /v2alpha1/admin/issuedApiKeys/{key_id} | Update Issued API Key |
22
+ | [**admin_verify_api_key**](APIKeysApi.md#admin_verify_api_key) | **POST** /v2alpha1/admin/apiKeys:verify | Verify API Key |
23
+ | [**revoke_api_key**](APIKeysApi.md#revoke_api_key) | **POST** /v2alpha1/apiKeys:selfRevoke | Revoke API Key (self-service) |
24
+
25
+
26
+ ## admin_batch_import_api_keys
27
+
28
+ > <BatchImportAPIKeysResponse> admin_batch_import_api_keys(batch_import_api_keys_request)
29
+
30
+ Batch Import API Keys
31
+
32
+ Imports up to 1000 external API keys in one request. Returns per-item results. If at least one item succeeds, response is 200 OK. If all items fail, the endpoint returns a non-200 error. ```http POST /v2alpha1/admin/importedApiKeys:batchImport { \"requests\": [ {\"raw_key\": \"sk_live_abc\", \"name\": \"Stripe key\", \"actor_id\": \"user_1\"}, {\"raw_key\": \"ghp_xyz\", \"name\": \"GitHub PAT\", \"actor_id\": \"user_2\"} ] } ```
33
+
34
+ ### Examples
35
+
36
+ ```ruby
37
+ require 'time'
38
+ require 'ory-client'
39
+ # setup authorization
40
+ OryClient.configure do |config|
41
+ # Configure Bearer authorization: oryAccessToken
42
+ config.access_token = 'YOUR_BEARER_TOKEN'
43
+ end
44
+
45
+ api_instance = OryClient::APIKeysApi.new
46
+ batch_import_api_keys_request = OryClient::BatchImportAPIKeysRequest.new # BatchImportAPIKeysRequest | BatchImportAPIKeysRequest imports multiple external API keys in one request. The maximum batch size is 1000 keys.
47
+
48
+ begin
49
+ # Batch Import API Keys
50
+ result = api_instance.admin_batch_import_api_keys(batch_import_api_keys_request)
51
+ p result
52
+ rescue OryClient::ApiError => e
53
+ puts "Error when calling APIKeysApi->admin_batch_import_api_keys: #{e}"
54
+ end
55
+ ```
56
+
57
+ #### Using the admin_batch_import_api_keys_with_http_info variant
58
+
59
+ This returns an Array which contains the response data, status code and headers.
60
+
61
+ > <Array(<BatchImportAPIKeysResponse>, Integer, Hash)> admin_batch_import_api_keys_with_http_info(batch_import_api_keys_request)
62
+
63
+ ```ruby
64
+ begin
65
+ # Batch Import API Keys
66
+ data, status_code, headers = api_instance.admin_batch_import_api_keys_with_http_info(batch_import_api_keys_request)
67
+ p status_code # => 2xx
68
+ p headers # => { ... }
69
+ p data # => <BatchImportAPIKeysResponse>
70
+ rescue OryClient::ApiError => e
71
+ puts "Error when calling APIKeysApi->admin_batch_import_api_keys_with_http_info: #{e}"
72
+ end
73
+ ```
74
+
75
+ ### Parameters
76
+
77
+ | Name | Type | Description | Notes |
78
+ | ---- | ---- | ----------- | ----- |
79
+ | **batch_import_api_keys_request** | [**BatchImportAPIKeysRequest**](BatchImportAPIKeysRequest.md) | BatchImportAPIKeysRequest imports multiple external API keys in one request. The maximum batch size is 1000 keys. | |
80
+
81
+ ### Return type
82
+
83
+ [**BatchImportAPIKeysResponse**](BatchImportAPIKeysResponse.md)
84
+
85
+ ### Authorization
86
+
87
+ [oryAccessToken](../README.md#oryAccessToken)
88
+
89
+ ### HTTP request headers
90
+
91
+ - **Content-Type**: application/json
92
+ - **Accept**: application/json
93
+
94
+
95
+ ## admin_batch_verify_api_keys
96
+
97
+ > <BatchVerifyAPIKeysResponse> admin_batch_verify_api_keys(batch_verify_api_keys_request, opts)
98
+
99
+ Batch Verify API Keys
100
+
101
+ Verifies multiple credentials in a single request. Efficiently verifies up to 100 credentials in parallel. Each credential is verified independently; partial failures are returned. Admin access only. Cache Control (HTTP Headers): - Cache-Control: no-cache - Bypasses cache read, forces fresh DB lookup - Cache-Control: no-store - Bypasses cache read AND write (never cached) - Pragma: no-cache - Same as Cache-Control: no-cache (HTTP/1.0) The cache directive applies to every credential in the batch. ```http POST /v2alpha1/admin/apiKeys:batchVerify { \"requests\": [ {\"credential\": \"sk_live_abc123...\"}, {\"credential\": \"eyJhbGciOiJFZERTQSI...\"} ] } ```
102
+
103
+ ### Examples
104
+
105
+ ```ruby
106
+ require 'time'
107
+ require 'ory-client'
108
+ # setup authorization
109
+ OryClient.configure do |config|
110
+ # Configure Bearer authorization: oryAccessToken
111
+ config.access_token = 'YOUR_BEARER_TOKEN'
112
+ end
113
+
114
+ api_instance = OryClient::APIKeysApi.new
115
+ batch_verify_api_keys_request = OryClient::BatchVerifyAPIKeysRequest.new # BatchVerifyAPIKeysRequest |
116
+ opts = {
117
+ cache_control: 'cache_control_example', # String | Cache-directive controlling the verifier cache. `no-cache` forces a fresh database lookup (cache read is bypassed). `no-store` additionally prevents the result from being written to the cache. Any other value is ignored.
118
+ pragma: 'pragma_example' # String | HTTP/1.0 alias for `Cache-Control: no-cache`. Behaves identically when set to `no-cache`; ignored otherwise.
119
+ }
120
+
121
+ begin
122
+ # Batch Verify API Keys
123
+ result = api_instance.admin_batch_verify_api_keys(batch_verify_api_keys_request, opts)
124
+ p result
125
+ rescue OryClient::ApiError => e
126
+ puts "Error when calling APIKeysApi->admin_batch_verify_api_keys: #{e}"
127
+ end
128
+ ```
129
+
130
+ #### Using the admin_batch_verify_api_keys_with_http_info variant
131
+
132
+ This returns an Array which contains the response data, status code and headers.
133
+
134
+ > <Array(<BatchVerifyAPIKeysResponse>, Integer, Hash)> admin_batch_verify_api_keys_with_http_info(batch_verify_api_keys_request, opts)
135
+
136
+ ```ruby
137
+ begin
138
+ # Batch Verify API Keys
139
+ data, status_code, headers = api_instance.admin_batch_verify_api_keys_with_http_info(batch_verify_api_keys_request, opts)
140
+ p status_code # => 2xx
141
+ p headers # => { ... }
142
+ p data # => <BatchVerifyAPIKeysResponse>
143
+ rescue OryClient::ApiError => e
144
+ puts "Error when calling APIKeysApi->admin_batch_verify_api_keys_with_http_info: #{e}"
145
+ end
146
+ ```
147
+
148
+ ### Parameters
149
+
150
+ | Name | Type | Description | Notes |
151
+ | ---- | ---- | ----------- | ----- |
152
+ | **batch_verify_api_keys_request** | [**BatchVerifyAPIKeysRequest**](BatchVerifyAPIKeysRequest.md) | | |
153
+ | **cache_control** | **String** | Cache-directive controlling the verifier cache. &#x60;no-cache&#x60; forces a fresh database lookup (cache read is bypassed). &#x60;no-store&#x60; additionally prevents the result from being written to the cache. Any other value is ignored. | [optional] |
154
+ | **pragma** | **String** | HTTP/1.0 alias for &#x60;Cache-Control: no-cache&#x60;. Behaves identically when set to &#x60;no-cache&#x60;; ignored otherwise. | [optional] |
155
+
156
+ ### Return type
157
+
158
+ [**BatchVerifyAPIKeysResponse**](BatchVerifyAPIKeysResponse.md)
159
+
160
+ ### Authorization
161
+
162
+ [oryAccessToken](../README.md#oryAccessToken)
163
+
164
+ ### HTTP request headers
165
+
166
+ - **Content-Type**: application/json
167
+ - **Accept**: application/json
168
+
169
+
170
+ ## admin_delete_imported_api_key
171
+
172
+ > Object admin_delete_imported_api_key(key_id)
173
+
174
+ Delete Imported API Key
175
+
176
+ Permanently deletes an imported key (hard delete). The key is removed from the database. Use RevokeAPIKey for soft deletion (recommended). ```http DELETE /v2alpha1/admin/importedApiKeys/{key_id} ```
177
+
178
+ ### Examples
179
+
180
+ ```ruby
181
+ require 'time'
182
+ require 'ory-client'
183
+ # setup authorization
184
+ OryClient.configure do |config|
185
+ # Configure Bearer authorization: oryAccessToken
186
+ config.access_token = 'YOUR_BEARER_TOKEN'
187
+ end
188
+
189
+ api_instance = OryClient::APIKeysApi.new
190
+ key_id = 'key_id_example' # String | SHA512/256 hash of the imported key (REQUIRED)
191
+
192
+ begin
193
+ # Delete Imported API Key
194
+ result = api_instance.admin_delete_imported_api_key(key_id)
195
+ p result
196
+ rescue OryClient::ApiError => e
197
+ puts "Error when calling APIKeysApi->admin_delete_imported_api_key: #{e}"
198
+ end
199
+ ```
200
+
201
+ #### Using the admin_delete_imported_api_key_with_http_info variant
202
+
203
+ This returns an Array which contains the response data, status code and headers.
204
+
205
+ > <Array(Object, Integer, Hash)> admin_delete_imported_api_key_with_http_info(key_id)
206
+
207
+ ```ruby
208
+ begin
209
+ # Delete Imported API Key
210
+ data, status_code, headers = api_instance.admin_delete_imported_api_key_with_http_info(key_id)
211
+ p status_code # => 2xx
212
+ p headers # => { ... }
213
+ p data # => Object
214
+ rescue OryClient::ApiError => e
215
+ puts "Error when calling APIKeysApi->admin_delete_imported_api_key_with_http_info: #{e}"
216
+ end
217
+ ```
218
+
219
+ ### Parameters
220
+
221
+ | Name | Type | Description | Notes |
222
+ | ---- | ---- | ----------- | ----- |
223
+ | **key_id** | **String** | SHA512/256 hash of the imported key (REQUIRED) | |
224
+
225
+ ### Return type
226
+
227
+ **Object**
228
+
229
+ ### Authorization
230
+
231
+ [oryAccessToken](../README.md#oryAccessToken)
232
+
233
+ ### HTTP request headers
234
+
235
+ - **Content-Type**: Not defined
236
+ - **Accept**: application/json
237
+
238
+
239
+ ## admin_derive_token
240
+
241
+ > <DeriveTokenResponse> admin_derive_token(derive_token_request)
242
+
243
+ Derive Token
244
+
245
+ Mints a short-lived JWT or Macaroon token from an API key. Works with both issued and imported keys. The derived token inherits the permissions of the parent API key. ```http POST /v2alpha1/admin/apiKeys:derive { \"credential\": \"eyJhbGciOiJFZERTQSI...\", \"ttl\": \"1h\" } ```
246
+
247
+ ### Examples
248
+
249
+ ```ruby
250
+ require 'time'
251
+ require 'ory-client'
252
+ # setup authorization
253
+ OryClient.configure do |config|
254
+ # Configure Bearer authorization: oryAccessToken
255
+ config.access_token = 'YOUR_BEARER_TOKEN'
256
+ end
257
+
258
+ api_instance = OryClient::APIKeysApi.new
259
+ derive_token_request = OryClient::DeriveTokenRequest.new # DeriveTokenRequest |
260
+
261
+ begin
262
+ # Derive Token
263
+ result = api_instance.admin_derive_token(derive_token_request)
264
+ p result
265
+ rescue OryClient::ApiError => e
266
+ puts "Error when calling APIKeysApi->admin_derive_token: #{e}"
267
+ end
268
+ ```
269
+
270
+ #### Using the admin_derive_token_with_http_info variant
271
+
272
+ This returns an Array which contains the response data, status code and headers.
273
+
274
+ > <Array(<DeriveTokenResponse>, Integer, Hash)> admin_derive_token_with_http_info(derive_token_request)
275
+
276
+ ```ruby
277
+ begin
278
+ # Derive Token
279
+ data, status_code, headers = api_instance.admin_derive_token_with_http_info(derive_token_request)
280
+ p status_code # => 2xx
281
+ p headers # => { ... }
282
+ p data # => <DeriveTokenResponse>
283
+ rescue OryClient::ApiError => e
284
+ puts "Error when calling APIKeysApi->admin_derive_token_with_http_info: #{e}"
285
+ end
286
+ ```
287
+
288
+ ### Parameters
289
+
290
+ | Name | Type | Description | Notes |
291
+ | ---- | ---- | ----------- | ----- |
292
+ | **derive_token_request** | [**DeriveTokenRequest**](DeriveTokenRequest.md) | | |
293
+
294
+ ### Return type
295
+
296
+ [**DeriveTokenResponse**](DeriveTokenResponse.md)
297
+
298
+ ### Authorization
299
+
300
+ [oryAccessToken](../README.md#oryAccessToken)
301
+
302
+ ### HTTP request headers
303
+
304
+ - **Content-Type**: application/json
305
+ - **Accept**: application/json
306
+
307
+
308
+ ## admin_get_imported_api_key
309
+
310
+ > <ImportedAPIKey> admin_get_imported_api_key(key_id)
311
+
312
+ Get Imported API Key
313
+
314
+ Retrieves details about a specific imported key. Returns metadata about the imported key. The original raw key is never returned. ```http GET /v2alpha1/admin/importedApiKeys/{key_id} ```
315
+
316
+ ### Examples
317
+
318
+ ```ruby
319
+ require 'time'
320
+ require 'ory-client'
321
+ # setup authorization
322
+ OryClient.configure do |config|
323
+ # Configure Bearer authorization: oryAccessToken
324
+ config.access_token = 'YOUR_BEARER_TOKEN'
325
+ end
326
+
327
+ api_instance = OryClient::APIKeysApi.new
328
+ key_id = 'key_id_example' # String | SHA512/256 hash of the imported key (REQUIRED)
329
+
330
+ begin
331
+ # Get Imported API Key
332
+ result = api_instance.admin_get_imported_api_key(key_id)
333
+ p result
334
+ rescue OryClient::ApiError => e
335
+ puts "Error when calling APIKeysApi->admin_get_imported_api_key: #{e}"
336
+ end
337
+ ```
338
+
339
+ #### Using the admin_get_imported_api_key_with_http_info variant
340
+
341
+ This returns an Array which contains the response data, status code and headers.
342
+
343
+ > <Array(<ImportedAPIKey>, Integer, Hash)> admin_get_imported_api_key_with_http_info(key_id)
344
+
345
+ ```ruby
346
+ begin
347
+ # Get Imported API Key
348
+ data, status_code, headers = api_instance.admin_get_imported_api_key_with_http_info(key_id)
349
+ p status_code # => 2xx
350
+ p headers # => { ... }
351
+ p data # => <ImportedAPIKey>
352
+ rescue OryClient::ApiError => e
353
+ puts "Error when calling APIKeysApi->admin_get_imported_api_key_with_http_info: #{e}"
354
+ end
355
+ ```
356
+
357
+ ### Parameters
358
+
359
+ | Name | Type | Description | Notes |
360
+ | ---- | ---- | ----------- | ----- |
361
+ | **key_id** | **String** | SHA512/256 hash of the imported key (REQUIRED) | |
362
+
363
+ ### Return type
364
+
365
+ [**ImportedAPIKey**](ImportedAPIKey.md)
366
+
367
+ ### Authorization
368
+
369
+ [oryAccessToken](../README.md#oryAccessToken)
370
+
371
+ ### HTTP request headers
372
+
373
+ - **Content-Type**: Not defined
374
+ - **Accept**: application/json
375
+
376
+
377
+ ## admin_get_issued_api_key
378
+
379
+ > <IssuedAPIKey> admin_get_issued_api_key(key_id)
380
+
381
+ Get Issued API Key
382
+
383
+ Retrieves details about a specific issued API key including its status, scopes, expiration, and usage statistics. The secret is never returned. ```http GET /v2alpha1/admin/issuedApiKeys/01HQZX9VYQKJB8XQZQXQZQXQXQ ```
384
+
385
+ ### Examples
386
+
387
+ ```ruby
388
+ require 'time'
389
+ require 'ory-client'
390
+ # setup authorization
391
+ OryClient.configure do |config|
392
+ # Configure Bearer authorization: oryAccessToken
393
+ config.access_token = 'YOUR_BEARER_TOKEN'
394
+ end
395
+
396
+ api_instance = OryClient::APIKeysApi.new
397
+ key_id = 'key_id_example' # String | Identifier of the API key resource.
398
+
399
+ begin
400
+ # Get Issued API Key
401
+ result = api_instance.admin_get_issued_api_key(key_id)
402
+ p result
403
+ rescue OryClient::ApiError => e
404
+ puts "Error when calling APIKeysApi->admin_get_issued_api_key: #{e}"
405
+ end
406
+ ```
407
+
408
+ #### Using the admin_get_issued_api_key_with_http_info variant
409
+
410
+ This returns an Array which contains the response data, status code and headers.
411
+
412
+ > <Array(<IssuedAPIKey>, Integer, Hash)> admin_get_issued_api_key_with_http_info(key_id)
413
+
414
+ ```ruby
415
+ begin
416
+ # Get Issued API Key
417
+ data, status_code, headers = api_instance.admin_get_issued_api_key_with_http_info(key_id)
418
+ p status_code # => 2xx
419
+ p headers # => { ... }
420
+ p data # => <IssuedAPIKey>
421
+ rescue OryClient::ApiError => e
422
+ puts "Error when calling APIKeysApi->admin_get_issued_api_key_with_http_info: #{e}"
423
+ end
424
+ ```
425
+
426
+ ### Parameters
427
+
428
+ | Name | Type | Description | Notes |
429
+ | ---- | ---- | ----------- | ----- |
430
+ | **key_id** | **String** | Identifier of the API key resource. | |
431
+
432
+ ### Return type
433
+
434
+ [**IssuedAPIKey**](IssuedAPIKey.md)
435
+
436
+ ### Authorization
437
+
438
+ [oryAccessToken](../README.md#oryAccessToken)
439
+
440
+ ### HTTP request headers
441
+
442
+ - **Content-Type**: Not defined
443
+ - **Accept**: application/json
444
+
445
+
446
+ ## admin_get_jwks
447
+
448
+ > <GetJWKSResponse> admin_get_jwks
449
+
450
+ Get JWKS
451
+
452
+ Returns the JSON Web Key Set for token verification. Provides the public keys needed to verify JWT tokens issued by this service. Keys are loaded from configuration (file://, https://, or base64:// URIs). Follows the JWKS standard (RFC 7517). ```http GET /v2alpha1/admin/derivedKeys/jwks.json ```
453
+
454
+ ### Examples
455
+
456
+ ```ruby
457
+ require 'time'
458
+ require 'ory-client'
459
+ # setup authorization
460
+ OryClient.configure do |config|
461
+ # Configure Bearer authorization: oryAccessToken
462
+ config.access_token = 'YOUR_BEARER_TOKEN'
463
+ end
464
+
465
+ api_instance = OryClient::APIKeysApi.new
466
+
467
+ begin
468
+ # Get JWKS
469
+ result = api_instance.admin_get_jwks
470
+ p result
471
+ rescue OryClient::ApiError => e
472
+ puts "Error when calling APIKeysApi->admin_get_jwks: #{e}"
473
+ end
474
+ ```
475
+
476
+ #### Using the admin_get_jwks_with_http_info variant
477
+
478
+ This returns an Array which contains the response data, status code and headers.
479
+
480
+ > <Array(<GetJWKSResponse>, Integer, Hash)> admin_get_jwks_with_http_info
481
+
482
+ ```ruby
483
+ begin
484
+ # Get JWKS
485
+ data, status_code, headers = api_instance.admin_get_jwks_with_http_info
486
+ p status_code # => 2xx
487
+ p headers # => { ... }
488
+ p data # => <GetJWKSResponse>
489
+ rescue OryClient::ApiError => e
490
+ puts "Error when calling APIKeysApi->admin_get_jwks_with_http_info: #{e}"
491
+ end
492
+ ```
493
+
494
+ ### Parameters
495
+
496
+ This endpoint does not need any parameter.
497
+
498
+ ### Return type
499
+
500
+ [**GetJWKSResponse**](GetJWKSResponse.md)
501
+
502
+ ### Authorization
503
+
504
+ [oryAccessToken](../README.md#oryAccessToken)
505
+
506
+ ### HTTP request headers
507
+
508
+ - **Content-Type**: Not defined
509
+ - **Accept**: application/json
510
+
511
+
512
+ ## admin_import_api_key
513
+
514
+ > <ImportedAPIKey> admin_import_api_key(import_api_key_request)
515
+
516
+ Import API Key
517
+
518
+ Imports an external API key into the system. Allows importing keys from legacy systems or external providers. The raw key is hashed and stored securely (HMAC). Imported keys support token derivation (JWT/Macaroon) like issued keys. ```http POST /v2alpha1/admin/importedApiKeys { \"raw_key\": \"sk_live_abc123xyz\", \"name\": \"Imported Stripe Key\", \"actor_id\": \"user_123\" } ```
519
+
520
+ ### Examples
521
+
522
+ ```ruby
523
+ require 'time'
524
+ require 'ory-client'
525
+ # setup authorization
526
+ OryClient.configure do |config|
527
+ # Configure Bearer authorization: oryAccessToken
528
+ config.access_token = 'YOUR_BEARER_TOKEN'
529
+ end
530
+
531
+ api_instance = OryClient::APIKeysApi.new
532
+ import_api_key_request = OryClient::ImportAPIKeyRequest.new # ImportAPIKeyRequest | Example: { \"raw_key\": \"sk_live_abc123xyz789\", \"name\": \"Stripe Production Key\", \"actor_id\": \"payment-processor\", \"scopes\": [\"read\", \"write\"], \"ttl\": \"8760h\", // 1 year (also accepts: 31536000s) \"metadata\": {\"source\": \"stripe\", \"environment\": \"production\"} }
533
+
534
+ begin
535
+ # Import API Key
536
+ result = api_instance.admin_import_api_key(import_api_key_request)
537
+ p result
538
+ rescue OryClient::ApiError => e
539
+ puts "Error when calling APIKeysApi->admin_import_api_key: #{e}"
540
+ end
541
+ ```
542
+
543
+ #### Using the admin_import_api_key_with_http_info variant
544
+
545
+ This returns an Array which contains the response data, status code and headers.
546
+
547
+ > <Array(<ImportedAPIKey>, Integer, Hash)> admin_import_api_key_with_http_info(import_api_key_request)
548
+
549
+ ```ruby
550
+ begin
551
+ # Import API Key
552
+ data, status_code, headers = api_instance.admin_import_api_key_with_http_info(import_api_key_request)
553
+ p status_code # => 2xx
554
+ p headers # => { ... }
555
+ p data # => <ImportedAPIKey>
556
+ rescue OryClient::ApiError => e
557
+ puts "Error when calling APIKeysApi->admin_import_api_key_with_http_info: #{e}"
558
+ end
559
+ ```
560
+
561
+ ### Parameters
562
+
563
+ | Name | Type | Description | Notes |
564
+ | ---- | ---- | ----------- | ----- |
565
+ | **import_api_key_request** | [**ImportAPIKeyRequest**](ImportAPIKeyRequest.md) | Example: { \&quot;raw_key\&quot;: \&quot;sk_live_abc123xyz789\&quot;, \&quot;name\&quot;: \&quot;Stripe Production Key\&quot;, \&quot;actor_id\&quot;: \&quot;payment-processor\&quot;, \&quot;scopes\&quot;: [\&quot;read\&quot;, \&quot;write\&quot;], \&quot;ttl\&quot;: \&quot;8760h\&quot;, // 1 year (also accepts: 31536000s) \&quot;metadata\&quot;: {\&quot;source\&quot;: \&quot;stripe\&quot;, \&quot;environment\&quot;: \&quot;production\&quot;} } | |
566
+
567
+ ### Return type
568
+
569
+ [**ImportedAPIKey**](ImportedAPIKey.md)
570
+
571
+ ### Authorization
572
+
573
+ [oryAccessToken](../README.md#oryAccessToken)
574
+
575
+ ### HTTP request headers
576
+
577
+ - **Content-Type**: application/json
578
+ - **Accept**: application/json
579
+
580
+
581
+ ## admin_issue_api_key
582
+
583
+ > <IssueAPIKeyResponse> admin_issue_api_key(issue_api_key_request)
584
+
585
+ Issue API Key
586
+
587
+ Creates a new API key for a given actor. The secret is returned only once in the response and cannot be retrieved later. Keys can be scoped with specific permissions and have optional expiration. ```http POST /v2alpha1/admin/issuedApiKeys { \"name\": \"production-service\", \"actor_id\": \"user_123\", \"scopes\": [\"read\", \"write\"], \"ttl\": \"8760h\" } ```
588
+
589
+ ### Examples
590
+
591
+ ```ruby
592
+ require 'time'
593
+ require 'ory-client'
594
+ # setup authorization
595
+ OryClient.configure do |config|
596
+ # Configure Bearer authorization: oryAccessToken
597
+ config.access_token = 'YOUR_BEARER_TOKEN'
598
+ end
599
+
600
+ api_instance = OryClient::APIKeysApi.new
601
+ issue_api_key_request = OryClient::IssueAPIKeyRequest.new # IssueAPIKeyRequest |
602
+
603
+ begin
604
+ # Issue API Key
605
+ result = api_instance.admin_issue_api_key(issue_api_key_request)
606
+ p result
607
+ rescue OryClient::ApiError => e
608
+ puts "Error when calling APIKeysApi->admin_issue_api_key: #{e}"
609
+ end
610
+ ```
611
+
612
+ #### Using the admin_issue_api_key_with_http_info variant
613
+
614
+ This returns an Array which contains the response data, status code and headers.
615
+
616
+ > <Array(<IssueAPIKeyResponse>, Integer, Hash)> admin_issue_api_key_with_http_info(issue_api_key_request)
617
+
618
+ ```ruby
619
+ begin
620
+ # Issue API Key
621
+ data, status_code, headers = api_instance.admin_issue_api_key_with_http_info(issue_api_key_request)
622
+ p status_code # => 2xx
623
+ p headers # => { ... }
624
+ p data # => <IssueAPIKeyResponse>
625
+ rescue OryClient::ApiError => e
626
+ puts "Error when calling APIKeysApi->admin_issue_api_key_with_http_info: #{e}"
627
+ end
628
+ ```
629
+
630
+ ### Parameters
631
+
632
+ | Name | Type | Description | Notes |
633
+ | ---- | ---- | ----------- | ----- |
634
+ | **issue_api_key_request** | [**IssueAPIKeyRequest**](IssueAPIKeyRequest.md) | | |
635
+
636
+ ### Return type
637
+
638
+ [**IssueAPIKeyResponse**](IssueAPIKeyResponse.md)
639
+
640
+ ### Authorization
641
+
642
+ [oryAccessToken](../README.md#oryAccessToken)
643
+
644
+ ### HTTP request headers
645
+
646
+ - **Content-Type**: application/json
647
+ - **Accept**: application/json
648
+
649
+
650
+ ## admin_list_imported_api_keys
651
+
652
+ > <ListImportedAPIKeysResponse> admin_list_imported_api_keys(opts)
653
+
654
+ List Imported API Keys
655
+
656
+ Lists all imported keys with filtering. Returns imported keys only (not issued keys). Supports pagination and AIP-160 filter expressions. ```http GET /v2alpha1/admin/importedApiKeys?page_size=50&filter=status%3DKEY_STATUS_ACTIVE ```
657
+
658
+ ### Examples
659
+
660
+ ```ruby
661
+ require 'time'
662
+ require 'ory-client'
663
+ # setup authorization
664
+ OryClient.configure do |config|
665
+ # Configure Bearer authorization: oryAccessToken
666
+ config.access_token = 'YOUR_BEARER_TOKEN'
667
+ end
668
+
669
+ api_instance = OryClient::APIKeysApi.new
670
+ opts = {
671
+ page_size: 56, # Integer | Number of items per page (default: 50, max: 1000)
672
+ page_token: 'page_token_example', # String | Cursor token for pagination (OPTIONAL)
673
+ filter: 'filter_example' # String | filter is an AIP-160 expression. Indexed fields (efficient at any scale): actor_id, status. Other fields are not indexed and may be rejected. Examples: actor_id=\"user_123\" status=KEY_STATUS_ACTIVE actor_id=\"user_123\" AND status=KEY_STATUS_ACTIVE
674
+ }
675
+
676
+ begin
677
+ # List Imported API Keys
678
+ result = api_instance.admin_list_imported_api_keys(opts)
679
+ p result
680
+ rescue OryClient::ApiError => e
681
+ puts "Error when calling APIKeysApi->admin_list_imported_api_keys: #{e}"
682
+ end
683
+ ```
684
+
685
+ #### Using the admin_list_imported_api_keys_with_http_info variant
686
+
687
+ This returns an Array which contains the response data, status code and headers.
688
+
689
+ > <Array(<ListImportedAPIKeysResponse>, Integer, Hash)> admin_list_imported_api_keys_with_http_info(opts)
690
+
691
+ ```ruby
692
+ begin
693
+ # List Imported API Keys
694
+ data, status_code, headers = api_instance.admin_list_imported_api_keys_with_http_info(opts)
695
+ p status_code # => 2xx
696
+ p headers # => { ... }
697
+ p data # => <ListImportedAPIKeysResponse>
698
+ rescue OryClient::ApiError => e
699
+ puts "Error when calling APIKeysApi->admin_list_imported_api_keys_with_http_info: #{e}"
700
+ end
701
+ ```
702
+
703
+ ### Parameters
704
+
705
+ | Name | Type | Description | Notes |
706
+ | ---- | ---- | ----------- | ----- |
707
+ | **page_size** | **Integer** | Number of items per page (default: 50, max: 1000) | [optional] |
708
+ | **page_token** | **String** | Cursor token for pagination (OPTIONAL) | [optional] |
709
+ | **filter** | **String** | filter is an AIP-160 expression. Indexed fields (efficient at any scale): actor_id, status. Other fields are not indexed and may be rejected. Examples: actor_id&#x3D;\&quot;user_123\&quot; status&#x3D;KEY_STATUS_ACTIVE actor_id&#x3D;\&quot;user_123\&quot; AND status&#x3D;KEY_STATUS_ACTIVE | [optional] |
710
+
711
+ ### Return type
712
+
713
+ [**ListImportedAPIKeysResponse**](ListImportedAPIKeysResponse.md)
714
+
715
+ ### Authorization
716
+
717
+ [oryAccessToken](../README.md#oryAccessToken)
718
+
719
+ ### HTTP request headers
720
+
721
+ - **Content-Type**: Not defined
722
+ - **Accept**: application/json
723
+
724
+
725
+ ## admin_list_issued_api_keys
726
+
727
+ > <ListIssuedAPIKeysResponse> admin_list_issued_api_keys(opts)
728
+
729
+ List Issued API Keys
730
+
731
+ Lists issued API keys with optional filtering. Supports cursor-based pagination and AIP-160 filter expressions. Returns only issued (generated) API keys; use ListImportedAPIKeys for imported keys. ```http GET /v2alpha1/admin/issuedApiKeys?page_size=50&filter=actor_id%3D%22user_123%22 ```
732
+
733
+ ### Examples
734
+
735
+ ```ruby
736
+ require 'time'
737
+ require 'ory-client'
738
+ # setup authorization
739
+ OryClient.configure do |config|
740
+ # Configure Bearer authorization: oryAccessToken
741
+ config.access_token = 'YOUR_BEARER_TOKEN'
742
+ end
743
+
744
+ api_instance = OryClient::APIKeysApi.new
745
+ opts = {
746
+ page_size: 56, # Integer | Number of items per page (default: 50, max: 1000)
747
+ page_token: 'page_token_example', # String | Cursor token for pagination
748
+ filter: 'filter_example' # String | filter is an AIP-160 expression. Indexed fields (efficient at any scale): actor_id, status. Other fields are not indexed and may be rejected. Examples: actor_id=\"user_123\" status=KEY_STATUS_ACTIVE actor_id=\"user_123\" AND status=KEY_STATUS_ACTIVE
749
+ }
750
+
751
+ begin
752
+ # List Issued API Keys
753
+ result = api_instance.admin_list_issued_api_keys(opts)
754
+ p result
755
+ rescue OryClient::ApiError => e
756
+ puts "Error when calling APIKeysApi->admin_list_issued_api_keys: #{e}"
757
+ end
758
+ ```
759
+
760
+ #### Using the admin_list_issued_api_keys_with_http_info variant
761
+
762
+ This returns an Array which contains the response data, status code and headers.
763
+
764
+ > <Array(<ListIssuedAPIKeysResponse>, Integer, Hash)> admin_list_issued_api_keys_with_http_info(opts)
765
+
766
+ ```ruby
767
+ begin
768
+ # List Issued API Keys
769
+ data, status_code, headers = api_instance.admin_list_issued_api_keys_with_http_info(opts)
770
+ p status_code # => 2xx
771
+ p headers # => { ... }
772
+ p data # => <ListIssuedAPIKeysResponse>
773
+ rescue OryClient::ApiError => e
774
+ puts "Error when calling APIKeysApi->admin_list_issued_api_keys_with_http_info: #{e}"
775
+ end
776
+ ```
777
+
778
+ ### Parameters
779
+
780
+ | Name | Type | Description | Notes |
781
+ | ---- | ---- | ----------- | ----- |
782
+ | **page_size** | **Integer** | Number of items per page (default: 50, max: 1000) | [optional] |
783
+ | **page_token** | **String** | Cursor token for pagination | [optional] |
784
+ | **filter** | **String** | filter is an AIP-160 expression. Indexed fields (efficient at any scale): actor_id, status. Other fields are not indexed and may be rejected. Examples: actor_id&#x3D;\&quot;user_123\&quot; status&#x3D;KEY_STATUS_ACTIVE actor_id&#x3D;\&quot;user_123\&quot; AND status&#x3D;KEY_STATUS_ACTIVE | [optional] |
785
+
786
+ ### Return type
787
+
788
+ [**ListIssuedAPIKeysResponse**](ListIssuedAPIKeysResponse.md)
789
+
790
+ ### Authorization
791
+
792
+ [oryAccessToken](../README.md#oryAccessToken)
793
+
794
+ ### HTTP request headers
795
+
796
+ - **Content-Type**: Not defined
797
+ - **Accept**: application/json
798
+
799
+
800
+ ## admin_revoke_api_key
801
+
802
+ > Object admin_revoke_api_key(key_id, admin_revoke_api_key_body)
803
+
804
+ Revoke API Key
805
+
806
+ Immediately revokes an API key (issued or imported). Once revoked, the key can no longer be used for authentication. This operation is irreversible. Revoked keys are retained for audit purposes. ```http POST /v2alpha1/admin/apiKeys/01HQZX9VYQKJB8XQZQXQZQXQXQ:revoke { \"reason\": \"REVOCATION_REASON_KEY_COMPROMISE\" } ```
807
+
808
+ ### Examples
809
+
810
+ ```ruby
811
+ require 'time'
812
+ require 'ory-client'
813
+ # setup authorization
814
+ OryClient.configure do |config|
815
+ # Configure Bearer authorization: oryAccessToken
816
+ config.access_token = 'YOUR_BEARER_TOKEN'
817
+ end
818
+
819
+ api_instance = OryClient::APIKeysApi.new
820
+ key_id = 'key_id_example' # String | Identifier of the API key resource.
821
+ admin_revoke_api_key_body = OryClient::AdminRevokeAPIKeyBody.new # AdminRevokeAPIKeyBody |
822
+
823
+ begin
824
+ # Revoke API Key
825
+ result = api_instance.admin_revoke_api_key(key_id, admin_revoke_api_key_body)
826
+ p result
827
+ rescue OryClient::ApiError => e
828
+ puts "Error when calling APIKeysApi->admin_revoke_api_key: #{e}"
829
+ end
830
+ ```
831
+
832
+ #### Using the admin_revoke_api_key_with_http_info variant
833
+
834
+ This returns an Array which contains the response data, status code and headers.
835
+
836
+ > <Array(Object, Integer, Hash)> admin_revoke_api_key_with_http_info(key_id, admin_revoke_api_key_body)
837
+
838
+ ```ruby
839
+ begin
840
+ # Revoke API Key
841
+ data, status_code, headers = api_instance.admin_revoke_api_key_with_http_info(key_id, admin_revoke_api_key_body)
842
+ p status_code # => 2xx
843
+ p headers # => { ... }
844
+ p data # => Object
845
+ rescue OryClient::ApiError => e
846
+ puts "Error when calling APIKeysApi->admin_revoke_api_key_with_http_info: #{e}"
847
+ end
848
+ ```
849
+
850
+ ### Parameters
851
+
852
+ | Name | Type | Description | Notes |
853
+ | ---- | ---- | ----------- | ----- |
854
+ | **key_id** | **String** | Identifier of the API key resource. | |
855
+ | **admin_revoke_api_key_body** | [**AdminRevokeAPIKeyBody**](AdminRevokeAPIKeyBody.md) | | |
856
+
857
+ ### Return type
858
+
859
+ **Object**
860
+
861
+ ### Authorization
862
+
863
+ [oryAccessToken](../README.md#oryAccessToken)
864
+
865
+ ### HTTP request headers
866
+
867
+ - **Content-Type**: application/json
868
+ - **Accept**: application/json
869
+
870
+
871
+ ## admin_rotate_issued_api_key
872
+
873
+ > <RotateIssuedAPIKeyResponse> admin_rotate_issued_api_key(key_id, admin_rotate_issued_api_key_body)
874
+
875
+ Rotate Issued API Key
876
+
877
+ Generates a new secret for an issued API key. Creates a new API key with a new key_id and secret, and immediately revokes the old key. This is the recommended way to update scopes, metadata, or rotate credentials. For zero-downtime rotation, use this workflow instead: 1. IssueAPIKey with new credentials 2. Deploy new secret to all services 3. Verify new secret works everywhere 4. RevokeAPIKey to remove the old key ```http POST /v2alpha1/admin/issuedApiKeys/01HQZX9VYQKJB8XQZQXQZQXQXQ:rotate { \"scopes\": [\"read\"] } ```
878
+
879
+ ### Examples
880
+
881
+ ```ruby
882
+ require 'time'
883
+ require 'ory-client'
884
+ # setup authorization
885
+ OryClient.configure do |config|
886
+ # Configure Bearer authorization: oryAccessToken
887
+ config.access_token = 'YOUR_BEARER_TOKEN'
888
+ end
889
+
890
+ api_instance = OryClient::APIKeysApi.new
891
+ key_id = 'key_id_example' # String | key_id is the ID of the existing API key to rotate
892
+ admin_rotate_issued_api_key_body = OryClient::AdminRotateIssuedAPIKeyBody.new # AdminRotateIssuedAPIKeyBody |
893
+
894
+ begin
895
+ # Rotate Issued API Key
896
+ result = api_instance.admin_rotate_issued_api_key(key_id, admin_rotate_issued_api_key_body)
897
+ p result
898
+ rescue OryClient::ApiError => e
899
+ puts "Error when calling APIKeysApi->admin_rotate_issued_api_key: #{e}"
900
+ end
901
+ ```
902
+
903
+ #### Using the admin_rotate_issued_api_key_with_http_info variant
904
+
905
+ This returns an Array which contains the response data, status code and headers.
906
+
907
+ > <Array(<RotateIssuedAPIKeyResponse>, Integer, Hash)> admin_rotate_issued_api_key_with_http_info(key_id, admin_rotate_issued_api_key_body)
908
+
909
+ ```ruby
910
+ begin
911
+ # Rotate Issued API Key
912
+ data, status_code, headers = api_instance.admin_rotate_issued_api_key_with_http_info(key_id, admin_rotate_issued_api_key_body)
913
+ p status_code # => 2xx
914
+ p headers # => { ... }
915
+ p data # => <RotateIssuedAPIKeyResponse>
916
+ rescue OryClient::ApiError => e
917
+ puts "Error when calling APIKeysApi->admin_rotate_issued_api_key_with_http_info: #{e}"
918
+ end
919
+ ```
920
+
921
+ ### Parameters
922
+
923
+ | Name | Type | Description | Notes |
924
+ | ---- | ---- | ----------- | ----- |
925
+ | **key_id** | **String** | key_id is the ID of the existing API key to rotate | |
926
+ | **admin_rotate_issued_api_key_body** | [**AdminRotateIssuedAPIKeyBody**](AdminRotateIssuedAPIKeyBody.md) | | |
927
+
928
+ ### Return type
929
+
930
+ [**RotateIssuedAPIKeyResponse**](RotateIssuedAPIKeyResponse.md)
931
+
932
+ ### Authorization
933
+
934
+ [oryAccessToken](../README.md#oryAccessToken)
935
+
936
+ ### HTTP request headers
937
+
938
+ - **Content-Type**: application/json
939
+ - **Accept**: application/json
940
+
941
+
942
+ ## admin_update_imported_api_key
943
+
944
+ > <ImportedAPIKey> admin_update_imported_api_key(key_id, admin_update_imported_api_key_request, opts)
945
+
946
+ Update Imported API Key
947
+
948
+ Updates metadata, scopes, or rate limits of an imported key. Supports partial updates via the update_mask query parameter (AIP-134). Omitting update_mask is equivalent to a mask of every populated field in the body. To clear a field to its zero value, list it explicitly in update_mask and leave it unset (or empty) in the body. ```http PATCH /v2alpha1/admin/importedApiKeys/{key_id}?update_mask=name { \"imported_api_key\": { \"key_id\": \"{key_id}\", \"name\": \"New name\" } } ```
949
+
950
+ ### Examples
951
+
952
+ ```ruby
953
+ require 'time'
954
+ require 'ory-client'
955
+ # setup authorization
956
+ OryClient.configure do |config|
957
+ # Configure Bearer authorization: oryAccessToken
958
+ config.access_token = 'YOUR_BEARER_TOKEN'
959
+ end
960
+
961
+ api_instance = OryClient::APIKeysApi.new
962
+ key_id = 'key_id_example' # String | SHA-512/256 hash of credential
963
+ admin_update_imported_api_key_request = OryClient::AdminUpdateImportedAPIKeyRequest.new # AdminUpdateImportedAPIKeyRequest |
964
+ opts = {
965
+ update_mask: 'update_mask_example' # String | The list of fields to update. See AIP-134.
966
+ }
967
+
968
+ begin
969
+ # Update Imported API Key
970
+ result = api_instance.admin_update_imported_api_key(key_id, admin_update_imported_api_key_request, opts)
971
+ p result
972
+ rescue OryClient::ApiError => e
973
+ puts "Error when calling APIKeysApi->admin_update_imported_api_key: #{e}"
974
+ end
975
+ ```
976
+
977
+ #### Using the admin_update_imported_api_key_with_http_info variant
978
+
979
+ This returns an Array which contains the response data, status code and headers.
980
+
981
+ > <Array(<ImportedAPIKey>, Integer, Hash)> admin_update_imported_api_key_with_http_info(key_id, admin_update_imported_api_key_request, opts)
982
+
983
+ ```ruby
984
+ begin
985
+ # Update Imported API Key
986
+ data, status_code, headers = api_instance.admin_update_imported_api_key_with_http_info(key_id, admin_update_imported_api_key_request, opts)
987
+ p status_code # => 2xx
988
+ p headers # => { ... }
989
+ p data # => <ImportedAPIKey>
990
+ rescue OryClient::ApiError => e
991
+ puts "Error when calling APIKeysApi->admin_update_imported_api_key_with_http_info: #{e}"
992
+ end
993
+ ```
994
+
995
+ ### Parameters
996
+
997
+ | Name | Type | Description | Notes |
998
+ | ---- | ---- | ----------- | ----- |
999
+ | **key_id** | **String** | SHA-512/256 hash of credential | |
1000
+ | **admin_update_imported_api_key_request** | [**AdminUpdateImportedAPIKeyRequest**](AdminUpdateImportedAPIKeyRequest.md) | | |
1001
+ | **update_mask** | **String** | The list of fields to update. See AIP-134. | [optional] |
1002
+
1003
+ ### Return type
1004
+
1005
+ [**ImportedAPIKey**](ImportedAPIKey.md)
1006
+
1007
+ ### Authorization
1008
+
1009
+ [oryAccessToken](../README.md#oryAccessToken)
1010
+
1011
+ ### HTTP request headers
1012
+
1013
+ - **Content-Type**: application/json
1014
+ - **Accept**: application/json
1015
+
1016
+
1017
+ ## admin_update_issued_api_key
1018
+
1019
+ > <IssuedAPIKey> admin_update_issued_api_key(key_id, admin_update_issued_api_key_request, opts)
1020
+
1021
+ Update Issued API Key
1022
+
1023
+ Updates metadata, scopes, or rate limits of an issued key without rotating the secret. Use RotateIssuedAPIKey to change the secret. Follows AIP-134: the request body is the IssuedAPIKey resource itself, and the update_mask query parameter names the subset of fields to apply. Omitting update_mask is equivalent to a mask of every populated field in the body. To clear a field to its zero value, list it explicitly in update_mask and leave it unset (or empty) in the body. ```http PATCH /v2alpha1/admin/issuedApiKeys/01HQZX9VYQKJB8XQZQXQZQXQXQ?update_mask=scopes { \"issued_api_key\": { \"key_id\": \"01HQZX9VYQKJB8XQZQXQZQXQXQ\", \"scopes\": [\"read\"] } } ```
1024
+
1025
+ ### Examples
1026
+
1027
+ ```ruby
1028
+ require 'time'
1029
+ require 'ory-client'
1030
+ # setup authorization
1031
+ OryClient.configure do |config|
1032
+ # Configure Bearer authorization: oryAccessToken
1033
+ config.access_token = 'YOUR_BEARER_TOKEN'
1034
+ end
1035
+
1036
+ api_instance = OryClient::APIKeysApi.new
1037
+ key_id = 'key_id_example' # String | Identifier of the API key resource.
1038
+ admin_update_issued_api_key_request = OryClient::AdminUpdateIssuedAPIKeyRequest.new # AdminUpdateIssuedAPIKeyRequest |
1039
+ opts = {
1040
+ update_mask: 'update_mask_example' # String | The list of fields to update. See AIP-134.
1041
+ }
1042
+
1043
+ begin
1044
+ # Update Issued API Key
1045
+ result = api_instance.admin_update_issued_api_key(key_id, admin_update_issued_api_key_request, opts)
1046
+ p result
1047
+ rescue OryClient::ApiError => e
1048
+ puts "Error when calling APIKeysApi->admin_update_issued_api_key: #{e}"
1049
+ end
1050
+ ```
1051
+
1052
+ #### Using the admin_update_issued_api_key_with_http_info variant
1053
+
1054
+ This returns an Array which contains the response data, status code and headers.
1055
+
1056
+ > <Array(<IssuedAPIKey>, Integer, Hash)> admin_update_issued_api_key_with_http_info(key_id, admin_update_issued_api_key_request, opts)
1057
+
1058
+ ```ruby
1059
+ begin
1060
+ # Update Issued API Key
1061
+ data, status_code, headers = api_instance.admin_update_issued_api_key_with_http_info(key_id, admin_update_issued_api_key_request, opts)
1062
+ p status_code # => 2xx
1063
+ p headers # => { ... }
1064
+ p data # => <IssuedAPIKey>
1065
+ rescue OryClient::ApiError => e
1066
+ puts "Error when calling APIKeysApi->admin_update_issued_api_key_with_http_info: #{e}"
1067
+ end
1068
+ ```
1069
+
1070
+ ### Parameters
1071
+
1072
+ | Name | Type | Description | Notes |
1073
+ | ---- | ---- | ----------- | ----- |
1074
+ | **key_id** | **String** | Identifier of the API key resource. | |
1075
+ | **admin_update_issued_api_key_request** | [**AdminUpdateIssuedAPIKeyRequest**](AdminUpdateIssuedAPIKeyRequest.md) | | |
1076
+ | **update_mask** | **String** | The list of fields to update. See AIP-134. | [optional] |
1077
+
1078
+ ### Return type
1079
+
1080
+ [**IssuedAPIKey**](IssuedAPIKey.md)
1081
+
1082
+ ### Authorization
1083
+
1084
+ [oryAccessToken](../README.md#oryAccessToken)
1085
+
1086
+ ### HTTP request headers
1087
+
1088
+ - **Content-Type**: application/json
1089
+ - **Accept**: application/json
1090
+
1091
+
1092
+ ## admin_verify_api_key
1093
+
1094
+ > <VerifyAPIKeyResponse> admin_verify_api_key(verify_api_key_request, opts)
1095
+
1096
+ Verify API Key
1097
+
1098
+ Verifies a single API key or derived token. Validates the credential's signature, expiration, and revocation status. Works with any credential type (issued keys, imported keys, JWT, macaroon). The verification result includes decoded claims and metadata — admin access only. Cache Control (HTTP Headers): - Cache-Control: no-cache - Bypasses cache read, forces fresh DB lookup - Cache-Control: no-store - Bypasses cache read AND write (never cached) - Pragma: no-cache - Same as Cache-Control: no-cache (HTTP/1.0) ```http POST /v2alpha1/admin/apiKeys:verify { \"credential\": \"sk_live_abc123...\" } ```
1099
+
1100
+ ### Examples
1101
+
1102
+ ```ruby
1103
+ require 'time'
1104
+ require 'ory-client'
1105
+ # setup authorization
1106
+ OryClient.configure do |config|
1107
+ # Configure Bearer authorization: oryAccessToken
1108
+ config.access_token = 'YOUR_BEARER_TOKEN'
1109
+ end
1110
+
1111
+ api_instance = OryClient::APIKeysApi.new
1112
+ verify_api_key_request = OryClient::VerifyAPIKeyRequest.new # VerifyAPIKeyRequest |
1113
+ opts = {
1114
+ cache_control: 'cache_control_example', # String | Cache-directive controlling the verifier cache. `no-cache` forces a fresh database lookup (cache read is bypassed). `no-store` additionally prevents the result from being written to the cache. Any other value is ignored.
1115
+ pragma: 'pragma_example' # String | HTTP/1.0 alias for `Cache-Control: no-cache`. Behaves identically when set to `no-cache`; ignored otherwise.
1116
+ }
1117
+
1118
+ begin
1119
+ # Verify API Key
1120
+ result = api_instance.admin_verify_api_key(verify_api_key_request, opts)
1121
+ p result
1122
+ rescue OryClient::ApiError => e
1123
+ puts "Error when calling APIKeysApi->admin_verify_api_key: #{e}"
1124
+ end
1125
+ ```
1126
+
1127
+ #### Using the admin_verify_api_key_with_http_info variant
1128
+
1129
+ This returns an Array which contains the response data, status code and headers.
1130
+
1131
+ > <Array(<VerifyAPIKeyResponse>, Integer, Hash)> admin_verify_api_key_with_http_info(verify_api_key_request, opts)
1132
+
1133
+ ```ruby
1134
+ begin
1135
+ # Verify API Key
1136
+ data, status_code, headers = api_instance.admin_verify_api_key_with_http_info(verify_api_key_request, opts)
1137
+ p status_code # => 2xx
1138
+ p headers # => { ... }
1139
+ p data # => <VerifyAPIKeyResponse>
1140
+ rescue OryClient::ApiError => e
1141
+ puts "Error when calling APIKeysApi->admin_verify_api_key_with_http_info: #{e}"
1142
+ end
1143
+ ```
1144
+
1145
+ ### Parameters
1146
+
1147
+ | Name | Type | Description | Notes |
1148
+ | ---- | ---- | ----------- | ----- |
1149
+ | **verify_api_key_request** | [**VerifyAPIKeyRequest**](VerifyAPIKeyRequest.md) | | |
1150
+ | **cache_control** | **String** | Cache-directive controlling the verifier cache. &#x60;no-cache&#x60; forces a fresh database lookup (cache read is bypassed). &#x60;no-store&#x60; additionally prevents the result from being written to the cache. Any other value is ignored. | [optional] |
1151
+ | **pragma** | **String** | HTTP/1.0 alias for &#x60;Cache-Control: no-cache&#x60;. Behaves identically when set to &#x60;no-cache&#x60;; ignored otherwise. | [optional] |
1152
+
1153
+ ### Return type
1154
+
1155
+ [**VerifyAPIKeyResponse**](VerifyAPIKeyResponse.md)
1156
+
1157
+ ### Authorization
1158
+
1159
+ [oryAccessToken](../README.md#oryAccessToken)
1160
+
1161
+ ### HTTP request headers
1162
+
1163
+ - **Content-Type**: application/json
1164
+ - **Accept**: application/json
1165
+
1166
+
1167
+ ## revoke_api_key
1168
+
1169
+ > Object revoke_api_key(self_revoke_api_key_request)
1170
+
1171
+ Revoke API Key (self-service)
1172
+
1173
+ Proof-of-possession variant of revocation. Lives alongside `AdminRevokeAPIKey` in this service; the `Self*` prefix on the request/response messages disambiguates from the admin variant's `RevokeAPIKeyRequest`. Allows an API key holder to revoke their own key. The caller must provide the full API key secret as proof of possession. Supports issued API keys and imported keys. JWT and macaroon tokens cannot be self-revoked (they are stateless). The PRIVILEGE_WITHDRAWN reason is not allowed for self-revocation (admin-only). ```http POST /v2alpha1/apiKeys:selfRevoke { \"credential\": \"sk_live_abc123...\", \"reason\": \"REVOCATION_REASON_KEY_COMPROMISE\" } ```
1174
+
1175
+ ### Examples
1176
+
1177
+ ```ruby
1178
+ require 'time'
1179
+ require 'ory-client'
1180
+
1181
+ api_instance = OryClient::APIKeysApi.new
1182
+ self_revoke_api_key_request = OryClient::SelfRevokeAPIKeyRequest.new # SelfRevokeAPIKeyRequest | SelfRevokeAPIKeyRequest allows an API key holder to revoke their own key by providing the full key secret as proof of possession.
1183
+
1184
+ begin
1185
+ # Revoke API Key (self-service)
1186
+ result = api_instance.revoke_api_key(self_revoke_api_key_request)
1187
+ p result
1188
+ rescue OryClient::ApiError => e
1189
+ puts "Error when calling APIKeysApi->revoke_api_key: #{e}"
1190
+ end
1191
+ ```
1192
+
1193
+ #### Using the revoke_api_key_with_http_info variant
1194
+
1195
+ This returns an Array which contains the response data, status code and headers.
1196
+
1197
+ > <Array(Object, Integer, Hash)> revoke_api_key_with_http_info(self_revoke_api_key_request)
1198
+
1199
+ ```ruby
1200
+ begin
1201
+ # Revoke API Key (self-service)
1202
+ data, status_code, headers = api_instance.revoke_api_key_with_http_info(self_revoke_api_key_request)
1203
+ p status_code # => 2xx
1204
+ p headers # => { ... }
1205
+ p data # => Object
1206
+ rescue OryClient::ApiError => e
1207
+ puts "Error when calling APIKeysApi->revoke_api_key_with_http_info: #{e}"
1208
+ end
1209
+ ```
1210
+
1211
+ ### Parameters
1212
+
1213
+ | Name | Type | Description | Notes |
1214
+ | ---- | ---- | ----------- | ----- |
1215
+ | **self_revoke_api_key_request** | [**SelfRevokeAPIKeyRequest**](SelfRevokeAPIKeyRequest.md) | SelfRevokeAPIKeyRequest allows an API key holder to revoke their own key by providing the full key secret as proof of possession. | |
1216
+
1217
+ ### Return type
1218
+
1219
+ **Object**
1220
+
1221
+ ### Authorization
1222
+
1223
+ No authorization required
1224
+
1225
+ ### HTTP request headers
1226
+
1227
+ - **Content-Type**: application/json
1228
+ - **Accept**: application/json
1229
+