ory-client 0.2.0.alpha26 → 0.2.0.alpha29

Sign up to get free protection for your applications and to get access to all the features.
Files changed (433) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/README.md +90 -95
  4. data/docs/{AcceptOAuth2ConsentRequest.md → AcceptConsentRequest.md} +3 -3
  5. data/docs/{AcceptOAuth2LoginRequest.md → AcceptLoginRequest.md} +2 -2
  6. data/docs/AdminApi.md +2093 -15
  7. data/docs/{SuccessfulOAuth2RequestResponse.md → CompletedRequest.md} +2 -2
  8. data/docs/{OAuth2ConsentRequest.md → ConsentRequest.md} +3 -3
  9. data/docs/{AcceptOAuth2ConsentRequestSession.md → ConsentRequestSession.md} +2 -2
  10. data/docs/CreateProjectApiKeyRequest.md +18 -0
  11. data/docs/FlushInactiveOAuth2TokensRequest.md +18 -0
  12. data/docs/FlushLoginConsentRequest.md +18 -0
  13. data/docs/GenericError.md +1 -1
  14. data/docs/{JsonWebKey.md → JSONWebKey.md} +2 -2
  15. data/docs/JSONWebKeySet.md +18 -0
  16. data/docs/JsonError.md +7 -1
  17. data/docs/{AdminCreateJsonWebKeySetBody.md → JsonWebKeySetGeneratorRequest.md} +2 -2
  18. data/docs/{OAuth2LoginRequest.md → LoginRequest.md} +3 -3
  19. data/docs/{OAuth2LogoutRequest.md → LogoutRequest.md} +2 -2
  20. data/docs/ManagedIdentitySchema.md +1 -1
  21. data/docs/NormalizedProject.md +1 -1
  22. data/docs/NormalizedProjectRevision.md +25 -25
  23. data/docs/NormalizedProjectRevisionHook.md +4 -2
  24. data/docs/NormalizedProjectRevisionIdentitySchema.md +2 -2
  25. data/docs/NormalizedProjectRevisionThirdPartyProvider.md +1 -1
  26. data/docs/OAuth2Client.md +2 -26
  27. data/docs/{IntrospectedOAuth2Token.md → OAuth2TokenIntrospection.md} +2 -2
  28. data/docs/Oauth2TokenResponse.md +28 -0
  29. data/docs/{OAuth2TokenResponse.md → OauthTokenResponse.md} +2 -2
  30. data/docs/{OAuth2ConsentRequestOpenIDConnectContext.md → OpenIDConnectContext.md} +2 -2
  31. data/docs/Pagination.md +0 -4
  32. data/docs/PatchDocument.md +24 -0
  33. data/docs/{PreviousOAuth2ConsentSession.md → PreviousConsentSession.md} +4 -4
  34. data/docs/Project.md +2 -2
  35. data/docs/{ApiToken.md → ProjectApiKey.md} +5 -5
  36. data/docs/ProjectHost.md +2 -2
  37. data/docs/ProjectInvite.md +3 -3
  38. data/docs/ProjectMetadata.md +1 -1
  39. data/docs/PublicApi.md +738 -0
  40. data/docs/RefreshTokenHookRequest.md +0 -4
  41. data/docs/RefreshTokenHookResponse.md +1 -1
  42. data/docs/{RejectOAuth2Request.md → RejectRequest.md} +2 -2
  43. data/docs/{HandledOAuth2LoginRequest.md → RequestWasHandledResponse.md} +2 -2
  44. data/docs/Subscription.md +1 -1
  45. data/docs/{AdminTrustOAuth2JwtGrantIssuerBody.md → TrustJwtGrantIssuerBody.md} +3 -3
  46. data/docs/{TrustedOAuth2JwtGrantJsonWebKey.md → TrustedJsonWebKey.md} +2 -2
  47. data/docs/{TrustedOAuth2JwtGrantIssuer.md → TrustedJwtGrantIssuer.md} +3 -3
  48. data/docs/{OidcUserInfo.md → UserinfoResponse.md} +2 -2
  49. data/docs/V0alpha2Api.md +384 -3154
  50. data/docs/{OidcConfiguration.md → WellKnown.md} +2 -6
  51. data/lib/ory-client/api/admin_api.rb +2108 -14
  52. data/lib/ory-client/api/metadata_api.rb +1 -1
  53. data/lib/ory-client/api/public_api.rb +723 -0
  54. data/lib/ory-client/api/read_api.rb +1 -1
  55. data/lib/ory-client/api/v0alpha2_api.rb +349 -2964
  56. data/lib/ory-client/api/write_api.rb +1 -1
  57. data/lib/ory-client/api_client.rb +1 -1
  58. data/lib/ory-client/api_error.rb +1 -1
  59. data/lib/ory-client/configuration.rb +1 -8
  60. data/lib/ory-client/models/{accept_o_auth2_consent_request.rb → accept_consent_request.rb} +5 -5
  61. data/lib/ory-client/models/{accept_o_auth2_login_request.rb → accept_login_request.rb} +4 -4
  62. data/lib/ory-client/models/active_project.rb +1 -1
  63. data/lib/ory-client/models/admin_create_identity_body.rb +1 -1
  64. data/lib/ory-client/models/admin_create_identity_import_credentials_oidc.rb +1 -1
  65. data/lib/ory-client/models/admin_create_identity_import_credentials_oidc_config.rb +1 -1
  66. data/lib/ory-client/models/admin_create_identity_import_credentials_oidc_provider.rb +1 -1
  67. data/lib/ory-client/models/admin_create_identity_import_credentials_password.rb +1 -1
  68. data/lib/ory-client/models/admin_create_identity_import_credentials_password_config.rb +1 -1
  69. data/lib/ory-client/models/admin_create_self_service_recovery_link_body.rb +1 -1
  70. data/lib/ory-client/models/admin_identity_import_credentials.rb +1 -1
  71. data/lib/ory-client/models/admin_update_identity_body.rb +1 -1
  72. data/lib/ory-client/models/authenticator_assurance_level.rb +1 -1
  73. data/lib/ory-client/models/cloud_account.rb +1 -1
  74. data/lib/ory-client/models/cname_settings.rb +1 -1
  75. data/lib/ory-client/models/{successful_o_auth2_request_response.rb → completed_request.rb} +4 -4
  76. data/lib/ory-client/models/{o_auth2_consent_request.rb → consent_request.rb} +5 -5
  77. data/lib/ory-client/models/{accept_o_auth2_consent_request_session.rb → consent_request_session.rb} +4 -4
  78. data/lib/ory-client/models/create_custom_hostname_body.rb +1 -1
  79. data/lib/ory-client/models/{headers.rb → create_project_api_key_request.rb} +17 -14
  80. data/lib/ory-client/models/create_project_body.rb +1 -1
  81. data/lib/ory-client/models/create_subscription_payload.rb +1 -1
  82. data/lib/ory-client/models/error_authenticator_assurance_level_not_satisfied.rb +1 -1
  83. data/lib/ory-client/models/expand_tree.rb +1 -1
  84. data/lib/ory-client/models/{handled_o_auth2_logout_request.rb → flush_inactive_o_auth2_tokens_request.rb} +12 -17
  85. data/lib/ory-client/models/{handled_o_auth2_consent_request.rb → flush_login_consent_request.rb} +12 -17
  86. data/lib/ory-client/models/generic_error.rb +4 -5
  87. data/lib/ory-client/models/generic_error_content.rb +1 -1
  88. data/lib/ory-client/models/get_check_response.rb +1 -1
  89. data/lib/ory-client/models/get_managed_identity_schema_location.rb +1 -1
  90. data/lib/ory-client/models/get_relation_tuples_response.rb +1 -1
  91. data/lib/ory-client/models/get_version200_response.rb +1 -1
  92. data/lib/ory-client/models/health_not_ready_status.rb +1 -1
  93. data/lib/ory-client/models/health_status.rb +1 -1
  94. data/lib/ory-client/models/identity.rb +1 -1
  95. data/lib/ory-client/models/identity_credentials.rb +1 -1
  96. data/lib/ory-client/models/identity_credentials_oidc.rb +1 -1
  97. data/lib/ory-client/models/identity_credentials_oidc_provider.rb +1 -1
  98. data/lib/ory-client/models/identity_credentials_password.rb +1 -1
  99. data/lib/ory-client/models/identity_credentials_type.rb +1 -1
  100. data/lib/ory-client/models/identity_schema_container.rb +1 -1
  101. data/lib/ory-client/models/identity_schema_preset.rb +1 -1
  102. data/lib/ory-client/models/identity_state.rb +1 -1
  103. data/lib/ory-client/models/invite_payload.rb +1 -1
  104. data/lib/ory-client/models/is_owner_for_project_by_slug.rb +1 -1
  105. data/lib/ory-client/models/is_owner_for_project_by_slug_payload.rb +1 -1
  106. data/lib/ory-client/models/is_ready200_response.rb +1 -1
  107. data/lib/ory-client/models/is_ready503_response.rb +1 -1
  108. data/lib/ory-client/models/json_error.rb +35 -5
  109. data/lib/ory-client/models/json_patch.rb +1 -1
  110. data/lib/ory-client/models/json_web_key.rb +5 -4
  111. data/lib/ory-client/models/json_web_key_set.rb +6 -6
  112. data/lib/ory-client/models/{admin_create_json_web_key_set_body.rb → json_web_key_set_generator_request.rb} +4 -4
  113. data/lib/ory-client/models/keto_namespace.rb +1 -1
  114. data/lib/ory-client/models/{o_auth2_login_request.rb → login_request.rb} +5 -5
  115. data/lib/ory-client/models/{o_auth2_logout_request.rb → logout_request.rb} +4 -4
  116. data/lib/ory-client/models/managed_identity_schema.rb +2 -1
  117. data/lib/ory-client/models/managed_identity_schema_validation_result.rb +1 -1
  118. data/lib/ory-client/models/needs_privileged_session_error.rb +1 -1
  119. data/lib/ory-client/models/normalized_project.rb +2 -1
  120. data/lib/ory-client/models/normalized_project_revision.rb +35 -21
  121. data/lib/ory-client/models/normalized_project_revision_hook.rb +14 -2
  122. data/lib/ory-client/models/normalized_project_revision_identity_schema.rb +3 -1
  123. data/lib/ory-client/models/normalized_project_revision_third_party_provider.rb +2 -1
  124. data/lib/ory-client/models/null_plan.rb +1 -1
  125. data/lib/ory-client/models/o_auth2_client.rb +13 -320
  126. data/lib/ory-client/models/{introspected_o_auth2_token.rb → o_auth2_token_introspection.rb} +5 -5
  127. data/lib/ory-client/models/{o_auth2_consent_session_expires_at.rb → oauth2_token_response.rb} +35 -25
  128. data/lib/ory-client/models/{o_auth2_token_response.rb → oauth_token_response.rb} +5 -5
  129. data/lib/ory-client/models/{o_auth2_consent_request_open_id_connect_context.rb → open_id_connect_context.rb} +4 -4
  130. data/lib/ory-client/models/pagination.rb +2 -56
  131. data/lib/ory-client/models/patch_delta.rb +1 -1
  132. data/lib/ory-client/models/{pagination_headers.rb → patch_document.rb} +50 -19
  133. data/lib/ory-client/models/{previous_o_auth2_consent_session.rb → previous_consent_session.rb} +6 -6
  134. data/lib/ory-client/models/project.rb +3 -1
  135. data/lib/ory-client/models/{api_token.rb → project_api_key.rb} +7 -4
  136. data/lib/ory-client/models/project_host.rb +3 -1
  137. data/lib/ory-client/models/project_invite.rb +4 -1
  138. data/lib/ory-client/models/project_metadata.rb +2 -1
  139. data/lib/ory-client/models/project_service_identity.rb +1 -1
  140. data/lib/ory-client/models/project_service_o_auth2.rb +1 -1
  141. data/lib/ory-client/models/project_service_permission.rb +1 -1
  142. data/lib/ory-client/models/project_services.rb +1 -1
  143. data/lib/ory-client/models/provision_mock_subscription_payload.rb +1 -1
  144. data/lib/ory-client/models/quota_custom_domains.rb +1 -1
  145. data/lib/ory-client/models/quota_project_member_seats.rb +1 -1
  146. data/lib/ory-client/models/recovery_address.rb +1 -1
  147. data/lib/ory-client/models/refresh_token_hook_request.rb +2 -20
  148. data/lib/ory-client/models/refresh_token_hook_response.rb +2 -2
  149. data/lib/ory-client/models/{reject_o_auth2_request.rb → reject_request.rb} +4 -4
  150. data/lib/ory-client/models/relation_query.rb +1 -1
  151. data/lib/ory-client/models/relation_tuple.rb +1 -1
  152. data/lib/ory-client/models/{handled_o_auth2_login_request.rb → request_was_handled_response.rb} +4 -4
  153. data/lib/ory-client/models/revoked_sessions.rb +1 -1
  154. data/lib/ory-client/models/schema_patch.rb +1 -1
  155. data/lib/ory-client/models/self_service_browser_location_change_required_error.rb +1 -1
  156. data/lib/ory-client/models/self_service_error.rb +1 -1
  157. data/lib/ory-client/models/self_service_flow_expired_error.rb +1 -1
  158. data/lib/ory-client/models/self_service_login_flow.rb +1 -1
  159. data/lib/ory-client/models/self_service_logout_url.rb +1 -1
  160. data/lib/ory-client/models/self_service_recovery_flow.rb +1 -1
  161. data/lib/ory-client/models/self_service_recovery_flow_state.rb +1 -1
  162. data/lib/ory-client/models/self_service_recovery_link.rb +1 -1
  163. data/lib/ory-client/models/self_service_registration_flow.rb +1 -1
  164. data/lib/ory-client/models/self_service_settings_flow.rb +1 -1
  165. data/lib/ory-client/models/self_service_settings_flow_state.rb +1 -1
  166. data/lib/ory-client/models/self_service_verification_flow.rb +1 -1
  167. data/lib/ory-client/models/self_service_verification_flow_state.rb +1 -1
  168. data/lib/ory-client/models/session.rb +1 -1
  169. data/lib/ory-client/models/session_authentication_method.rb +1 -1
  170. data/lib/ory-client/models/session_device.rb +1 -1
  171. data/lib/ory-client/models/settings_profile_form_config.rb +1 -1
  172. data/lib/ory-client/models/stripe_customer_response.rb +1 -1
  173. data/lib/ory-client/models/subject_set.rb +1 -1
  174. data/lib/ory-client/models/submit_self_service_flow_with_web_authn_registration_method.rb +1 -1
  175. data/lib/ory-client/models/submit_self_service_login_flow_body.rb +1 -1
  176. data/lib/ory-client/models/submit_self_service_login_flow_with_lookup_secret_method_body.rb +1 -1
  177. data/lib/ory-client/models/submit_self_service_login_flow_with_oidc_method_body.rb +1 -1
  178. data/lib/ory-client/models/submit_self_service_login_flow_with_password_method_body.rb +1 -1
  179. data/lib/ory-client/models/submit_self_service_login_flow_with_totp_method_body.rb +1 -1
  180. data/lib/ory-client/models/submit_self_service_login_flow_with_web_authn_method_body.rb +1 -1
  181. data/lib/ory-client/models/submit_self_service_logout_flow_without_browser_body.rb +1 -1
  182. data/lib/ory-client/models/submit_self_service_recovery_flow_body.rb +1 -1
  183. data/lib/ory-client/models/submit_self_service_recovery_flow_with_link_method_body.rb +1 -1
  184. data/lib/ory-client/models/submit_self_service_registration_flow_body.rb +1 -1
  185. data/lib/ory-client/models/submit_self_service_registration_flow_with_oidc_method_body.rb +1 -1
  186. data/lib/ory-client/models/submit_self_service_registration_flow_with_password_method_body.rb +1 -1
  187. data/lib/ory-client/models/submit_self_service_registration_flow_with_web_authn_method_body.rb +1 -1
  188. data/lib/ory-client/models/submit_self_service_settings_flow_body.rb +1 -1
  189. data/lib/ory-client/models/submit_self_service_settings_flow_with_lookup_method_body.rb +1 -1
  190. data/lib/ory-client/models/submit_self_service_settings_flow_with_oidc_method_body.rb +1 -1
  191. data/lib/ory-client/models/submit_self_service_settings_flow_with_password_method_body.rb +1 -1
  192. data/lib/ory-client/models/submit_self_service_settings_flow_with_profile_method_body.rb +1 -1
  193. data/lib/ory-client/models/submit_self_service_settings_flow_with_totp_method_body.rb +1 -1
  194. data/lib/ory-client/models/submit_self_service_settings_flow_with_web_authn_method_body.rb +1 -1
  195. data/lib/ory-client/models/submit_self_service_verification_flow_body.rb +1 -1
  196. data/lib/ory-client/models/submit_self_service_verification_flow_with_link_method_body.rb +1 -1
  197. data/lib/ory-client/models/subscription.rb +2 -1
  198. data/lib/ory-client/models/successful_project_update.rb +1 -1
  199. data/lib/ory-client/models/successful_self_service_login_without_browser.rb +1 -1
  200. data/lib/ory-client/models/successful_self_service_registration_without_browser.rb +1 -1
  201. data/lib/ory-client/models/token_pagination.rb +1 -1
  202. data/lib/ory-client/models/token_pagination_headers.rb +1 -1
  203. data/lib/ory-client/models/{admin_trust_o_auth2_jwt_grant_issuer_body.rb → trust_jwt_grant_issuer_body.rb} +5 -5
  204. data/lib/ory-client/models/{trusted_o_auth2_jwt_grant_json_web_key.rb → trusted_json_web_key.rb} +4 -4
  205. data/lib/ory-client/models/{trusted_o_auth2_jwt_grant_issuer.rb → trusted_jwt_grant_issuer.rb} +5 -5
  206. data/lib/ory-client/models/ui_container.rb +1 -1
  207. data/lib/ory-client/models/ui_node.rb +1 -1
  208. data/lib/ory-client/models/ui_node_anchor_attributes.rb +1 -1
  209. data/lib/ory-client/models/ui_node_attributes.rb +1 -1
  210. data/lib/ory-client/models/ui_node_image_attributes.rb +1 -1
  211. data/lib/ory-client/models/ui_node_input_attributes.rb +13 -1
  212. data/lib/ory-client/models/ui_node_meta.rb +1 -1
  213. data/lib/ory-client/models/ui_node_script_attributes.rb +1 -1
  214. data/lib/ory-client/models/ui_node_text_attributes.rb +1 -1
  215. data/lib/ory-client/models/ui_text.rb +1 -1
  216. data/lib/ory-client/models/update_custom_hostname_body.rb +1 -1
  217. data/lib/ory-client/models/update_project.rb +1 -1
  218. data/lib/ory-client/models/update_subscription_payload.rb +1 -1
  219. data/lib/ory-client/models/{oidc_user_info.rb → userinfo_response.rb} +4 -4
  220. data/lib/ory-client/models/verifiable_identity_address.rb +1 -1
  221. data/lib/ory-client/models/version.rb +1 -1
  222. data/lib/ory-client/models/warning.rb +1 -1
  223. data/lib/ory-client/models/{oidc_configuration.rb → well_known.rb} +6 -40
  224. data/lib/ory-client/version.rb +2 -2
  225. data/lib/ory-client.rb +29 -33
  226. data/ory-client.gemspec +1 -1
  227. data/spec/api/admin_api_spec.rb +400 -5
  228. data/spec/api/metadata_api_spec.rb +1 -1
  229. data/spec/api/public_api_spec.rb +167 -0
  230. data/spec/api/read_api_spec.rb +1 -1
  231. data/spec/api/v0alpha2_api_spec.rb +38 -529
  232. data/spec/api/write_api_spec.rb +1 -1
  233. data/spec/api_client_spec.rb +1 -1
  234. data/spec/configuration_spec.rb +1 -1
  235. data/spec/models/{accept_o_auth2_consent_request_spec.rb → accept_consent_request_spec.rb} +7 -7
  236. data/spec/models/{accept_o_auth2_login_request_spec.rb → accept_login_request_spec.rb} +7 -7
  237. data/spec/models/active_project_spec.rb +1 -1
  238. data/spec/models/admin_create_identity_body_spec.rb +1 -1
  239. data/spec/models/admin_create_identity_import_credentials_oidc_config_spec.rb +1 -1
  240. data/spec/models/admin_create_identity_import_credentials_oidc_provider_spec.rb +1 -1
  241. data/spec/models/admin_create_identity_import_credentials_oidc_spec.rb +1 -1
  242. data/spec/models/admin_create_identity_import_credentials_password_config_spec.rb +1 -1
  243. data/spec/models/admin_create_identity_import_credentials_password_spec.rb +1 -1
  244. data/spec/models/admin_create_self_service_recovery_link_body_spec.rb +1 -1
  245. data/spec/models/admin_identity_import_credentials_spec.rb +1 -1
  246. data/spec/models/admin_update_identity_body_spec.rb +1 -1
  247. data/spec/models/authenticator_assurance_level_spec.rb +1 -1
  248. data/spec/models/cloud_account_spec.rb +1 -1
  249. data/spec/models/cname_settings_spec.rb +1 -1
  250. data/spec/models/{handled_o_auth2_logout_request_spec.rb → completed_request_spec.rb} +7 -7
  251. data/spec/models/{accept_o_auth2_consent_request_session_spec.rb → consent_request_session_spec.rb} +7 -7
  252. data/spec/models/{o_auth2_consent_request_spec.rb → consent_request_spec.rb} +7 -7
  253. data/spec/models/create_custom_hostname_body_spec.rb +1 -1
  254. data/spec/models/{handled_o_auth2_consent_request_spec.rb → create_project_api_key_request_spec.rb} +8 -8
  255. data/spec/models/create_project_body_spec.rb +1 -1
  256. data/spec/models/create_subscription_payload_spec.rb +1 -1
  257. data/spec/models/error_authenticator_assurance_level_not_satisfied_spec.rb +1 -1
  258. data/spec/models/expand_tree_spec.rb +1 -1
  259. data/spec/models/flush_inactive_o_auth2_tokens_request_spec.rb +34 -0
  260. data/spec/models/{headers_spec.rb → flush_login_consent_request_spec.rb} +8 -8
  261. data/spec/models/generic_error_content_spec.rb +1 -1
  262. data/spec/models/generic_error_spec.rb +1 -1
  263. data/spec/models/get_check_response_spec.rb +1 -1
  264. data/spec/models/get_managed_identity_schema_location_spec.rb +1 -1
  265. data/spec/models/get_relation_tuples_response_spec.rb +1 -1
  266. data/spec/models/get_version200_response_spec.rb +1 -1
  267. data/spec/models/health_not_ready_status_spec.rb +1 -1
  268. data/spec/models/health_status_spec.rb +1 -1
  269. data/spec/models/identity_credentials_oidc_provider_spec.rb +1 -1
  270. data/spec/models/identity_credentials_oidc_spec.rb +1 -1
  271. data/spec/models/identity_credentials_password_spec.rb +1 -1
  272. data/spec/models/identity_credentials_spec.rb +1 -1
  273. data/spec/models/identity_credentials_type_spec.rb +1 -1
  274. data/spec/models/identity_schema_container_spec.rb +1 -1
  275. data/spec/models/identity_schema_preset_spec.rb +1 -1
  276. data/spec/models/identity_spec.rb +1 -1
  277. data/spec/models/identity_state_spec.rb +1 -1
  278. data/spec/models/invite_payload_spec.rb +1 -1
  279. data/spec/models/is_owner_for_project_by_slug_payload_spec.rb +1 -1
  280. data/spec/models/is_owner_for_project_by_slug_spec.rb +1 -1
  281. data/spec/models/is_ready200_response_spec.rb +1 -1
  282. data/spec/models/is_ready503_response_spec.rb +1 -1
  283. data/spec/models/json_error_spec.rb +19 -1
  284. data/spec/models/json_patch_spec.rb +1 -1
  285. data/spec/models/{admin_create_json_web_key_set_body_spec.rb → json_web_key_set_generator_request_spec.rb} +7 -7
  286. data/spec/models/json_web_key_set_spec.rb +7 -7
  287. data/spec/models/json_web_key_spec.rb +7 -7
  288. data/spec/models/keto_namespace_spec.rb +1 -1
  289. data/spec/models/{o_auth2_login_request_spec.rb → login_request_spec.rb} +7 -7
  290. data/spec/models/{o_auth2_logout_request_spec.rb → logout_request_spec.rb} +7 -7
  291. data/spec/models/managed_identity_schema_spec.rb +1 -1
  292. data/spec/models/managed_identity_schema_validation_result_spec.rb +1 -1
  293. data/spec/models/needs_privileged_session_error_spec.rb +1 -1
  294. data/spec/models/normalized_project_revision_hook_spec.rb +7 -1
  295. data/spec/models/normalized_project_revision_identity_schema_spec.rb +1 -1
  296. data/spec/models/normalized_project_revision_spec.rb +1 -1
  297. data/spec/models/normalized_project_revision_third_party_provider_spec.rb +1 -1
  298. data/spec/models/normalized_project_spec.rb +1 -1
  299. data/spec/models/null_plan_spec.rb +1 -1
  300. data/spec/models/o_auth2_client_spec.rb +1 -73
  301. data/spec/models/{introspected_o_auth2_token_spec.rb → o_auth2_token_introspection_spec.rb} +7 -7
  302. data/spec/models/{o_auth2_token_response_spec.rb → oauth2_token_response_spec.rb} +7 -7
  303. data/spec/models/{o_auth2_consent_session_expires_at_spec.rb → oauth_token_response_spec.rb} +16 -10
  304. data/spec/models/{o_auth2_consent_request_open_id_connect_context_spec.rb → open_id_connect_context_spec.rb} +7 -7
  305. data/spec/models/pagination_spec.rb +1 -13
  306. data/spec/models/patch_delta_spec.rb +1 -1
  307. data/spec/models/{o_auth2_api_error_spec.rb → patch_document_spec.rb} +11 -11
  308. data/spec/models/{previous_o_auth2_consent_session_spec.rb → previous_consent_session_spec.rb} +7 -7
  309. data/spec/models/{api_token_spec.rb → project_api_key_spec.rb} +7 -7
  310. data/spec/models/project_host_spec.rb +1 -1
  311. data/spec/models/project_invite_spec.rb +1 -1
  312. data/spec/models/project_metadata_spec.rb +1 -1
  313. data/spec/models/project_service_identity_spec.rb +1 -1
  314. data/spec/models/project_service_o_auth2_spec.rb +1 -1
  315. data/spec/models/project_service_permission_spec.rb +1 -1
  316. data/spec/models/project_services_spec.rb +1 -1
  317. data/spec/models/project_spec.rb +1 -1
  318. data/spec/models/provision_mock_subscription_payload_spec.rb +1 -1
  319. data/spec/models/quota_custom_domains_spec.rb +1 -1
  320. data/spec/models/quota_project_member_seats_spec.rb +1 -1
  321. data/spec/models/recovery_address_spec.rb +1 -1
  322. data/spec/models/refresh_token_hook_request_spec.rb +1 -13
  323. data/spec/models/refresh_token_hook_response_spec.rb +1 -1
  324. data/spec/models/{reject_o_auth2_request_spec.rb → reject_request_spec.rb} +7 -7
  325. data/spec/models/relation_query_spec.rb +1 -1
  326. data/spec/models/relation_tuple_spec.rb +1 -1
  327. data/spec/models/{handled_o_auth2_login_request_spec.rb → request_was_handled_response_spec.rb} +7 -7
  328. data/spec/models/revoked_sessions_spec.rb +1 -1
  329. data/spec/models/schema_patch_spec.rb +1 -1
  330. data/spec/models/self_service_browser_location_change_required_error_spec.rb +1 -1
  331. data/spec/models/self_service_error_spec.rb +1 -1
  332. data/spec/models/self_service_flow_expired_error_spec.rb +1 -1
  333. data/spec/models/self_service_login_flow_spec.rb +1 -1
  334. data/spec/models/self_service_logout_url_spec.rb +1 -1
  335. data/spec/models/self_service_recovery_flow_spec.rb +1 -1
  336. data/spec/models/self_service_recovery_flow_state_spec.rb +1 -1
  337. data/spec/models/self_service_recovery_link_spec.rb +1 -1
  338. data/spec/models/self_service_registration_flow_spec.rb +1 -1
  339. data/spec/models/self_service_settings_flow_spec.rb +1 -1
  340. data/spec/models/self_service_settings_flow_state_spec.rb +1 -1
  341. data/spec/models/self_service_verification_flow_spec.rb +1 -1
  342. data/spec/models/self_service_verification_flow_state_spec.rb +1 -1
  343. data/spec/models/session_authentication_method_spec.rb +1 -1
  344. data/spec/models/session_device_spec.rb +1 -1
  345. data/spec/models/session_spec.rb +1 -1
  346. data/spec/models/settings_profile_form_config_spec.rb +1 -1
  347. data/spec/models/stripe_customer_response_spec.rb +1 -1
  348. data/spec/models/subject_set_spec.rb +1 -1
  349. data/spec/models/submit_self_service_flow_with_web_authn_registration_method_spec.rb +1 -1
  350. data/spec/models/submit_self_service_login_flow_body_spec.rb +1 -1
  351. data/spec/models/submit_self_service_login_flow_with_lookup_secret_method_body_spec.rb +1 -1
  352. data/spec/models/submit_self_service_login_flow_with_oidc_method_body_spec.rb +1 -1
  353. data/spec/models/submit_self_service_login_flow_with_password_method_body_spec.rb +1 -1
  354. data/spec/models/submit_self_service_login_flow_with_totp_method_body_spec.rb +1 -1
  355. data/spec/models/submit_self_service_login_flow_with_web_authn_method_body_spec.rb +1 -1
  356. data/spec/models/submit_self_service_logout_flow_without_browser_body_spec.rb +1 -1
  357. data/spec/models/submit_self_service_recovery_flow_body_spec.rb +1 -1
  358. data/spec/models/submit_self_service_recovery_flow_with_link_method_body_spec.rb +1 -1
  359. data/spec/models/submit_self_service_registration_flow_body_spec.rb +1 -1
  360. data/spec/models/submit_self_service_registration_flow_with_oidc_method_body_spec.rb +1 -1
  361. data/spec/models/submit_self_service_registration_flow_with_password_method_body_spec.rb +1 -1
  362. data/spec/models/submit_self_service_registration_flow_with_web_authn_method_body_spec.rb +1 -1
  363. data/spec/models/submit_self_service_settings_flow_body_spec.rb +1 -1
  364. data/spec/models/submit_self_service_settings_flow_with_lookup_method_body_spec.rb +1 -1
  365. data/spec/models/submit_self_service_settings_flow_with_oidc_method_body_spec.rb +1 -1
  366. data/spec/models/submit_self_service_settings_flow_with_password_method_body_spec.rb +1 -1
  367. data/spec/models/submit_self_service_settings_flow_with_profile_method_body_spec.rb +1 -1
  368. data/spec/models/submit_self_service_settings_flow_with_totp_method_body_spec.rb +1 -1
  369. data/spec/models/submit_self_service_settings_flow_with_web_authn_method_body_spec.rb +1 -1
  370. data/spec/models/submit_self_service_verification_flow_body_spec.rb +1 -1
  371. data/spec/models/submit_self_service_verification_flow_with_link_method_body_spec.rb +1 -1
  372. data/spec/models/subscription_spec.rb +1 -1
  373. data/spec/models/successful_project_update_spec.rb +1 -1
  374. data/spec/models/successful_self_service_login_without_browser_spec.rb +1 -1
  375. data/spec/models/successful_self_service_registration_without_browser_spec.rb +1 -1
  376. data/spec/models/token_pagination_headers_spec.rb +1 -1
  377. data/spec/models/token_pagination_spec.rb +1 -1
  378. data/spec/models/{admin_trust_o_auth2_jwt_grant_issuer_body_spec.rb → trust_jwt_grant_issuer_body_spec.rb} +7 -7
  379. data/spec/models/{trusted_o_auth2_jwt_grant_json_web_key_spec.rb → trusted_json_web_key_spec.rb} +7 -7
  380. data/spec/models/{trusted_o_auth2_jwt_grant_issuer_spec.rb → trusted_jwt_grant_issuer_spec.rb} +7 -7
  381. data/spec/models/ui_container_spec.rb +1 -1
  382. data/spec/models/ui_node_anchor_attributes_spec.rb +1 -1
  383. data/spec/models/ui_node_attributes_spec.rb +1 -1
  384. data/spec/models/ui_node_image_attributes_spec.rb +1 -1
  385. data/spec/models/ui_node_input_attributes_spec.rb +5 -1
  386. data/spec/models/ui_node_meta_spec.rb +1 -1
  387. data/spec/models/ui_node_script_attributes_spec.rb +1 -1
  388. data/spec/models/ui_node_spec.rb +1 -1
  389. data/spec/models/ui_node_text_attributes_spec.rb +1 -1
  390. data/spec/models/ui_text_spec.rb +1 -1
  391. data/spec/models/update_custom_hostname_body_spec.rb +1 -1
  392. data/spec/models/update_project_spec.rb +1 -1
  393. data/spec/models/update_subscription_payload_spec.rb +1 -1
  394. data/spec/models/{oidc_user_info_spec.rb → userinfo_response_spec.rb} +7 -7
  395. data/spec/models/verifiable_identity_address_spec.rb +1 -1
  396. data/spec/models/version_spec.rb +1 -1
  397. data/spec/models/warning_spec.rb +1 -1
  398. data/spec/models/{oidc_configuration_spec.rb → well_known_spec.rb} +7 -19
  399. data/spec/spec_helper.rb +1 -1
  400. data/vendor/bundle/ruby/2.5.0/extensions/x86_64-linux/2.5.0/byebug-11.1.3/gem_make.out +2 -2
  401. data/vendor/bundle/ruby/2.5.0/extensions/x86_64-linux/2.5.0/ffi-1.15.5/gem_make.out +2 -2
  402. data/vendor/bundle/ruby/2.5.0/extensions/x86_64-linux/2.5.0/jaro_winkler-1.5.4/gem_make.out +2 -2
  403. data/vendor/bundle/ruby/2.5.0/extensions/x86_64-linux/2.5.0/psych-4.0.4/gem_make.out +2 -2
  404. data/vendor/bundle/ruby/2.5.0/extensions/x86_64-linux/2.5.0/stringio-3.0.2/gem_make.out +2 -2
  405. data/vendor/bundle/ruby/2.5.0/extensions/x86_64-linux/2.5.0/stringio-3.0.2/mkmf.log +1 -1
  406. data/vendor/bundle/ruby/2.5.0/gems/byebug-11.1.3/ext/byebug/Makefile +2 -2
  407. data/vendor/bundle/ruby/2.5.0/gems/ffi-1.15.5/ext/ffi_c/Makefile +2 -2
  408. data/vendor/bundle/ruby/2.5.0/gems/jaro_winkler-1.5.4/ext/jaro_winkler/Makefile +2 -2
  409. data/vendor/bundle/ruby/2.5.0/gems/psych-4.0.4/ext/psych/Makefile +2 -2
  410. data/vendor/bundle/ruby/2.5.0/gems/stringio-3.0.2/ext/stringio/Makefile +2 -2
  411. metadata +109 -125
  412. data/docs/HandledOAuth2ConsentRequest.md +0 -18
  413. data/docs/HandledOAuth2LogoutRequest.md +0 -18
  414. data/docs/Headers.md +0 -18
  415. data/docs/IDTokenClaims.md +0 -44
  416. data/docs/JsonWebKeySet.md +0 -18
  417. data/docs/OAuth2AccessRequest.md +0 -24
  418. data/docs/OAuth2ApiError.md +0 -24
  419. data/docs/OAuth2ConsentSession.md +0 -38
  420. data/docs/OAuth2ConsentSessionExpiresAt.md +0 -26
  421. data/docs/PaginationHeaders.md +0 -20
  422. data/docs/UpdateOAuth2ClientLifespans.md +0 -40
  423. data/lib/ory-client/models/id_token_claims.rb +0 -343
  424. data/lib/ory-client/models/o_auth2_access_request.rb +0 -256
  425. data/lib/ory-client/models/o_auth2_api_error.rb +0 -251
  426. data/lib/ory-client/models/o_auth2_consent_session.rb +0 -313
  427. data/lib/ory-client/models/update_o_auth2_client_lifespans.rb +0 -535
  428. data/spec/models/id_token_claims_spec.rb +0 -112
  429. data/spec/models/o_auth2_access_request_spec.rb +0 -52
  430. data/spec/models/o_auth2_consent_session_spec.rb +0 -94
  431. data/spec/models/pagination_headers_spec.rb +0 -40
  432. data/spec/models/successful_o_auth2_request_response_spec.rb +0 -34
  433. data/spec/models/update_o_auth2_client_lifespans_spec.rb +0 -100
data/docs/V0alpha2Api.md CHANGED
@@ -4,65 +4,29 @@ All URIs are relative to *https://playground.projects.oryapis.com*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
- | [**admin_accept_o_auth2_consent_request**](V0alpha2Api.md#admin_accept_o_auth2_consent_request) | **PUT** /admin/oauth2/auth/requests/consent/accept | Accept an OAuth 2.0 Consent Request |
8
- | [**admin_accept_o_auth2_login_request**](V0alpha2Api.md#admin_accept_o_auth2_login_request) | **PUT** /admin/oauth2/auth/requests/login/accept | Accept an OAuth 2.0 Login Request |
9
- | [**admin_accept_o_auth2_logout_request**](V0alpha2Api.md#admin_accept_o_auth2_logout_request) | **PUT** /admin/oauth2/auth/requests/logout/accept | Accept an OAuth 2.0 Logout Request |
10
7
  | [**admin_create_identity**](V0alpha2Api.md#admin_create_identity) | **POST** /admin/identities | Create an Identity |
11
- | [**admin_create_json_web_key_set**](V0alpha2Api.md#admin_create_json_web_key_set) | **POST** /admin/keys/{set} | Generate a New JSON Web Key |
12
- | [**admin_create_o_auth2_client**](V0alpha2Api.md#admin_create_o_auth2_client) | **POST** /admin/clients | Create an OAuth 2.0 Client |
13
8
  | [**admin_create_self_service_recovery_link**](V0alpha2Api.md#admin_create_self_service_recovery_link) | **POST** /admin/recovery/link | Create a Recovery Link |
14
9
  | [**admin_delete_identity**](V0alpha2Api.md#admin_delete_identity) | **DELETE** /admin/identities/{id} | Delete an Identity |
15
10
  | [**admin_delete_identity_sessions**](V0alpha2Api.md#admin_delete_identity_sessions) | **DELETE** /admin/identities/{id}/sessions | Calling this endpoint irrecoverably and permanently deletes and invalidates all sessions that belong to the given Identity. |
16
- | [**admin_delete_json_web_key**](V0alpha2Api.md#admin_delete_json_web_key) | **DELETE** /admin/keys/{set}/{kid} | Delete a JSON Web Key |
17
- | [**admin_delete_json_web_key_set**](V0alpha2Api.md#admin_delete_json_web_key_set) | **DELETE** /admin/keys/{set} | Delete a JSON Web Key Set |
18
- | [**admin_delete_o_auth2_client**](V0alpha2Api.md#admin_delete_o_auth2_client) | **DELETE** /admin/clients/{id} | Deletes an OAuth 2.0 Client |
19
- | [**admin_delete_o_auth2_token**](V0alpha2Api.md#admin_delete_o_auth2_token) | **DELETE** /admin/oauth2/tokens | Delete OAuth2 Access Tokens from a Client |
20
- | [**admin_delete_trusted_o_auth2_jwt_grant_issuer**](V0alpha2Api.md#admin_delete_trusted_o_auth2_jwt_grant_issuer) | **DELETE** /admin/trust/grants/jwt-bearer/issuers/{id} | Delete a Trusted OAuth2 JWT Bearer Grant Type Issuer |
21
11
  | [**admin_extend_session**](V0alpha2Api.md#admin_extend_session) | **PATCH** /admin/sessions/{id}/extend | Calling this endpoint extends the given session ID. If `session.earliest_possible_extend` is set it will only extend the session after the specified time has passed. |
22
12
  | [**admin_get_identity**](V0alpha2Api.md#admin_get_identity) | **GET** /admin/identities/{id} | Get an Identity |
23
- | [**admin_get_json_web_key**](V0alpha2Api.md#admin_get_json_web_key) | **GET** /admin/keys/{set}/{kid} | Fetch a JSON Web Key |
24
- | [**admin_get_json_web_key_set**](V0alpha2Api.md#admin_get_json_web_key_set) | **GET** /admin/keys/{set} | Retrieve a JSON Web Key Set |
25
- | [**admin_get_o_auth2_client**](V0alpha2Api.md#admin_get_o_auth2_client) | **GET** /admin/clients/{id} | Get an OAuth 2.0 Client |
26
- | [**admin_get_o_auth2_consent_request**](V0alpha2Api.md#admin_get_o_auth2_consent_request) | **GET** /admin/oauth2/auth/requests/consent | Get OAuth 2.0 Consent Request Information |
27
- | [**admin_get_o_auth2_login_request**](V0alpha2Api.md#admin_get_o_auth2_login_request) | **GET** /admin/oauth2/auth/requests/login | Get an OAuth 2.0 Login Request |
28
- | [**admin_get_o_auth2_logout_request**](V0alpha2Api.md#admin_get_o_auth2_logout_request) | **GET** /admin/oauth2/auth/requests/logout | Get an OAuth 2.0 Logout Request |
29
- | [**admin_get_trusted_o_auth2_jwt_grant_issuer**](V0alpha2Api.md#admin_get_trusted_o_auth2_jwt_grant_issuer) | **GET** /admin/trust/grants/jwt-bearer/issuers/{id} | Get a Trusted OAuth2 JWT Bearer Grant Type Issuer |
30
- | [**admin_introspect_o_auth2_token**](V0alpha2Api.md#admin_introspect_o_auth2_token) | **POST** /admin/oauth2/introspect | Introspect OAuth2 Access or Refresh Tokens |
31
13
  | [**admin_list_identities**](V0alpha2Api.md#admin_list_identities) | **GET** /admin/identities | List Identities |
32
14
  | [**admin_list_identity_sessions**](V0alpha2Api.md#admin_list_identity_sessions) | **GET** /admin/identities/{id}/sessions | This endpoint returns all sessions that belong to the given Identity. |
33
- | [**admin_list_o_auth2_clients**](V0alpha2Api.md#admin_list_o_auth2_clients) | **GET** /admin/clients | List OAuth 2.0 Clients |
34
- | [**admin_list_o_auth2_subject_consent_sessions**](V0alpha2Api.md#admin_list_o_auth2_subject_consent_sessions) | **GET** /admin/oauth2/auth/sessions/consent | List OAuth 2.0 Consent Sessions of a Subject |
35
- | [**admin_list_trusted_o_auth2_jwt_grant_issuers**](V0alpha2Api.md#admin_list_trusted_o_auth2_jwt_grant_issuers) | **GET** /admin/trust/grants/jwt-bearer/issuers | List Trusted OAuth2 JWT Bearer Grant Type Issuers |
36
15
  | [**admin_patch_identity**](V0alpha2Api.md#admin_patch_identity) | **PATCH** /admin/identities/{id} | Partially updates an Identity's field using [JSON Patch](https://jsonpatch.com/) |
37
- | [**admin_patch_o_auth2_client**](V0alpha2Api.md#admin_patch_o_auth2_client) | **PATCH** /admin/clients/{id} | Patch an OAuth 2.0 Client |
38
- | [**admin_reject_o_auth2_consent_request**](V0alpha2Api.md#admin_reject_o_auth2_consent_request) | **PUT** /admin/oauth2/auth/requests/consent/reject | Reject an OAuth 2.0 Consent Request |
39
- | [**admin_reject_o_auth2_login_request**](V0alpha2Api.md#admin_reject_o_auth2_login_request) | **PUT** /admin/oauth2/auth/requests/login/reject | Reject an OAuth 2.0 Login Request |
40
- | [**admin_reject_o_auth2_logout_request**](V0alpha2Api.md#admin_reject_o_auth2_logout_request) | **PUT** /admin/oauth2/auth/requests/logout/reject | Reject an OAuth 2.0 Logout Request |
41
- | [**admin_revoke_o_auth2_consent_sessions**](V0alpha2Api.md#admin_revoke_o_auth2_consent_sessions) | **DELETE** /admin/oauth2/auth/sessions/consent | Revokes OAuth 2.0 Consent Sessions of a Subject for a Specific OAuth 2.0 Client |
42
- | [**admin_revoke_o_auth2_login_sessions**](V0alpha2Api.md#admin_revoke_o_auth2_login_sessions) | **DELETE** /admin/oauth2/auth/sessions/login | Invalidates All OAuth 2.0 Login Sessions of a Certain User |
43
- | [**admin_trust_o_auth2_jwt_grant_issuer**](V0alpha2Api.md#admin_trust_o_auth2_jwt_grant_issuer) | **POST** /admin/trust/grants/jwt-bearer/issuers | Trust an OAuth2 JWT Bearer Grant Type Issuer |
44
16
  | [**admin_update_identity**](V0alpha2Api.md#admin_update_identity) | **PUT** /admin/identities/{id} | Update an Identity |
45
- | [**admin_update_json_web_key**](V0alpha2Api.md#admin_update_json_web_key) | **PUT** /admin/keys/{set}/{kid} | Update a JSON Web Key |
46
- | [**admin_update_json_web_key_set**](V0alpha2Api.md#admin_update_json_web_key_set) | **PUT** /admin/keys/{set} | Update a JSON Web Key Set |
47
- | [**admin_update_o_auth2_client**](V0alpha2Api.md#admin_update_o_auth2_client) | **PUT** /admin/clients/{id} | Update an OAuth 2.0 Client |
48
- | [**create_project**](V0alpha2Api.md#create_project) | **POST** /projects | Create a Project |
17
+ | [**create_project**](V0alpha2Api.md#create_project) | **POST** /projects | # Create a Project |
18
+ | [**create_project_api_key**](V0alpha2Api.md#create_project_api_key) | **POST** /projects/{project}/tokens | # Create API Token |
49
19
  | [**create_self_service_logout_flow_url_for_browsers**](V0alpha2Api.md#create_self_service_logout_flow_url_for_browsers) | **GET** /self-service/logout/browser | Create a Logout URL for Browsers |
50
- | [**discover_json_web_keys**](V0alpha2Api.md#discover_json_web_keys) | **GET** /.well-known/jwks.json | Discover JSON Web Keys |
51
- | [**discover_oidc_configuration**](V0alpha2Api.md#discover_oidc_configuration) | **GET** /.well-known/openid-configuration | OpenID Connect Discovery |
52
- | [**dynamic_client_registration_create_o_auth2_client**](V0alpha2Api.md#dynamic_client_registration_create_o_auth2_client) | **POST** /oauth2/register | Register an OAuth 2.0 Client using the OpenID / OAuth2 Dynamic Client Registration Management Protocol |
53
- | [**dynamic_client_registration_delete_o_auth2_client**](V0alpha2Api.md#dynamic_client_registration_delete_o_auth2_client) | **DELETE** /oauth2/register/{id} | Deletes an OAuth 2.0 Client using the OpenID / OAuth2 Dynamic Client Registration Management Protocol |
54
- | [**dynamic_client_registration_get_o_auth2_client**](V0alpha2Api.md#dynamic_client_registration_get_o_auth2_client) | **GET** /oauth2/register/{id} | Get an OAuth 2.0 Client using the OpenID / OAuth2 Dynamic Client Registration Management Protocol |
55
- | [**dynamic_client_registration_update_o_auth2_client**](V0alpha2Api.md#dynamic_client_registration_update_o_auth2_client) | **PUT** /oauth2/register/{id} | Update an OAuth 2.0 Client using the OpenID / OAuth2 Dynamic Client Registration Management Protocol |
20
+ | [**delete_project_api_key**](V0alpha2Api.md#delete_project_api_key) | **DELETE** /projects/{project}/tokens/{token_id} | # Delete API Token |
56
21
  | [**get_identity_schema**](V0alpha2Api.md#get_identity_schema) | **GET** /schemas/{id} | |
57
- | [**get_oidc_user_info**](V0alpha2Api.md#get_oidc_user_info) | **GET** /userinfo | OpenID Connect Userinfo |
58
- | [**get_project**](V0alpha2Api.md#get_project) | **GET** /projects/{project_id} | Get a Project |
22
+ | [**get_project**](V0alpha2Api.md#get_project) | **GET** /projects/{project_id} | # Get a Project |
59
23
  | [**get_project_members**](V0alpha2Api.md#get_project_members) | **GET** /projects/{project_id}/members | Get all members associated with this project. |
60
24
  | [**get_self_service_error**](V0alpha2Api.md#get_self_service_error) | **GET** /self-service/errors | Get Self-Service Errors |
61
25
  | [**get_self_service_login_flow**](V0alpha2Api.md#get_self_service_login_flow) | **GET** /self-service/login/flows | Get Login Flow |
62
26
  | [**get_self_service_recovery_flow**](V0alpha2Api.md#get_self_service_recovery_flow) | **GET** /self-service/recovery/flows | Get Recovery Flow |
63
27
  | [**get_self_service_registration_flow**](V0alpha2Api.md#get_self_service_registration_flow) | **GET** /self-service/registration/flows | Get Registration Flow |
64
28
  | [**get_self_service_settings_flow**](V0alpha2Api.md#get_self_service_settings_flow) | **GET** /self-service/settings/flows | Get Settings Flow |
65
- | [**get_self_service_verification_flow**](V0alpha2Api.md#get_self_service_verification_flow) | **GET** /self-service/verification/flows | Get Verification Flow |
29
+ | [**get_self_service_verification_flow**](V0alpha2Api.md#get_self_service_verification_flow) | **GET** /self-service/verification/flows | # Get Verification Flow |
66
30
  | [**get_web_authn_java_script**](V0alpha2Api.md#get_web_authn_java_script) | **GET** /.well-known/ory/webauthn.js | Get WebAuthn JavaScript |
67
31
  | [**initialize_self_service_login_flow_for_browsers**](V0alpha2Api.md#initialize_self_service_login_flow_for_browsers) | **GET** /self-service/login/browser | Initialize Login Flow for Browsers |
68
32
  | [**initialize_self_service_login_flow_without_browser**](V0alpha2Api.md#initialize_self_service_login_flow_without_browser) | **GET** /self-service/login/api | Initialize Login Flow for APIs, Services, Apps, ... |
@@ -75,15 +39,12 @@ All URIs are relative to *https://playground.projects.oryapis.com*
75
39
  | [**initialize_self_service_verification_flow_for_browsers**](V0alpha2Api.md#initialize_self_service_verification_flow_for_browsers) | **GET** /self-service/verification/browser | Initialize Verification Flow for Browser Clients |
76
40
  | [**initialize_self_service_verification_flow_without_browser**](V0alpha2Api.md#initialize_self_service_verification_flow_without_browser) | **GET** /self-service/verification/api | Initialize Verification Flow for APIs, Services, Apps, ... |
77
41
  | [**list_identity_schemas**](V0alpha2Api.md#list_identity_schemas) | **GET** /schemas | |
78
- | [**list_projects**](V0alpha2Api.md#list_projects) | **GET** /projects | List All Projects |
42
+ | [**list_project_api_keys**](V0alpha2Api.md#list_project_api_keys) | **GET** /projects/{project}/tokens | # List a Project's API Tokens |
43
+ | [**list_projects**](V0alpha2Api.md#list_projects) | **GET** /projects | # List All Projects |
79
44
  | [**list_sessions**](V0alpha2Api.md#list_sessions) | **GET** /sessions | This endpoints returns all other active sessions that belong to the logged-in user. The current session can be retrieved by calling the `/sessions/whoami` endpoint. |
80
45
  | [**patch_project**](V0alpha2Api.md#patch_project) | **PATCH** /projects/{project_id} | Patch an Ory Cloud Project Configuration` |
81
- | [**perform_o_auth2_authorization_flow**](V0alpha2Api.md#perform_o_auth2_authorization_flow) | **GET** /oauth2/auth | The OAuth 2.0 Authorize Endpoint |
82
- | [**perform_o_auth2_token_flow**](V0alpha2Api.md#perform_o_auth2_token_flow) | **POST** /oauth2/token | The OAuth 2.0 Token Endpoint |
83
- | [**perform_oidc_front_or_back_channel_logout**](V0alpha2Api.md#perform_oidc_front_or_back_channel_logout) | **GET** /oauth2/sessions/logout | OpenID Connect Front- or Back-channel Enabled Logout |
84
- | [**purge_project**](V0alpha2Api.md#purge_project) | **DELETE** /projects/{project_id} | Irrecoverably Purge a Project |
46
+ | [**purge_project**](V0alpha2Api.md#purge_project) | **DELETE** /projects/{project_id} | # Irrecoverably Purge a Project |
85
47
  | [**remove_project_member**](V0alpha2Api.md#remove_project_member) | **DELETE** /projects/{project_id}/members/{member_id} | Remove a member associated with this project. This also sets their invite status to `REMOVED`. |
86
- | [**revoke_o_auth2_token**](V0alpha2Api.md#revoke_o_auth2_token) | **POST** /oauth2/revoke | Revoke an OAuth2 Access or Refresh Token |
87
48
  | [**revoke_session**](V0alpha2Api.md#revoke_session) | **DELETE** /sessions/{id} | Calling this endpoint invalidates the specified session. The current session cannot be revoked. Session data are not deleted. |
88
49
  | [**revoke_sessions**](V0alpha2Api.md#revoke_sessions) | **DELETE** /sessions | Calling this endpoint invalidates all except the current session that belong to the logged-in user. Session data are not deleted. |
89
50
  | [**submit_self_service_login_flow**](V0alpha2Api.md#submit_self_service_login_flow) | **POST** /self-service/login | Submit a Login Flow |
@@ -92,18 +53,18 @@ All URIs are relative to *https://playground.projects.oryapis.com*
92
53
  | [**submit_self_service_recovery_flow**](V0alpha2Api.md#submit_self_service_recovery_flow) | **POST** /self-service/recovery | Complete Recovery Flow |
93
54
  | [**submit_self_service_registration_flow**](V0alpha2Api.md#submit_self_service_registration_flow) | **POST** /self-service/registration | Submit a Registration Flow |
94
55
  | [**submit_self_service_settings_flow**](V0alpha2Api.md#submit_self_service_settings_flow) | **POST** /self-service/settings | Complete Settings Flow |
95
- | [**submit_self_service_verification_flow**](V0alpha2Api.md#submit_self_service_verification_flow) | **POST** /self-service/verification | Complete Verification Flow |
56
+ | [**submit_self_service_verification_flow**](V0alpha2Api.md#submit_self_service_verification_flow) | **POST** /self-service/verification | # Complete Verification Flow |
96
57
  | [**to_session**](V0alpha2Api.md#to_session) | **GET** /sessions/whoami | Check Who the Current HTTP Session Belongs To |
97
- | [**update_project**](V0alpha2Api.md#update_project) | **PUT** /projects/{project_id} | Update an Ory Cloud Project Configuration |
58
+ | [**update_project**](V0alpha2Api.md#update_project) | **PUT** /projects/{project_id} | # Update an Ory Cloud Project Configuration |
98
59
 
99
60
 
100
- ## admin_accept_o_auth2_consent_request
61
+ ## admin_create_identity
101
62
 
102
- > <SuccessfulOAuth2RequestResponse> admin_accept_o_auth2_consent_request(consent_challenge, opts)
63
+ > <Identity> admin_create_identity(opts)
103
64
 
104
- Accept an OAuth 2.0 Consent Request
65
+ Create an Identity
105
66
 
106
- When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider to authenticate the subject and then tell ORY Hydra now about it. If the subject authenticated, he/she must now be asked if the OAuth 2.0 Client which initiated the flow should be allowed to access the resources on the subject's behalf. The consent provider which handles this request and is a web app implemented and hosted by you. It shows a subject interface which asks the subject to grant or deny the client access to the requested scope (\"Application my-dropbox-app wants write access to all your private files\"). The consent challenge is appended to the consent provider's URL to which the subject's user-agent (browser) is redirected to. The consent provider uses that challenge to fetch information on the OAuth2 request and then tells ORY Hydra if the subject accepted or rejected the request. This endpoint tells ORY Hydra that the subject has authorized the OAuth 2.0 client to access resources on his/her behalf. The consent provider includes additional information, such as session data for access and ID tokens, and if the consent request should be used as basis for future requests. The response contains a redirect URL which the consent provider should redirect the user-agent to.
67
+ This endpoint creates an identity. Learn how identities work in [Ory Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
107
68
 
108
69
  ### Examples
109
70
 
@@ -117,35 +78,34 @@ OryClient.configure do |config|
117
78
  end
118
79
 
119
80
  api_instance = OryClient::V0alpha2Api.new
120
- consent_challenge = 'consent_challenge_example' # String |
121
81
  opts = {
122
- accept_o_auth2_consent_request: OryClient::AcceptOAuth2ConsentRequest.new # AcceptOAuth2ConsentRequest |
82
+ admin_create_identity_body: OryClient::AdminCreateIdentityBody.new({schema_id: 'schema_id_example', traits: 3.56}) # AdminCreateIdentityBody |
123
83
  }
124
84
 
125
85
  begin
126
- # Accept an OAuth 2.0 Consent Request
127
- result = api_instance.admin_accept_o_auth2_consent_request(consent_challenge, opts)
86
+ # Create an Identity
87
+ result = api_instance.admin_create_identity(opts)
128
88
  p result
129
89
  rescue OryClient::ApiError => e
130
- puts "Error when calling V0alpha2Api->admin_accept_o_auth2_consent_request: #{e}"
90
+ puts "Error when calling V0alpha2Api->admin_create_identity: #{e}"
131
91
  end
132
92
  ```
133
93
 
134
- #### Using the admin_accept_o_auth2_consent_request_with_http_info variant
94
+ #### Using the admin_create_identity_with_http_info variant
135
95
 
136
96
  This returns an Array which contains the response data, status code and headers.
137
97
 
138
- > <Array(<SuccessfulOAuth2RequestResponse>, Integer, Hash)> admin_accept_o_auth2_consent_request_with_http_info(consent_challenge, opts)
98
+ > <Array(<Identity>, Integer, Hash)> admin_create_identity_with_http_info(opts)
139
99
 
140
100
  ```ruby
141
101
  begin
142
- # Accept an OAuth 2.0 Consent Request
143
- data, status_code, headers = api_instance.admin_accept_o_auth2_consent_request_with_http_info(consent_challenge, opts)
102
+ # Create an Identity
103
+ data, status_code, headers = api_instance.admin_create_identity_with_http_info(opts)
144
104
  p status_code # => 2xx
145
105
  p headers # => { ... }
146
- p data # => <SuccessfulOAuth2RequestResponse>
106
+ p data # => <Identity>
147
107
  rescue OryClient::ApiError => e
148
- puts "Error when calling V0alpha2Api->admin_accept_o_auth2_consent_request_with_http_info: #{e}"
108
+ puts "Error when calling V0alpha2Api->admin_create_identity_with_http_info: #{e}"
149
109
  end
150
110
  ```
151
111
 
@@ -153,12 +113,11 @@ end
153
113
 
154
114
  | Name | Type | Description | Notes |
155
115
  | ---- | ---- | ----------- | ----- |
156
- | **consent_challenge** | **String** | | |
157
- | **accept_o_auth2_consent_request** | [**AcceptOAuth2ConsentRequest**](AcceptOAuth2ConsentRequest.md) | | [optional] |
116
+ | **admin_create_identity_body** | [**AdminCreateIdentityBody**](AdminCreateIdentityBody.md) | | [optional] |
158
117
 
159
118
  ### Return type
160
119
 
161
- [**SuccessfulOAuth2RequestResponse**](SuccessfulOAuth2RequestResponse.md)
120
+ [**Identity**](Identity.md)
162
121
 
163
122
  ### Authorization
164
123
 
@@ -170,13 +129,13 @@ end
170
129
  - **Accept**: application/json
171
130
 
172
131
 
173
- ## admin_accept_o_auth2_login_request
132
+ ## admin_create_self_service_recovery_link
174
133
 
175
- > <SuccessfulOAuth2RequestResponse> admin_accept_o_auth2_login_request(login_challenge, opts)
134
+ > <SelfServiceRecoveryLink> admin_create_self_service_recovery_link(opts)
176
135
 
177
- Accept an OAuth 2.0 Login Request
136
+ Create a Recovery Link
178
137
 
179
- When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, Ory Hydra asks the login provider (sometimes called \"identity provider\") to authenticate the subject and then tell Ory Hydra now about it. The login provider is an web-app you write and host, and it must be able to authenticate (\"show the subject a login screen\") a subject (in OAuth2 the proper name for subject is \"resource owner\"). The authentication challenge is appended to the login provider URL to which the subject's user-agent (browser) is redirected to. The login provider uses that challenge to fetch information on the OAuth2 request and then accept or reject the requested authentication process. This endpoint tells ORY Hydra that the subject has successfully authenticated and includes additional information such as the subject's ID and if ORY Hydra should remember the subject's subject agent for future authentication attempts by setting a cookie. The response contains a redirect URL which the login provider should redirect the user-agent to.
138
+ This endpoint creates a recovery link which should be given to the user in order for them to recover (or activate) their account.
180
139
 
181
140
  ### Examples
182
141
 
@@ -190,35 +149,34 @@ OryClient.configure do |config|
190
149
  end
191
150
 
192
151
  api_instance = OryClient::V0alpha2Api.new
193
- login_challenge = 'login_challenge_example' # String |
194
152
  opts = {
195
- accept_o_auth2_login_request: OryClient::AcceptOAuth2LoginRequest.new({subject: 'subject_example'}) # AcceptOAuth2LoginRequest |
153
+ admin_create_self_service_recovery_link_body: OryClient::AdminCreateSelfServiceRecoveryLinkBody.new({identity_id: 'identity_id_example'}) # AdminCreateSelfServiceRecoveryLinkBody |
196
154
  }
197
155
 
198
156
  begin
199
- # Accept an OAuth 2.0 Login Request
200
- result = api_instance.admin_accept_o_auth2_login_request(login_challenge, opts)
157
+ # Create a Recovery Link
158
+ result = api_instance.admin_create_self_service_recovery_link(opts)
201
159
  p result
202
160
  rescue OryClient::ApiError => e
203
- puts "Error when calling V0alpha2Api->admin_accept_o_auth2_login_request: #{e}"
161
+ puts "Error when calling V0alpha2Api->admin_create_self_service_recovery_link: #{e}"
204
162
  end
205
163
  ```
206
164
 
207
- #### Using the admin_accept_o_auth2_login_request_with_http_info variant
165
+ #### Using the admin_create_self_service_recovery_link_with_http_info variant
208
166
 
209
167
  This returns an Array which contains the response data, status code and headers.
210
168
 
211
- > <Array(<SuccessfulOAuth2RequestResponse>, Integer, Hash)> admin_accept_o_auth2_login_request_with_http_info(login_challenge, opts)
169
+ > <Array(<SelfServiceRecoveryLink>, Integer, Hash)> admin_create_self_service_recovery_link_with_http_info(opts)
212
170
 
213
171
  ```ruby
214
172
  begin
215
- # Accept an OAuth 2.0 Login Request
216
- data, status_code, headers = api_instance.admin_accept_o_auth2_login_request_with_http_info(login_challenge, opts)
173
+ # Create a Recovery Link
174
+ data, status_code, headers = api_instance.admin_create_self_service_recovery_link_with_http_info(opts)
217
175
  p status_code # => 2xx
218
176
  p headers # => { ... }
219
- p data # => <SuccessfulOAuth2RequestResponse>
177
+ p data # => <SelfServiceRecoveryLink>
220
178
  rescue OryClient::ApiError => e
221
- puts "Error when calling V0alpha2Api->admin_accept_o_auth2_login_request_with_http_info: #{e}"
179
+ puts "Error when calling V0alpha2Api->admin_create_self_service_recovery_link_with_http_info: #{e}"
222
180
  end
223
181
  ```
224
182
 
@@ -226,12 +184,11 @@ end
226
184
 
227
185
  | Name | Type | Description | Notes |
228
186
  | ---- | ---- | ----------- | ----- |
229
- | **login_challenge** | **String** | | |
230
- | **accept_o_auth2_login_request** | [**AcceptOAuth2LoginRequest**](AcceptOAuth2LoginRequest.md) | | [optional] |
187
+ | **admin_create_self_service_recovery_link_body** | [**AdminCreateSelfServiceRecoveryLinkBody**](AdminCreateSelfServiceRecoveryLinkBody.md) | | [optional] |
231
188
 
232
189
  ### Return type
233
190
 
234
- [**SuccessfulOAuth2RequestResponse**](SuccessfulOAuth2RequestResponse.md)
191
+ [**SelfServiceRecoveryLink**](SelfServiceRecoveryLink.md)
235
192
 
236
193
  ### Authorization
237
194
 
@@ -243,13 +200,13 @@ end
243
200
  - **Accept**: application/json
244
201
 
245
202
 
246
- ## admin_accept_o_auth2_logout_request
203
+ ## admin_delete_identity
247
204
 
248
- > <SuccessfulOAuth2RequestResponse> admin_accept_o_auth2_logout_request(logout_challenge)
205
+ > admin_delete_identity(id)
249
206
 
250
- Accept an OAuth 2.0 Logout Request
207
+ Delete an Identity
251
208
 
252
- When a user or an application requests ORY Hydra to log out a user, this endpoint is used to confirm that logout request. The response contains a redirect URL which the consent provider should redirect the user-agent to.
209
+ Calling this endpoint irrecoverably and permanently deletes the identity given its ID. This action can not be undone. This endpoint returns 204 when the identity was deleted or when the identity was not found, in which case it is assumed that is has been deleted already. Learn how identities work in [Ory Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
253
210
 
254
211
  ### Examples
255
212
 
@@ -263,32 +220,31 @@ OryClient.configure do |config|
263
220
  end
264
221
 
265
222
  api_instance = OryClient::V0alpha2Api.new
266
- logout_challenge = 'logout_challenge_example' # String |
223
+ id = 'id_example' # String | ID is the identity's ID.
267
224
 
268
225
  begin
269
- # Accept an OAuth 2.0 Logout Request
270
- result = api_instance.admin_accept_o_auth2_logout_request(logout_challenge)
271
- p result
226
+ # Delete an Identity
227
+ api_instance.admin_delete_identity(id)
272
228
  rescue OryClient::ApiError => e
273
- puts "Error when calling V0alpha2Api->admin_accept_o_auth2_logout_request: #{e}"
229
+ puts "Error when calling V0alpha2Api->admin_delete_identity: #{e}"
274
230
  end
275
231
  ```
276
232
 
277
- #### Using the admin_accept_o_auth2_logout_request_with_http_info variant
233
+ #### Using the admin_delete_identity_with_http_info variant
278
234
 
279
- This returns an Array which contains the response data, status code and headers.
235
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
280
236
 
281
- > <Array(<SuccessfulOAuth2RequestResponse>, Integer, Hash)> admin_accept_o_auth2_logout_request_with_http_info(logout_challenge)
237
+ > <Array(nil, Integer, Hash)> admin_delete_identity_with_http_info(id)
282
238
 
283
239
  ```ruby
284
240
  begin
285
- # Accept an OAuth 2.0 Logout Request
286
- data, status_code, headers = api_instance.admin_accept_o_auth2_logout_request_with_http_info(logout_challenge)
241
+ # Delete an Identity
242
+ data, status_code, headers = api_instance.admin_delete_identity_with_http_info(id)
287
243
  p status_code # => 2xx
288
244
  p headers # => { ... }
289
- p data # => <SuccessfulOAuth2RequestResponse>
245
+ p data # => nil
290
246
  rescue OryClient::ApiError => e
291
- puts "Error when calling V0alpha2Api->admin_accept_o_auth2_logout_request_with_http_info: #{e}"
247
+ puts "Error when calling V0alpha2Api->admin_delete_identity_with_http_info: #{e}"
292
248
  end
293
249
  ```
294
250
 
@@ -296,11 +252,11 @@ end
296
252
 
297
253
  | Name | Type | Description | Notes |
298
254
  | ---- | ---- | ----------- | ----- |
299
- | **logout_challenge** | **String** | | |
255
+ | **id** | **String** | ID is the identity&#39;s ID. | |
300
256
 
301
257
  ### Return type
302
258
 
303
- [**SuccessfulOAuth2RequestResponse**](SuccessfulOAuth2RequestResponse.md)
259
+ nil (empty response body)
304
260
 
305
261
  ### Authorization
306
262
 
@@ -312,13 +268,13 @@ end
312
268
  - **Accept**: application/json
313
269
 
314
270
 
315
- ## admin_create_identity
271
+ ## admin_delete_identity_sessions
316
272
 
317
- > <Identity> admin_create_identity(opts)
273
+ > admin_delete_identity_sessions(id)
318
274
 
319
- Create an Identity
275
+ Calling this endpoint irrecoverably and permanently deletes and invalidates all sessions that belong to the given Identity.
320
276
 
321
- This endpoint creates an identity. Learn how identities work in [Ory Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
277
+ This endpoint is useful for: To forcefully logout Identity from all devices and sessions
322
278
 
323
279
  ### Examples
324
280
 
@@ -332,34 +288,31 @@ OryClient.configure do |config|
332
288
  end
333
289
 
334
290
  api_instance = OryClient::V0alpha2Api.new
335
- opts = {
336
- admin_create_identity_body: OryClient::AdminCreateIdentityBody.new({schema_id: 'schema_id_example', traits: 3.56}) # AdminCreateIdentityBody |
337
- }
291
+ id = 'id_example' # String | ID is the identity's ID.
338
292
 
339
293
  begin
340
- # Create an Identity
341
- result = api_instance.admin_create_identity(opts)
342
- p result
294
+ # Calling this endpoint irrecoverably and permanently deletes and invalidates all sessions that belong to the given Identity.
295
+ api_instance.admin_delete_identity_sessions(id)
343
296
  rescue OryClient::ApiError => e
344
- puts "Error when calling V0alpha2Api->admin_create_identity: #{e}"
297
+ puts "Error when calling V0alpha2Api->admin_delete_identity_sessions: #{e}"
345
298
  end
346
299
  ```
347
300
 
348
- #### Using the admin_create_identity_with_http_info variant
301
+ #### Using the admin_delete_identity_sessions_with_http_info variant
349
302
 
350
- This returns an Array which contains the response data, status code and headers.
303
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
351
304
 
352
- > <Array(<Identity>, Integer, Hash)> admin_create_identity_with_http_info(opts)
305
+ > <Array(nil, Integer, Hash)> admin_delete_identity_sessions_with_http_info(id)
353
306
 
354
307
  ```ruby
355
308
  begin
356
- # Create an Identity
357
- data, status_code, headers = api_instance.admin_create_identity_with_http_info(opts)
309
+ # Calling this endpoint irrecoverably and permanently deletes and invalidates all sessions that belong to the given Identity.
310
+ data, status_code, headers = api_instance.admin_delete_identity_sessions_with_http_info(id)
358
311
  p status_code # => 2xx
359
312
  p headers # => { ... }
360
- p data # => <Identity>
313
+ p data # => nil
361
314
  rescue OryClient::ApiError => e
362
- puts "Error when calling V0alpha2Api->admin_create_identity_with_http_info: #{e}"
315
+ puts "Error when calling V0alpha2Api->admin_delete_identity_sessions_with_http_info: #{e}"
363
316
  end
364
317
  ```
365
318
 
@@ -367,11 +320,11 @@ end
367
320
 
368
321
  | Name | Type | Description | Notes |
369
322
  | ---- | ---- | ----------- | ----- |
370
- | **admin_create_identity_body** | [**AdminCreateIdentityBody**](AdminCreateIdentityBody.md) | | [optional] |
323
+ | **id** | **String** | ID is the identity&#39;s ID. | |
371
324
 
372
325
  ### Return type
373
326
 
374
- [**Identity**](Identity.md)
327
+ nil (empty response body)
375
328
 
376
329
  ### Authorization
377
330
 
@@ -379,17 +332,17 @@ end
379
332
 
380
333
  ### HTTP request headers
381
334
 
382
- - **Content-Type**: application/json
335
+ - **Content-Type**: Not defined
383
336
  - **Accept**: application/json
384
337
 
385
338
 
386
- ## admin_create_json_web_key_set
339
+ ## admin_extend_session
387
340
 
388
- > <JsonWebKeySet> admin_create_json_web_key_set(set, admin_create_json_web_key_set_body)
341
+ > <Session> admin_extend_session(id)
389
342
 
390
- Generate a New JSON Web Key
343
+ Calling this endpoint extends the given session ID. If `session.earliest_possible_extend` is set it will only extend the session after the specified time has passed.
391
344
 
392
- This endpoint is capable of generating JSON Web Key Sets for you. There a different strategies available, such as symmetric cryptographic keys (HS256, HS512) and asymetric cryptographic keys (RS256, ECDSA). If the specified JSON Web Key Set does not exist, it will be created. A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing user-defined keys as well.
345
+ Retrieve the session ID from the `/sessions/whoami` endpoint / `toSession` SDK method.
393
346
 
394
347
  ### Examples
395
348
 
@@ -403,33 +356,32 @@ OryClient.configure do |config|
403
356
  end
404
357
 
405
358
  api_instance = OryClient::V0alpha2Api.new
406
- set = 'set_example' # String | The JSON Web Key Set
407
- admin_create_json_web_key_set_body = OryClient::AdminCreateJsonWebKeySetBody.new({alg: 'alg_example', kid: 'kid_example', use: 'use_example'}) # AdminCreateJsonWebKeySetBody |
359
+ id = 'id_example' # String | ID is the session's ID.
408
360
 
409
361
  begin
410
- # Generate a New JSON Web Key
411
- result = api_instance.admin_create_json_web_key_set(set, admin_create_json_web_key_set_body)
362
+ # Calling this endpoint extends the given session ID. If `session.earliest_possible_extend` is set it will only extend the session after the specified time has passed.
363
+ result = api_instance.admin_extend_session(id)
412
364
  p result
413
365
  rescue OryClient::ApiError => e
414
- puts "Error when calling V0alpha2Api->admin_create_json_web_key_set: #{e}"
366
+ puts "Error when calling V0alpha2Api->admin_extend_session: #{e}"
415
367
  end
416
368
  ```
417
369
 
418
- #### Using the admin_create_json_web_key_set_with_http_info variant
370
+ #### Using the admin_extend_session_with_http_info variant
419
371
 
420
372
  This returns an Array which contains the response data, status code and headers.
421
373
 
422
- > <Array(<JsonWebKeySet>, Integer, Hash)> admin_create_json_web_key_set_with_http_info(set, admin_create_json_web_key_set_body)
374
+ > <Array(<Session>, Integer, Hash)> admin_extend_session_with_http_info(id)
423
375
 
424
376
  ```ruby
425
377
  begin
426
- # Generate a New JSON Web Key
427
- data, status_code, headers = api_instance.admin_create_json_web_key_set_with_http_info(set, admin_create_json_web_key_set_body)
378
+ # Calling this endpoint extends the given session ID. If `session.earliest_possible_extend` is set it will only extend the session after the specified time has passed.
379
+ data, status_code, headers = api_instance.admin_extend_session_with_http_info(id)
428
380
  p status_code # => 2xx
429
381
  p headers # => { ... }
430
- p data # => <JsonWebKeySet>
382
+ p data # => <Session>
431
383
  rescue OryClient::ApiError => e
432
- puts "Error when calling V0alpha2Api->admin_create_json_web_key_set_with_http_info: #{e}"
384
+ puts "Error when calling V0alpha2Api->admin_extend_session_with_http_info: #{e}"
433
385
  end
434
386
  ```
435
387
 
@@ -437,12 +389,11 @@ end
437
389
 
438
390
  | Name | Type | Description | Notes |
439
391
  | ---- | ---- | ----------- | ----- |
440
- | **set** | **String** | The JSON Web Key Set | |
441
- | **admin_create_json_web_key_set_body** | [**AdminCreateJsonWebKeySetBody**](AdminCreateJsonWebKeySetBody.md) | | |
392
+ | **id** | **String** | ID is the session&#39;s ID. | |
442
393
 
443
394
  ### Return type
444
395
 
445
- [**JsonWebKeySet**](JsonWebKeySet.md)
396
+ [**Session**](Session.md)
446
397
 
447
398
  ### Authorization
448
399
 
@@ -450,17 +401,17 @@ end
450
401
 
451
402
  ### HTTP request headers
452
403
 
453
- - **Content-Type**: application/json
404
+ - **Content-Type**: Not defined
454
405
  - **Accept**: application/json
455
406
 
456
407
 
457
- ## admin_create_o_auth2_client
408
+ ## admin_get_identity
458
409
 
459
- > <OAuth2Client> admin_create_o_auth2_client(o_auth2_client)
410
+ > <Identity> admin_get_identity(id, opts)
460
411
 
461
- Create an OAuth 2.0 Client
412
+ Get an Identity
462
413
 
463
- Create a new OAuth 2.0 client. If you pass `client_secret` the secret is used, otherwise a random secret is generated. The secret is echoed in the response. It is not possible to retrieve it later on. OAuth 2.0 clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are generated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities.
414
+ Learn how identities work in [Ory Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
464
415
 
465
416
  ### Examples
466
417
 
@@ -474,32 +425,35 @@ OryClient.configure do |config|
474
425
  end
475
426
 
476
427
  api_instance = OryClient::V0alpha2Api.new
477
- o_auth2_client = OryClient::OAuth2Client.new # OAuth2Client |
428
+ id = 'id_example' # String | ID must be set to the ID of identity you want to get
429
+ opts = {
430
+ include_credential: ['inner_example'] # Array<String> | DeclassifyCredentials will declassify one or more identity's credentials Currently, only `oidc` is supported. This will return the initial OAuth 2.0 Access, Refresh and (optionally) OpenID Connect ID Token.
431
+ }
478
432
 
479
433
  begin
480
- # Create an OAuth 2.0 Client
481
- result = api_instance.admin_create_o_auth2_client(o_auth2_client)
434
+ # Get an Identity
435
+ result = api_instance.admin_get_identity(id, opts)
482
436
  p result
483
437
  rescue OryClient::ApiError => e
484
- puts "Error when calling V0alpha2Api->admin_create_o_auth2_client: #{e}"
438
+ puts "Error when calling V0alpha2Api->admin_get_identity: #{e}"
485
439
  end
486
440
  ```
487
441
 
488
- #### Using the admin_create_o_auth2_client_with_http_info variant
442
+ #### Using the admin_get_identity_with_http_info variant
489
443
 
490
444
  This returns an Array which contains the response data, status code and headers.
491
445
 
492
- > <Array(<OAuth2Client>, Integer, Hash)> admin_create_o_auth2_client_with_http_info(o_auth2_client)
446
+ > <Array(<Identity>, Integer, Hash)> admin_get_identity_with_http_info(id, opts)
493
447
 
494
448
  ```ruby
495
449
  begin
496
- # Create an OAuth 2.0 Client
497
- data, status_code, headers = api_instance.admin_create_o_auth2_client_with_http_info(o_auth2_client)
450
+ # Get an Identity
451
+ data, status_code, headers = api_instance.admin_get_identity_with_http_info(id, opts)
498
452
  p status_code # => 2xx
499
453
  p headers # => { ... }
500
- p data # => <OAuth2Client>
454
+ p data # => <Identity>
501
455
  rescue OryClient::ApiError => e
502
- puts "Error when calling V0alpha2Api->admin_create_o_auth2_client_with_http_info: #{e}"
456
+ puts "Error when calling V0alpha2Api->admin_get_identity_with_http_info: #{e}"
503
457
  end
504
458
  ```
505
459
 
@@ -507,11 +461,12 @@ end
507
461
 
508
462
  | Name | Type | Description | Notes |
509
463
  | ---- | ---- | ----------- | ----- |
510
- | **o_auth2_client** | [**OAuth2Client**](OAuth2Client.md) | | |
464
+ | **id** | **String** | ID must be set to the ID of identity you want to get | |
465
+ | **include_credential** | [**Array&lt;String&gt;**](String.md) | DeclassifyCredentials will declassify one or more identity&#39;s credentials Currently, only &#x60;oidc&#x60; is supported. This will return the initial OAuth 2.0 Access, Refresh and (optionally) OpenID Connect ID Token. | [optional] |
511
466
 
512
467
  ### Return type
513
468
 
514
- [**OAuth2Client**](OAuth2Client.md)
469
+ [**Identity**](Identity.md)
515
470
 
516
471
  ### Authorization
517
472
 
@@ -519,17 +474,17 @@ end
519
474
 
520
475
  ### HTTP request headers
521
476
 
522
- - **Content-Type**: application/json
477
+ - **Content-Type**: Not defined
523
478
  - **Accept**: application/json
524
479
 
525
480
 
526
- ## admin_create_self_service_recovery_link
481
+ ## admin_list_identities
527
482
 
528
- > <SelfServiceRecoveryLink> admin_create_self_service_recovery_link(opts)
483
+ > <Array<Identity>> admin_list_identities(opts)
529
484
 
530
- Create a Recovery Link
485
+ List Identities
531
486
 
532
- This endpoint creates a recovery link which should be given to the user in order for them to recover (or activate) their account.
487
+ Lists all identities. Does not support search at the moment. Learn how identities work in [Ory Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
533
488
 
534
489
  ### Examples
535
490
 
@@ -544,33 +499,34 @@ end
544
499
 
545
500
  api_instance = OryClient::V0alpha2Api.new
546
501
  opts = {
547
- admin_create_self_service_recovery_link_body: OryClient::AdminCreateSelfServiceRecoveryLinkBody.new({identity_id: 'identity_id_example'}) # AdminCreateSelfServiceRecoveryLinkBody |
502
+ per_page: 789, # Integer | Items per Page This is the number of items per page.
503
+ page: 789 # Integer | Pagination Page This value is currently an integer, but it is not sequential. The value is not the page number, but a reference. The next page can be any number and some numbers might return an empty list. For example, page 2 might not follow after page 1. And even if page 3 and 5 exist, but page 4 might not exist.
548
504
  }
549
505
 
550
506
  begin
551
- # Create a Recovery Link
552
- result = api_instance.admin_create_self_service_recovery_link(opts)
507
+ # List Identities
508
+ result = api_instance.admin_list_identities(opts)
553
509
  p result
554
510
  rescue OryClient::ApiError => e
555
- puts "Error when calling V0alpha2Api->admin_create_self_service_recovery_link: #{e}"
511
+ puts "Error when calling V0alpha2Api->admin_list_identities: #{e}"
556
512
  end
557
513
  ```
558
514
 
559
- #### Using the admin_create_self_service_recovery_link_with_http_info variant
515
+ #### Using the admin_list_identities_with_http_info variant
560
516
 
561
517
  This returns an Array which contains the response data, status code and headers.
562
518
 
563
- > <Array(<SelfServiceRecoveryLink>, Integer, Hash)> admin_create_self_service_recovery_link_with_http_info(opts)
519
+ > <Array(<Array<Identity>>, Integer, Hash)> admin_list_identities_with_http_info(opts)
564
520
 
565
521
  ```ruby
566
522
  begin
567
- # Create a Recovery Link
568
- data, status_code, headers = api_instance.admin_create_self_service_recovery_link_with_http_info(opts)
523
+ # List Identities
524
+ data, status_code, headers = api_instance.admin_list_identities_with_http_info(opts)
569
525
  p status_code # => 2xx
570
526
  p headers # => { ... }
571
- p data # => <SelfServiceRecoveryLink>
527
+ p data # => <Array<Identity>>
572
528
  rescue OryClient::ApiError => e
573
- puts "Error when calling V0alpha2Api->admin_create_self_service_recovery_link_with_http_info: #{e}"
529
+ puts "Error when calling V0alpha2Api->admin_list_identities_with_http_info: #{e}"
574
530
  end
575
531
  ```
576
532
 
@@ -578,11 +534,12 @@ end
578
534
 
579
535
  | Name | Type | Description | Notes |
580
536
  | ---- | ---- | ----------- | ----- |
581
- | **admin_create_self_service_recovery_link_body** | [**AdminCreateSelfServiceRecoveryLinkBody**](AdminCreateSelfServiceRecoveryLinkBody.md) | | [optional] |
537
+ | **per_page** | **Integer** | Items per Page This is the number of items per page. | [optional][default to 250] |
538
+ | **page** | **Integer** | Pagination Page This value is currently an integer, but it is not sequential. The value is not the page number, but a reference. The next page can be any number and some numbers might return an empty list. For example, page 2 might not follow after page 1. And even if page 3 and 5 exist, but page 4 might not exist. | [optional][default to 1] |
582
539
 
583
540
  ### Return type
584
541
 
585
- [**SelfServiceRecoveryLink**](SelfServiceRecoveryLink.md)
542
+ [**Array&lt;Identity&gt;**](Identity.md)
586
543
 
587
544
  ### Authorization
588
545
 
@@ -590,17 +547,17 @@ end
590
547
 
591
548
  ### HTTP request headers
592
549
 
593
- - **Content-Type**: application/json
550
+ - **Content-Type**: Not defined
594
551
  - **Accept**: application/json
595
552
 
596
553
 
597
- ## admin_delete_identity
554
+ ## admin_list_identity_sessions
598
555
 
599
- > admin_delete_identity(id)
556
+ > <Array<Session>> admin_list_identity_sessions(id, opts)
600
557
 
601
- Delete an Identity
558
+ This endpoint returns all sessions that belong to the given Identity.
602
559
 
603
- Calling this endpoint irrecoverably and permanently deletes the identity given its ID. This action can not be undone. This endpoint returns 204 when the identity was deleted or when the identity was not found, in which case it is assumed that is has been deleted already. Learn how identities work in [Ory Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
560
+ This endpoint is useful for: Listing all sessions that belong to an Identity in an administrative context.
604
561
 
605
562
  ### Examples
606
563
 
@@ -615,30 +572,36 @@ end
615
572
 
616
573
  api_instance = OryClient::V0alpha2Api.new
617
574
  id = 'id_example' # String | ID is the identity's ID.
575
+ opts = {
576
+ per_page: 789, # Integer | Items per Page This is the number of items per page.
577
+ page: 789, # Integer | Pagination Page This value is currently an integer, but it is not sequential. The value is not the page number, but a reference. The next page can be any number and some numbers might return an empty list. For example, page 2 might not follow after page 1. And even if page 3 and 5 exist, but page 4 might not exist.
578
+ active: true # Boolean | Active is a boolean flag that filters out sessions based on the state. If no value is provided, all sessions are returned.
579
+ }
618
580
 
619
581
  begin
620
- # Delete an Identity
621
- api_instance.admin_delete_identity(id)
582
+ # This endpoint returns all sessions that belong to the given Identity.
583
+ result = api_instance.admin_list_identity_sessions(id, opts)
584
+ p result
622
585
  rescue OryClient::ApiError => e
623
- puts "Error when calling V0alpha2Api->admin_delete_identity: #{e}"
586
+ puts "Error when calling V0alpha2Api->admin_list_identity_sessions: #{e}"
624
587
  end
625
588
  ```
626
589
 
627
- #### Using the admin_delete_identity_with_http_info variant
590
+ #### Using the admin_list_identity_sessions_with_http_info variant
628
591
 
629
- This returns an Array which contains the response data (`nil` in this case), status code and headers.
592
+ This returns an Array which contains the response data, status code and headers.
630
593
 
631
- > <Array(nil, Integer, Hash)> admin_delete_identity_with_http_info(id)
594
+ > <Array(<Array<Session>>, Integer, Hash)> admin_list_identity_sessions_with_http_info(id, opts)
632
595
 
633
596
  ```ruby
634
597
  begin
635
- # Delete an Identity
636
- data, status_code, headers = api_instance.admin_delete_identity_with_http_info(id)
598
+ # This endpoint returns all sessions that belong to the given Identity.
599
+ data, status_code, headers = api_instance.admin_list_identity_sessions_with_http_info(id, opts)
637
600
  p status_code # => 2xx
638
601
  p headers # => { ... }
639
- p data # => nil
602
+ p data # => <Array<Session>>
640
603
  rescue OryClient::ApiError => e
641
- puts "Error when calling V0alpha2Api->admin_delete_identity_with_http_info: #{e}"
604
+ puts "Error when calling V0alpha2Api->admin_list_identity_sessions_with_http_info: #{e}"
642
605
  end
643
606
  ```
644
607
 
@@ -647,10 +610,13 @@ end
647
610
  | Name | Type | Description | Notes |
648
611
  | ---- | ---- | ----------- | ----- |
649
612
  | **id** | **String** | ID is the identity&#39;s ID. | |
613
+ | **per_page** | **Integer** | Items per Page This is the number of items per page. | [optional][default to 250] |
614
+ | **page** | **Integer** | Pagination Page This value is currently an integer, but it is not sequential. The value is not the page number, but a reference. The next page can be any number and some numbers might return an empty list. For example, page 2 might not follow after page 1. And even if page 3 and 5 exist, but page 4 might not exist. | [optional][default to 1] |
615
+ | **active** | **Boolean** | Active is a boolean flag that filters out sessions based on the state. If no value is provided, all sessions are returned. | [optional] |
650
616
 
651
617
  ### Return type
652
618
 
653
- nil (empty response body)
619
+ [**Array&lt;Session&gt;**](Session.md)
654
620
 
655
621
  ### Authorization
656
622
 
@@ -662,13 +628,13 @@ nil (empty response body)
662
628
  - **Accept**: application/json
663
629
 
664
630
 
665
- ## admin_delete_identity_sessions
631
+ ## admin_patch_identity
666
632
 
667
- > admin_delete_identity_sessions(id)
633
+ > <Identity> admin_patch_identity(id, opts)
668
634
 
669
- Calling this endpoint irrecoverably and permanently deletes and invalidates all sessions that belong to the given Identity.
635
+ Partially updates an Identity's field using [JSON Patch](https://jsonpatch.com/)
670
636
 
671
- This endpoint is useful for: To forcefully logout Identity from all devices and sessions
637
+ NOTE: The fields `id`, `stateChangedAt` and `credentials` are not updateable. Learn how identities work in [Ory Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
672
638
 
673
639
  ### Examples
674
640
 
@@ -682,31 +648,35 @@ OryClient.configure do |config|
682
648
  end
683
649
 
684
650
  api_instance = OryClient::V0alpha2Api.new
685
- id = 'id_example' # String | ID is the identity's ID.
651
+ id = 'id_example' # String | ID must be set to the ID of identity you want to update
652
+ opts = {
653
+ json_patch: [OryClient::JsonPatch.new({op: 'add', path: '/services/identity/config/smtp/from_name'})] # Array<JsonPatch> |
654
+ }
686
655
 
687
656
  begin
688
- # Calling this endpoint irrecoverably and permanently deletes and invalidates all sessions that belong to the given Identity.
689
- api_instance.admin_delete_identity_sessions(id)
657
+ # Partially updates an Identity's field using [JSON Patch](https://jsonpatch.com/)
658
+ result = api_instance.admin_patch_identity(id, opts)
659
+ p result
690
660
  rescue OryClient::ApiError => e
691
- puts "Error when calling V0alpha2Api->admin_delete_identity_sessions: #{e}"
661
+ puts "Error when calling V0alpha2Api->admin_patch_identity: #{e}"
692
662
  end
693
663
  ```
694
664
 
695
- #### Using the admin_delete_identity_sessions_with_http_info variant
665
+ #### Using the admin_patch_identity_with_http_info variant
696
666
 
697
- This returns an Array which contains the response data (`nil` in this case), status code and headers.
667
+ This returns an Array which contains the response data, status code and headers.
698
668
 
699
- > <Array(nil, Integer, Hash)> admin_delete_identity_sessions_with_http_info(id)
669
+ > <Array(<Identity>, Integer, Hash)> admin_patch_identity_with_http_info(id, opts)
700
670
 
701
671
  ```ruby
702
672
  begin
703
- # Calling this endpoint irrecoverably and permanently deletes and invalidates all sessions that belong to the given Identity.
704
- data, status_code, headers = api_instance.admin_delete_identity_sessions_with_http_info(id)
673
+ # Partially updates an Identity's field using [JSON Patch](https://jsonpatch.com/)
674
+ data, status_code, headers = api_instance.admin_patch_identity_with_http_info(id, opts)
705
675
  p status_code # => 2xx
706
676
  p headers # => { ... }
707
- p data # => nil
677
+ p data # => <Identity>
708
678
  rescue OryClient::ApiError => e
709
- puts "Error when calling V0alpha2Api->admin_delete_identity_sessions_with_http_info: #{e}"
679
+ puts "Error when calling V0alpha2Api->admin_patch_identity_with_http_info: #{e}"
710
680
  end
711
681
  ```
712
682
 
@@ -714,11 +684,12 @@ end
714
684
 
715
685
  | Name | Type | Description | Notes |
716
686
  | ---- | ---- | ----------- | ----- |
717
- | **id** | **String** | ID is the identity&#39;s ID. | |
687
+ | **id** | **String** | ID must be set to the ID of identity you want to update | |
688
+ | **json_patch** | [**Array&lt;JsonPatch&gt;**](JsonPatch.md) | | [optional] |
718
689
 
719
690
  ### Return type
720
691
 
721
- nil (empty response body)
692
+ [**Identity**](Identity.md)
722
693
 
723
694
  ### Authorization
724
695
 
@@ -726,17 +697,17 @@ nil (empty response body)
726
697
 
727
698
  ### HTTP request headers
728
699
 
729
- - **Content-Type**: Not defined
700
+ - **Content-Type**: application/json
730
701
  - **Accept**: application/json
731
702
 
732
703
 
733
- ## admin_delete_json_web_key
704
+ ## admin_update_identity
734
705
 
735
- > admin_delete_json_web_key(set, kid)
706
+ > <Identity> admin_update_identity(id, opts)
736
707
 
737
- Delete a JSON Web Key
708
+ Update an Identity
738
709
 
739
- Use this endpoint to delete a single JSON Web Key. A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing user-defined keys as well.
710
+ This endpoint updates an identity. The full identity payload (except credentials) is expected. This endpoint does not support patching. Learn how identities work in [Ory Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
740
711
 
741
712
  ### Examples
742
713
 
@@ -750,2390 +721,35 @@ OryClient.configure do |config|
750
721
  end
751
722
 
752
723
  api_instance = OryClient::V0alpha2Api.new
753
- set = 'set_example' # String | The JSON Web Key Set
754
- kid = 'kid_example' # String | The JSON Web Key ID (kid)
724
+ id = 'id_example' # String | ID must be set to the ID of identity you want to update
725
+ opts = {
726
+ admin_update_identity_body: OryClient::AdminUpdateIdentityBody.new({schema_id: 'schema_id_example', state: OryClient::IdentityState::ACTIVE, traits: 3.56}) # AdminUpdateIdentityBody |
727
+ }
755
728
 
756
729
  begin
757
- # Delete a JSON Web Key
758
- api_instance.admin_delete_json_web_key(set, kid)
759
- rescue OryClient::ApiError => e
760
- puts "Error when calling V0alpha2Api->admin_delete_json_web_key: #{e}"
761
- end
762
- ```
763
-
764
- #### Using the admin_delete_json_web_key_with_http_info variant
765
-
766
- This returns an Array which contains the response data (`nil` in this case), status code and headers.
767
-
768
- > <Array(nil, Integer, Hash)> admin_delete_json_web_key_with_http_info(set, kid)
769
-
770
- ```ruby
771
- begin
772
- # Delete a JSON Web Key
773
- data, status_code, headers = api_instance.admin_delete_json_web_key_with_http_info(set, kid)
774
- p status_code # => 2xx
775
- p headers # => { ... }
776
- p data # => nil
777
- rescue OryClient::ApiError => e
778
- puts "Error when calling V0alpha2Api->admin_delete_json_web_key_with_http_info: #{e}"
779
- end
780
- ```
781
-
782
- ### Parameters
783
-
784
- | Name | Type | Description | Notes |
785
- | ---- | ---- | ----------- | ----- |
786
- | **set** | **String** | The JSON Web Key Set | |
787
- | **kid** | **String** | The JSON Web Key ID (kid) | |
788
-
789
- ### Return type
790
-
791
- nil (empty response body)
792
-
793
- ### Authorization
794
-
795
- [oryAccessToken](../README.md#oryAccessToken)
796
-
797
- ### HTTP request headers
798
-
799
- - **Content-Type**: Not defined
800
- - **Accept**: application/json
801
-
802
-
803
- ## admin_delete_json_web_key_set
804
-
805
- > admin_delete_json_web_key_set(set)
806
-
807
- Delete a JSON Web Key Set
808
-
809
- Use this endpoint to delete a complete JSON Web Key Set and all the keys in that set. A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing user-defined keys as well.
810
-
811
- ### Examples
812
-
813
- ```ruby
814
- require 'time'
815
- require 'ory-client'
816
- # setup authorization
817
- OryClient.configure do |config|
818
- # Configure Bearer authorization: oryAccessToken
819
- config.access_token = 'YOUR_BEARER_TOKEN'
820
- end
821
-
822
- api_instance = OryClient::V0alpha2Api.new
823
- set = 'set_example' # String | The JSON Web Key Set
824
-
825
- begin
826
- # Delete a JSON Web Key Set
827
- api_instance.admin_delete_json_web_key_set(set)
828
- rescue OryClient::ApiError => e
829
- puts "Error when calling V0alpha2Api->admin_delete_json_web_key_set: #{e}"
830
- end
831
- ```
832
-
833
- #### Using the admin_delete_json_web_key_set_with_http_info variant
834
-
835
- This returns an Array which contains the response data (`nil` in this case), status code and headers.
836
-
837
- > <Array(nil, Integer, Hash)> admin_delete_json_web_key_set_with_http_info(set)
838
-
839
- ```ruby
840
- begin
841
- # Delete a JSON Web Key Set
842
- data, status_code, headers = api_instance.admin_delete_json_web_key_set_with_http_info(set)
843
- p status_code # => 2xx
844
- p headers # => { ... }
845
- p data # => nil
846
- rescue OryClient::ApiError => e
847
- puts "Error when calling V0alpha2Api->admin_delete_json_web_key_set_with_http_info: #{e}"
848
- end
849
- ```
850
-
851
- ### Parameters
852
-
853
- | Name | Type | Description | Notes |
854
- | ---- | ---- | ----------- | ----- |
855
- | **set** | **String** | The JSON Web Key Set | |
856
-
857
- ### Return type
858
-
859
- nil (empty response body)
860
-
861
- ### Authorization
862
-
863
- [oryAccessToken](../README.md#oryAccessToken)
864
-
865
- ### HTTP request headers
866
-
867
- - **Content-Type**: Not defined
868
- - **Accept**: application/json
869
-
870
-
871
- ## admin_delete_o_auth2_client
872
-
873
- > admin_delete_o_auth2_client(id)
874
-
875
- Deletes an OAuth 2.0 Client
876
-
877
- Delete an existing OAuth 2.0 Client by its ID. OAuth 2.0 clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are generated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities. Make sure that this endpoint is well protected and only callable by first-party components.
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::V0alpha2Api.new
891
- id = 'id_example' # String | The id of the OAuth 2.0 Client.
892
-
893
- begin
894
- # Deletes an OAuth 2.0 Client
895
- api_instance.admin_delete_o_auth2_client(id)
896
- rescue OryClient::ApiError => e
897
- puts "Error when calling V0alpha2Api->admin_delete_o_auth2_client: #{e}"
898
- end
899
- ```
900
-
901
- #### Using the admin_delete_o_auth2_client_with_http_info variant
902
-
903
- This returns an Array which contains the response data (`nil` in this case), status code and headers.
904
-
905
- > <Array(nil, Integer, Hash)> admin_delete_o_auth2_client_with_http_info(id)
906
-
907
- ```ruby
908
- begin
909
- # Deletes an OAuth 2.0 Client
910
- data, status_code, headers = api_instance.admin_delete_o_auth2_client_with_http_info(id)
911
- p status_code # => 2xx
912
- p headers # => { ... }
913
- p data # => nil
914
- rescue OryClient::ApiError => e
915
- puts "Error when calling V0alpha2Api->admin_delete_o_auth2_client_with_http_info: #{e}"
916
- end
917
- ```
918
-
919
- ### Parameters
920
-
921
- | Name | Type | Description | Notes |
922
- | ---- | ---- | ----------- | ----- |
923
- | **id** | **String** | The id of the OAuth 2.0 Client. | |
924
-
925
- ### Return type
926
-
927
- nil (empty response body)
928
-
929
- ### Authorization
930
-
931
- [oryAccessToken](../README.md#oryAccessToken)
932
-
933
- ### HTTP request headers
934
-
935
- - **Content-Type**: Not defined
936
- - **Accept**: application/json
937
-
938
-
939
- ## admin_delete_o_auth2_token
940
-
941
- > admin_delete_o_auth2_token(client_id)
942
-
943
- Delete OAuth2 Access Tokens from a Client
944
-
945
- This endpoint deletes OAuth2 access tokens issued for a client from the database
946
-
947
- ### Examples
948
-
949
- ```ruby
950
- require 'time'
951
- require 'ory-client'
952
- # setup authorization
953
- OryClient.configure do |config|
954
- # Configure Bearer authorization: oryAccessToken
955
- config.access_token = 'YOUR_BEARER_TOKEN'
956
- end
957
-
958
- api_instance = OryClient::V0alpha2Api.new
959
- client_id = 'client_id_example' # String |
960
-
961
- begin
962
- # Delete OAuth2 Access Tokens from a Client
963
- api_instance.admin_delete_o_auth2_token(client_id)
964
- rescue OryClient::ApiError => e
965
- puts "Error when calling V0alpha2Api->admin_delete_o_auth2_token: #{e}"
966
- end
967
- ```
968
-
969
- #### Using the admin_delete_o_auth2_token_with_http_info variant
970
-
971
- This returns an Array which contains the response data (`nil` in this case), status code and headers.
972
-
973
- > <Array(nil, Integer, Hash)> admin_delete_o_auth2_token_with_http_info(client_id)
974
-
975
- ```ruby
976
- begin
977
- # Delete OAuth2 Access Tokens from a Client
978
- data, status_code, headers = api_instance.admin_delete_o_auth2_token_with_http_info(client_id)
979
- p status_code # => 2xx
980
- p headers # => { ... }
981
- p data # => nil
982
- rescue OryClient::ApiError => e
983
- puts "Error when calling V0alpha2Api->admin_delete_o_auth2_token_with_http_info: #{e}"
984
- end
985
- ```
986
-
987
- ### Parameters
988
-
989
- | Name | Type | Description | Notes |
990
- | ---- | ---- | ----------- | ----- |
991
- | **client_id** | **String** | | |
992
-
993
- ### Return type
994
-
995
- nil (empty response body)
996
-
997
- ### Authorization
998
-
999
- [oryAccessToken](../README.md#oryAccessToken)
1000
-
1001
- ### HTTP request headers
1002
-
1003
- - **Content-Type**: Not defined
1004
- - **Accept**: application/json
1005
-
1006
-
1007
- ## admin_delete_trusted_o_auth2_jwt_grant_issuer
1008
-
1009
- > admin_delete_trusted_o_auth2_jwt_grant_issuer(id)
1010
-
1011
- Delete a Trusted OAuth2 JWT Bearer Grant Type Issuer
1012
-
1013
- Use this endpoint to delete trusted JWT Bearer Grant Type Issuer. The ID is the one returned when you created the trust relationship. Once deleted, the associated issuer will no longer be able to perform the JSON Web Token (JWT) Profile for OAuth 2.0 Client Authentication and Authorization Grant.
1014
-
1015
- ### Examples
1016
-
1017
- ```ruby
1018
- require 'time'
1019
- require 'ory-client'
1020
- # setup authorization
1021
- OryClient.configure do |config|
1022
- # Configure Bearer authorization: oryAccessToken
1023
- config.access_token = 'YOUR_BEARER_TOKEN'
1024
- end
1025
-
1026
- api_instance = OryClient::V0alpha2Api.new
1027
- id = 'id_example' # String | The id of the desired grant
1028
-
1029
- begin
1030
- # Delete a Trusted OAuth2 JWT Bearer Grant Type Issuer
1031
- api_instance.admin_delete_trusted_o_auth2_jwt_grant_issuer(id)
1032
- rescue OryClient::ApiError => e
1033
- puts "Error when calling V0alpha2Api->admin_delete_trusted_o_auth2_jwt_grant_issuer: #{e}"
1034
- end
1035
- ```
1036
-
1037
- #### Using the admin_delete_trusted_o_auth2_jwt_grant_issuer_with_http_info variant
1038
-
1039
- This returns an Array which contains the response data (`nil` in this case), status code and headers.
1040
-
1041
- > <Array(nil, Integer, Hash)> admin_delete_trusted_o_auth2_jwt_grant_issuer_with_http_info(id)
1042
-
1043
- ```ruby
1044
- begin
1045
- # Delete a Trusted OAuth2 JWT Bearer Grant Type Issuer
1046
- data, status_code, headers = api_instance.admin_delete_trusted_o_auth2_jwt_grant_issuer_with_http_info(id)
1047
- p status_code # => 2xx
1048
- p headers # => { ... }
1049
- p data # => nil
1050
- rescue OryClient::ApiError => e
1051
- puts "Error when calling V0alpha2Api->admin_delete_trusted_o_auth2_jwt_grant_issuer_with_http_info: #{e}"
1052
- end
1053
- ```
1054
-
1055
- ### Parameters
1056
-
1057
- | Name | Type | Description | Notes |
1058
- | ---- | ---- | ----------- | ----- |
1059
- | **id** | **String** | The id of the desired grant | |
1060
-
1061
- ### Return type
1062
-
1063
- nil (empty response body)
1064
-
1065
- ### Authorization
1066
-
1067
- [oryAccessToken](../README.md#oryAccessToken)
1068
-
1069
- ### HTTP request headers
1070
-
1071
- - **Content-Type**: Not defined
1072
- - **Accept**: application/json
1073
-
1074
-
1075
- ## admin_extend_session
1076
-
1077
- > <Session> admin_extend_session(id)
1078
-
1079
- Calling this endpoint extends the given session ID. If `session.earliest_possible_extend` is set it will only extend the session after the specified time has passed.
1080
-
1081
- Retrieve the session ID from the `/sessions/whoami` endpoint / `toSession` SDK method.
1082
-
1083
- ### Examples
1084
-
1085
- ```ruby
1086
- require 'time'
1087
- require 'ory-client'
1088
- # setup authorization
1089
- OryClient.configure do |config|
1090
- # Configure Bearer authorization: oryAccessToken
1091
- config.access_token = 'YOUR_BEARER_TOKEN'
1092
- end
1093
-
1094
- api_instance = OryClient::V0alpha2Api.new
1095
- id = 'id_example' # String | ID is the session's ID.
1096
-
1097
- begin
1098
- # Calling this endpoint extends the given session ID. If `session.earliest_possible_extend` is set it will only extend the session after the specified time has passed.
1099
- result = api_instance.admin_extend_session(id)
1100
- p result
1101
- rescue OryClient::ApiError => e
1102
- puts "Error when calling V0alpha2Api->admin_extend_session: #{e}"
1103
- end
1104
- ```
1105
-
1106
- #### Using the admin_extend_session_with_http_info variant
1107
-
1108
- This returns an Array which contains the response data, status code and headers.
1109
-
1110
- > <Array(<Session>, Integer, Hash)> admin_extend_session_with_http_info(id)
1111
-
1112
- ```ruby
1113
- begin
1114
- # Calling this endpoint extends the given session ID. If `session.earliest_possible_extend` is set it will only extend the session after the specified time has passed.
1115
- data, status_code, headers = api_instance.admin_extend_session_with_http_info(id)
1116
- p status_code # => 2xx
1117
- p headers # => { ... }
1118
- p data # => <Session>
1119
- rescue OryClient::ApiError => e
1120
- puts "Error when calling V0alpha2Api->admin_extend_session_with_http_info: #{e}"
1121
- end
1122
- ```
1123
-
1124
- ### Parameters
1125
-
1126
- | Name | Type | Description | Notes |
1127
- | ---- | ---- | ----------- | ----- |
1128
- | **id** | **String** | ID is the session&#39;s ID. | |
1129
-
1130
- ### Return type
1131
-
1132
- [**Session**](Session.md)
1133
-
1134
- ### Authorization
1135
-
1136
- [oryAccessToken](../README.md#oryAccessToken)
1137
-
1138
- ### HTTP request headers
1139
-
1140
- - **Content-Type**: Not defined
1141
- - **Accept**: application/json
1142
-
1143
-
1144
- ## admin_get_identity
1145
-
1146
- > <Identity> admin_get_identity(id, opts)
1147
-
1148
- Get an Identity
1149
-
1150
- Learn how identities work in [Ory Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
1151
-
1152
- ### Examples
1153
-
1154
- ```ruby
1155
- require 'time'
1156
- require 'ory-client'
1157
- # setup authorization
1158
- OryClient.configure do |config|
1159
- # Configure Bearer authorization: oryAccessToken
1160
- config.access_token = 'YOUR_BEARER_TOKEN'
1161
- end
1162
-
1163
- api_instance = OryClient::V0alpha2Api.new
1164
- id = 'id_example' # String | ID must be set to the ID of identity you want to get
1165
- opts = {
1166
- include_credential: ['inner_example'] # Array<String> | DeclassifyCredentials will declassify one or more identity's credentials Currently, only `oidc` is supported. This will return the initial OAuth 2.0 Access, Refresh and (optionally) OpenID Connect ID Token.
1167
- }
1168
-
1169
- begin
1170
- # Get an Identity
1171
- result = api_instance.admin_get_identity(id, opts)
1172
- p result
1173
- rescue OryClient::ApiError => e
1174
- puts "Error when calling V0alpha2Api->admin_get_identity: #{e}"
1175
- end
1176
- ```
1177
-
1178
- #### Using the admin_get_identity_with_http_info variant
1179
-
1180
- This returns an Array which contains the response data, status code and headers.
1181
-
1182
- > <Array(<Identity>, Integer, Hash)> admin_get_identity_with_http_info(id, opts)
1183
-
1184
- ```ruby
1185
- begin
1186
- # Get an Identity
1187
- data, status_code, headers = api_instance.admin_get_identity_with_http_info(id, opts)
1188
- p status_code # => 2xx
1189
- p headers # => { ... }
1190
- p data # => <Identity>
1191
- rescue OryClient::ApiError => e
1192
- puts "Error when calling V0alpha2Api->admin_get_identity_with_http_info: #{e}"
1193
- end
1194
- ```
1195
-
1196
- ### Parameters
1197
-
1198
- | Name | Type | Description | Notes |
1199
- | ---- | ---- | ----------- | ----- |
1200
- | **id** | **String** | ID must be set to the ID of identity you want to get | |
1201
- | **include_credential** | [**Array&lt;String&gt;**](String.md) | DeclassifyCredentials will declassify one or more identity&#39;s credentials Currently, only &#x60;oidc&#x60; is supported. This will return the initial OAuth 2.0 Access, Refresh and (optionally) OpenID Connect ID Token. | [optional] |
1202
-
1203
- ### Return type
1204
-
1205
- [**Identity**](Identity.md)
1206
-
1207
- ### Authorization
1208
-
1209
- [oryAccessToken](../README.md#oryAccessToken)
1210
-
1211
- ### HTTP request headers
1212
-
1213
- - **Content-Type**: Not defined
1214
- - **Accept**: application/json
1215
-
1216
-
1217
- ## admin_get_json_web_key
1218
-
1219
- > <JsonWebKeySet> admin_get_json_web_key(set, kid)
1220
-
1221
- Fetch a JSON Web Key
1222
-
1223
- This endpoint returns a singular JSON Web Key. It is identified by the set and the specific key ID (kid).
1224
-
1225
- ### Examples
1226
-
1227
- ```ruby
1228
- require 'time'
1229
- require 'ory-client'
1230
- # setup authorization
1231
- OryClient.configure do |config|
1232
- # Configure Bearer authorization: oryAccessToken
1233
- config.access_token = 'YOUR_BEARER_TOKEN'
1234
- end
1235
-
1236
- api_instance = OryClient::V0alpha2Api.new
1237
- set = 'set_example' # String | The JSON Web Key Set
1238
- kid = 'kid_example' # String | The JSON Web Key ID (kid)
1239
-
1240
- begin
1241
- # Fetch a JSON Web Key
1242
- result = api_instance.admin_get_json_web_key(set, kid)
1243
- p result
1244
- rescue OryClient::ApiError => e
1245
- puts "Error when calling V0alpha2Api->admin_get_json_web_key: #{e}"
1246
- end
1247
- ```
1248
-
1249
- #### Using the admin_get_json_web_key_with_http_info variant
1250
-
1251
- This returns an Array which contains the response data, status code and headers.
1252
-
1253
- > <Array(<JsonWebKeySet>, Integer, Hash)> admin_get_json_web_key_with_http_info(set, kid)
1254
-
1255
- ```ruby
1256
- begin
1257
- # Fetch a JSON Web Key
1258
- data, status_code, headers = api_instance.admin_get_json_web_key_with_http_info(set, kid)
1259
- p status_code # => 2xx
1260
- p headers # => { ... }
1261
- p data # => <JsonWebKeySet>
1262
- rescue OryClient::ApiError => e
1263
- puts "Error when calling V0alpha2Api->admin_get_json_web_key_with_http_info: #{e}"
1264
- end
1265
- ```
1266
-
1267
- ### Parameters
1268
-
1269
- | Name | Type | Description | Notes |
1270
- | ---- | ---- | ----------- | ----- |
1271
- | **set** | **String** | The JSON Web Key Set | |
1272
- | **kid** | **String** | The JSON Web Key ID (kid) | |
1273
-
1274
- ### Return type
1275
-
1276
- [**JsonWebKeySet**](JsonWebKeySet.md)
1277
-
1278
- ### Authorization
1279
-
1280
- [oryAccessToken](../README.md#oryAccessToken)
1281
-
1282
- ### HTTP request headers
1283
-
1284
- - **Content-Type**: Not defined
1285
- - **Accept**: application/json
1286
-
1287
-
1288
- ## admin_get_json_web_key_set
1289
-
1290
- > <JsonWebKeySet> admin_get_json_web_key_set(set)
1291
-
1292
- Retrieve a JSON Web Key Set
1293
-
1294
- This endpoint can be used to retrieve JWK Sets stored in ORY Hydra. A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing user-defined keys as well.
1295
-
1296
- ### Examples
1297
-
1298
- ```ruby
1299
- require 'time'
1300
- require 'ory-client'
1301
- # setup authorization
1302
- OryClient.configure do |config|
1303
- # Configure Bearer authorization: oryAccessToken
1304
- config.access_token = 'YOUR_BEARER_TOKEN'
1305
- end
1306
-
1307
- api_instance = OryClient::V0alpha2Api.new
1308
- set = 'set_example' # String | The JSON Web Key Set
1309
-
1310
- begin
1311
- # Retrieve a JSON Web Key Set
1312
- result = api_instance.admin_get_json_web_key_set(set)
1313
- p result
1314
- rescue OryClient::ApiError => e
1315
- puts "Error when calling V0alpha2Api->admin_get_json_web_key_set: #{e}"
1316
- end
1317
- ```
1318
-
1319
- #### Using the admin_get_json_web_key_set_with_http_info variant
1320
-
1321
- This returns an Array which contains the response data, status code and headers.
1322
-
1323
- > <Array(<JsonWebKeySet>, Integer, Hash)> admin_get_json_web_key_set_with_http_info(set)
1324
-
1325
- ```ruby
1326
- begin
1327
- # Retrieve a JSON Web Key Set
1328
- data, status_code, headers = api_instance.admin_get_json_web_key_set_with_http_info(set)
1329
- p status_code # => 2xx
1330
- p headers # => { ... }
1331
- p data # => <JsonWebKeySet>
1332
- rescue OryClient::ApiError => e
1333
- puts "Error when calling V0alpha2Api->admin_get_json_web_key_set_with_http_info: #{e}"
1334
- end
1335
- ```
1336
-
1337
- ### Parameters
1338
-
1339
- | Name | Type | Description | Notes |
1340
- | ---- | ---- | ----------- | ----- |
1341
- | **set** | **String** | The JSON Web Key Set | |
1342
-
1343
- ### Return type
1344
-
1345
- [**JsonWebKeySet**](JsonWebKeySet.md)
1346
-
1347
- ### Authorization
1348
-
1349
- [oryAccessToken](../README.md#oryAccessToken)
1350
-
1351
- ### HTTP request headers
1352
-
1353
- - **Content-Type**: Not defined
1354
- - **Accept**: application/json
1355
-
1356
-
1357
- ## admin_get_o_auth2_client
1358
-
1359
- > <OAuth2Client> admin_get_o_auth2_client(id)
1360
-
1361
- Get an OAuth 2.0 Client
1362
-
1363
- Get an OAuth 2.0 client by its ID. This endpoint never returns the client secret. OAuth 2.0 clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are generated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities.
1364
-
1365
- ### Examples
1366
-
1367
- ```ruby
1368
- require 'time'
1369
- require 'ory-client'
1370
- # setup authorization
1371
- OryClient.configure do |config|
1372
- # Configure Bearer authorization: oryAccessToken
1373
- config.access_token = 'YOUR_BEARER_TOKEN'
1374
- end
1375
-
1376
- api_instance = OryClient::V0alpha2Api.new
1377
- id = 'id_example' # String | The id of the OAuth 2.0 Client.
1378
-
1379
- begin
1380
- # Get an OAuth 2.0 Client
1381
- result = api_instance.admin_get_o_auth2_client(id)
1382
- p result
1383
- rescue OryClient::ApiError => e
1384
- puts "Error when calling V0alpha2Api->admin_get_o_auth2_client: #{e}"
1385
- end
1386
- ```
1387
-
1388
- #### Using the admin_get_o_auth2_client_with_http_info variant
1389
-
1390
- This returns an Array which contains the response data, status code and headers.
1391
-
1392
- > <Array(<OAuth2Client>, Integer, Hash)> admin_get_o_auth2_client_with_http_info(id)
1393
-
1394
- ```ruby
1395
- begin
1396
- # Get an OAuth 2.0 Client
1397
- data, status_code, headers = api_instance.admin_get_o_auth2_client_with_http_info(id)
1398
- p status_code # => 2xx
1399
- p headers # => { ... }
1400
- p data # => <OAuth2Client>
1401
- rescue OryClient::ApiError => e
1402
- puts "Error when calling V0alpha2Api->admin_get_o_auth2_client_with_http_info: #{e}"
1403
- end
1404
- ```
1405
-
1406
- ### Parameters
1407
-
1408
- | Name | Type | Description | Notes |
1409
- | ---- | ---- | ----------- | ----- |
1410
- | **id** | **String** | The id of the OAuth 2.0 Client. | |
1411
-
1412
- ### Return type
1413
-
1414
- [**OAuth2Client**](OAuth2Client.md)
1415
-
1416
- ### Authorization
1417
-
1418
- [oryAccessToken](../README.md#oryAccessToken)
1419
-
1420
- ### HTTP request headers
1421
-
1422
- - **Content-Type**: Not defined
1423
- - **Accept**: application/json
1424
-
1425
-
1426
- ## admin_get_o_auth2_consent_request
1427
-
1428
- > <OAuth2ConsentRequest> admin_get_o_auth2_consent_request(consent_challenge)
1429
-
1430
- Get OAuth 2.0 Consent Request Information
1431
-
1432
- When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider to authenticate the subject and then tell ORY Hydra now about it. If the subject authenticated, he/she must now be asked if the OAuth 2.0 Client which initiated the flow should be allowed to access the resources on the subject's behalf. The consent provider which handles this request and is a web app implemented and hosted by you. It shows a subject interface which asks the subject to grant or deny the client access to the requested scope (\"Application my-dropbox-app wants write access to all your private files\"). The consent challenge is appended to the consent provider's URL to which the subject's user-agent (browser) is redirected to. The consent provider uses that challenge to fetch information on the OAuth2 request and then tells ORY Hydra if the subject accepted or rejected the request.
1433
-
1434
- ### Examples
1435
-
1436
- ```ruby
1437
- require 'time'
1438
- require 'ory-client'
1439
- # setup authorization
1440
- OryClient.configure do |config|
1441
- # Configure Bearer authorization: oryAccessToken
1442
- config.access_token = 'YOUR_BEARER_TOKEN'
1443
- end
1444
-
1445
- api_instance = OryClient::V0alpha2Api.new
1446
- consent_challenge = 'consent_challenge_example' # String |
1447
-
1448
- begin
1449
- # Get OAuth 2.0 Consent Request Information
1450
- result = api_instance.admin_get_o_auth2_consent_request(consent_challenge)
1451
- p result
1452
- rescue OryClient::ApiError => e
1453
- puts "Error when calling V0alpha2Api->admin_get_o_auth2_consent_request: #{e}"
1454
- end
1455
- ```
1456
-
1457
- #### Using the admin_get_o_auth2_consent_request_with_http_info variant
1458
-
1459
- This returns an Array which contains the response data, status code and headers.
1460
-
1461
- > <Array(<OAuth2ConsentRequest>, Integer, Hash)> admin_get_o_auth2_consent_request_with_http_info(consent_challenge)
1462
-
1463
- ```ruby
1464
- begin
1465
- # Get OAuth 2.0 Consent Request Information
1466
- data, status_code, headers = api_instance.admin_get_o_auth2_consent_request_with_http_info(consent_challenge)
1467
- p status_code # => 2xx
1468
- p headers # => { ... }
1469
- p data # => <OAuth2ConsentRequest>
1470
- rescue OryClient::ApiError => e
1471
- puts "Error when calling V0alpha2Api->admin_get_o_auth2_consent_request_with_http_info: #{e}"
1472
- end
1473
- ```
1474
-
1475
- ### Parameters
1476
-
1477
- | Name | Type | Description | Notes |
1478
- | ---- | ---- | ----------- | ----- |
1479
- | **consent_challenge** | **String** | | |
1480
-
1481
- ### Return type
1482
-
1483
- [**OAuth2ConsentRequest**](OAuth2ConsentRequest.md)
1484
-
1485
- ### Authorization
1486
-
1487
- [oryAccessToken](../README.md#oryAccessToken)
1488
-
1489
- ### HTTP request headers
1490
-
1491
- - **Content-Type**: Not defined
1492
- - **Accept**: application/json
1493
-
1494
-
1495
- ## admin_get_o_auth2_login_request
1496
-
1497
- > <OAuth2LoginRequest> admin_get_o_auth2_login_request(login_challenge)
1498
-
1499
- Get an OAuth 2.0 Login Request
1500
-
1501
- When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider (sometimes called \"identity provider\") to authenticate the subject and then tell ORY Hydra now about it. The login provider is an web-app you write and host, and it must be able to authenticate (\"show the subject a login screen\") a subject (in OAuth2 the proper name for subject is \"resource owner\"). The authentication challenge is appended to the login provider URL to which the subject's user-agent (browser) is redirected to. The login provider uses that challenge to fetch information on the OAuth2 request and then accept or reject the requested authentication process.
1502
-
1503
- ### Examples
1504
-
1505
- ```ruby
1506
- require 'time'
1507
- require 'ory-client'
1508
- # setup authorization
1509
- OryClient.configure do |config|
1510
- # Configure Bearer authorization: oryAccessToken
1511
- config.access_token = 'YOUR_BEARER_TOKEN'
1512
- end
1513
-
1514
- api_instance = OryClient::V0alpha2Api.new
1515
- login_challenge = 'login_challenge_example' # String |
1516
-
1517
- begin
1518
- # Get an OAuth 2.0 Login Request
1519
- result = api_instance.admin_get_o_auth2_login_request(login_challenge)
1520
- p result
1521
- rescue OryClient::ApiError => e
1522
- puts "Error when calling V0alpha2Api->admin_get_o_auth2_login_request: #{e}"
1523
- end
1524
- ```
1525
-
1526
- #### Using the admin_get_o_auth2_login_request_with_http_info variant
1527
-
1528
- This returns an Array which contains the response data, status code and headers.
1529
-
1530
- > <Array(<OAuth2LoginRequest>, Integer, Hash)> admin_get_o_auth2_login_request_with_http_info(login_challenge)
1531
-
1532
- ```ruby
1533
- begin
1534
- # Get an OAuth 2.0 Login Request
1535
- data, status_code, headers = api_instance.admin_get_o_auth2_login_request_with_http_info(login_challenge)
1536
- p status_code # => 2xx
1537
- p headers # => { ... }
1538
- p data # => <OAuth2LoginRequest>
1539
- rescue OryClient::ApiError => e
1540
- puts "Error when calling V0alpha2Api->admin_get_o_auth2_login_request_with_http_info: #{e}"
1541
- end
1542
- ```
1543
-
1544
- ### Parameters
1545
-
1546
- | Name | Type | Description | Notes |
1547
- | ---- | ---- | ----------- | ----- |
1548
- | **login_challenge** | **String** | | |
1549
-
1550
- ### Return type
1551
-
1552
- [**OAuth2LoginRequest**](OAuth2LoginRequest.md)
1553
-
1554
- ### Authorization
1555
-
1556
- [oryAccessToken](../README.md#oryAccessToken)
1557
-
1558
- ### HTTP request headers
1559
-
1560
- - **Content-Type**: Not defined
1561
- - **Accept**: application/json
1562
-
1563
-
1564
- ## admin_get_o_auth2_logout_request
1565
-
1566
- > <OAuth2LogoutRequest> admin_get_o_auth2_logout_request(logout_challenge)
1567
-
1568
- Get an OAuth 2.0 Logout Request
1569
-
1570
- Use this endpoint to fetch a logout request.
1571
-
1572
- ### Examples
1573
-
1574
- ```ruby
1575
- require 'time'
1576
- require 'ory-client'
1577
- # setup authorization
1578
- OryClient.configure do |config|
1579
- # Configure Bearer authorization: oryAccessToken
1580
- config.access_token = 'YOUR_BEARER_TOKEN'
1581
- end
1582
-
1583
- api_instance = OryClient::V0alpha2Api.new
1584
- logout_challenge = 'logout_challenge_example' # String |
1585
-
1586
- begin
1587
- # Get an OAuth 2.0 Logout Request
1588
- result = api_instance.admin_get_o_auth2_logout_request(logout_challenge)
1589
- p result
1590
- rescue OryClient::ApiError => e
1591
- puts "Error when calling V0alpha2Api->admin_get_o_auth2_logout_request: #{e}"
1592
- end
1593
- ```
1594
-
1595
- #### Using the admin_get_o_auth2_logout_request_with_http_info variant
1596
-
1597
- This returns an Array which contains the response data, status code and headers.
1598
-
1599
- > <Array(<OAuth2LogoutRequest>, Integer, Hash)> admin_get_o_auth2_logout_request_with_http_info(logout_challenge)
1600
-
1601
- ```ruby
1602
- begin
1603
- # Get an OAuth 2.0 Logout Request
1604
- data, status_code, headers = api_instance.admin_get_o_auth2_logout_request_with_http_info(logout_challenge)
1605
- p status_code # => 2xx
1606
- p headers # => { ... }
1607
- p data # => <OAuth2LogoutRequest>
1608
- rescue OryClient::ApiError => e
1609
- puts "Error when calling V0alpha2Api->admin_get_o_auth2_logout_request_with_http_info: #{e}"
1610
- end
1611
- ```
1612
-
1613
- ### Parameters
1614
-
1615
- | Name | Type | Description | Notes |
1616
- | ---- | ---- | ----------- | ----- |
1617
- | **logout_challenge** | **String** | | |
1618
-
1619
- ### Return type
1620
-
1621
- [**OAuth2LogoutRequest**](OAuth2LogoutRequest.md)
1622
-
1623
- ### Authorization
1624
-
1625
- [oryAccessToken](../README.md#oryAccessToken)
1626
-
1627
- ### HTTP request headers
1628
-
1629
- - **Content-Type**: Not defined
1630
- - **Accept**: application/json
1631
-
1632
-
1633
- ## admin_get_trusted_o_auth2_jwt_grant_issuer
1634
-
1635
- > <TrustedOAuth2JwtGrantIssuer> admin_get_trusted_o_auth2_jwt_grant_issuer(id)
1636
-
1637
- Get a Trusted OAuth2 JWT Bearer Grant Type Issuer
1638
-
1639
- Use this endpoint to get a trusted JWT Bearer Grant Type Issuer. The ID is the one returned when you created the trust relationship.
1640
-
1641
- ### Examples
1642
-
1643
- ```ruby
1644
- require 'time'
1645
- require 'ory-client'
1646
- # setup authorization
1647
- OryClient.configure do |config|
1648
- # Configure Bearer authorization: oryAccessToken
1649
- config.access_token = 'YOUR_BEARER_TOKEN'
1650
- end
1651
-
1652
- api_instance = OryClient::V0alpha2Api.new
1653
- id = 'id_example' # String | The id of the desired grant
1654
-
1655
- begin
1656
- # Get a Trusted OAuth2 JWT Bearer Grant Type Issuer
1657
- result = api_instance.admin_get_trusted_o_auth2_jwt_grant_issuer(id)
1658
- p result
1659
- rescue OryClient::ApiError => e
1660
- puts "Error when calling V0alpha2Api->admin_get_trusted_o_auth2_jwt_grant_issuer: #{e}"
1661
- end
1662
- ```
1663
-
1664
- #### Using the admin_get_trusted_o_auth2_jwt_grant_issuer_with_http_info variant
1665
-
1666
- This returns an Array which contains the response data, status code and headers.
1667
-
1668
- > <Array(<TrustedOAuth2JwtGrantIssuer>, Integer, Hash)> admin_get_trusted_o_auth2_jwt_grant_issuer_with_http_info(id)
1669
-
1670
- ```ruby
1671
- begin
1672
- # Get a Trusted OAuth2 JWT Bearer Grant Type Issuer
1673
- data, status_code, headers = api_instance.admin_get_trusted_o_auth2_jwt_grant_issuer_with_http_info(id)
1674
- p status_code # => 2xx
1675
- p headers # => { ... }
1676
- p data # => <TrustedOAuth2JwtGrantIssuer>
1677
- rescue OryClient::ApiError => e
1678
- puts "Error when calling V0alpha2Api->admin_get_trusted_o_auth2_jwt_grant_issuer_with_http_info: #{e}"
1679
- end
1680
- ```
1681
-
1682
- ### Parameters
1683
-
1684
- | Name | Type | Description | Notes |
1685
- | ---- | ---- | ----------- | ----- |
1686
- | **id** | **String** | The id of the desired grant | |
1687
-
1688
- ### Return type
1689
-
1690
- [**TrustedOAuth2JwtGrantIssuer**](TrustedOAuth2JwtGrantIssuer.md)
1691
-
1692
- ### Authorization
1693
-
1694
- [oryAccessToken](../README.md#oryAccessToken)
1695
-
1696
- ### HTTP request headers
1697
-
1698
- - **Content-Type**: Not defined
1699
- - **Accept**: application/json
1700
-
1701
-
1702
- ## admin_introspect_o_auth2_token
1703
-
1704
- > <IntrospectedOAuth2Token> admin_introspect_o_auth2_token(token, opts)
1705
-
1706
- Introspect OAuth2 Access or Refresh Tokens
1707
-
1708
- The introspection endpoint allows to check if a token (both refresh and access) is active or not. An active token is neither expired nor revoked. If a token is active, additional information on the token will be included. You can set additional data for a token by setting `accessTokenExtra` during the consent flow. For more information [read this blog post](https://www.oauth.com/oauth2-servers/token-introspection-endpoint/).
1709
-
1710
- ### Examples
1711
-
1712
- ```ruby
1713
- require 'time'
1714
- require 'ory-client'
1715
- # setup authorization
1716
- OryClient.configure do |config|
1717
- # Configure Bearer authorization: oryAccessToken
1718
- config.access_token = 'YOUR_BEARER_TOKEN'
1719
- end
1720
-
1721
- api_instance = OryClient::V0alpha2Api.new
1722
- token = 'token_example' # String | The string value of the token. For access tokens, this is the \\\"access_token\\\" value returned from the token endpoint defined in OAuth 2.0. For refresh tokens, this is the \\\"refresh_token\\\" value returned.
1723
- opts = {
1724
- scope: 'scope_example' # String | An optional, space separated list of required scopes. If the access token was not granted one of the scopes, the result of active will be false.
1725
- }
1726
-
1727
- begin
1728
- # Introspect OAuth2 Access or Refresh Tokens
1729
- result = api_instance.admin_introspect_o_auth2_token(token, opts)
1730
- p result
1731
- rescue OryClient::ApiError => e
1732
- puts "Error when calling V0alpha2Api->admin_introspect_o_auth2_token: #{e}"
1733
- end
1734
- ```
1735
-
1736
- #### Using the admin_introspect_o_auth2_token_with_http_info variant
1737
-
1738
- This returns an Array which contains the response data, status code and headers.
1739
-
1740
- > <Array(<IntrospectedOAuth2Token>, Integer, Hash)> admin_introspect_o_auth2_token_with_http_info(token, opts)
1741
-
1742
- ```ruby
1743
- begin
1744
- # Introspect OAuth2 Access or Refresh Tokens
1745
- data, status_code, headers = api_instance.admin_introspect_o_auth2_token_with_http_info(token, opts)
1746
- p status_code # => 2xx
1747
- p headers # => { ... }
1748
- p data # => <IntrospectedOAuth2Token>
1749
- rescue OryClient::ApiError => e
1750
- puts "Error when calling V0alpha2Api->admin_introspect_o_auth2_token_with_http_info: #{e}"
1751
- end
1752
- ```
1753
-
1754
- ### Parameters
1755
-
1756
- | Name | Type | Description | Notes |
1757
- | ---- | ---- | ----------- | ----- |
1758
- | **token** | **String** | The string value of the token. For access tokens, this is the \\\&quot;access_token\\\&quot; value returned from the token endpoint defined in OAuth 2.0. For refresh tokens, this is the \\\&quot;refresh_token\\\&quot; value returned. | |
1759
- | **scope** | **String** | An optional, space separated list of required scopes. If the access token was not granted one of the scopes, the result of active will be false. | [optional] |
1760
-
1761
- ### Return type
1762
-
1763
- [**IntrospectedOAuth2Token**](IntrospectedOAuth2Token.md)
1764
-
1765
- ### Authorization
1766
-
1767
- [oryAccessToken](../README.md#oryAccessToken)
1768
-
1769
- ### HTTP request headers
1770
-
1771
- - **Content-Type**: application/x-www-form-urlencoded
1772
- - **Accept**: application/json
1773
-
1774
-
1775
- ## admin_list_identities
1776
-
1777
- > <Array<Identity>> admin_list_identities(opts)
1778
-
1779
- List Identities
1780
-
1781
- Lists all identities. Does not support search at the moment. Learn how identities work in [Ory Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
1782
-
1783
- ### Examples
1784
-
1785
- ```ruby
1786
- require 'time'
1787
- require 'ory-client'
1788
- # setup authorization
1789
- OryClient.configure do |config|
1790
- # Configure Bearer authorization: oryAccessToken
1791
- config.access_token = 'YOUR_BEARER_TOKEN'
1792
- end
1793
-
1794
- api_instance = OryClient::V0alpha2Api.new
1795
- opts = {
1796
- per_page: 789, # Integer | Items per Page This is the number of items per page.
1797
- page: 789 # Integer | Pagination Page This value is currently an integer, but it is not sequential. The value is not the page number, but a reference. The next page can be any number and some numbers might return an empty list. For example, page 2 might not follow after page 1. And even if page 3 and 5 exist, but page 4 might not exist.
1798
- }
1799
-
1800
- begin
1801
- # List Identities
1802
- result = api_instance.admin_list_identities(opts)
1803
- p result
1804
- rescue OryClient::ApiError => e
1805
- puts "Error when calling V0alpha2Api->admin_list_identities: #{e}"
1806
- end
1807
- ```
1808
-
1809
- #### Using the admin_list_identities_with_http_info variant
1810
-
1811
- This returns an Array which contains the response data, status code and headers.
1812
-
1813
- > <Array(<Array<Identity>>, Integer, Hash)> admin_list_identities_with_http_info(opts)
1814
-
1815
- ```ruby
1816
- begin
1817
- # List Identities
1818
- data, status_code, headers = api_instance.admin_list_identities_with_http_info(opts)
1819
- p status_code # => 2xx
1820
- p headers # => { ... }
1821
- p data # => <Array<Identity>>
1822
- rescue OryClient::ApiError => e
1823
- puts "Error when calling V0alpha2Api->admin_list_identities_with_http_info: #{e}"
1824
- end
1825
- ```
1826
-
1827
- ### Parameters
1828
-
1829
- | Name | Type | Description | Notes |
1830
- | ---- | ---- | ----------- | ----- |
1831
- | **per_page** | **Integer** | Items per Page This is the number of items per page. | [optional][default to 250] |
1832
- | **page** | **Integer** | Pagination Page This value is currently an integer, but it is not sequential. The value is not the page number, but a reference. The next page can be any number and some numbers might return an empty list. For example, page 2 might not follow after page 1. And even if page 3 and 5 exist, but page 4 might not exist. | [optional][default to 1] |
1833
-
1834
- ### Return type
1835
-
1836
- [**Array&lt;Identity&gt;**](Identity.md)
1837
-
1838
- ### Authorization
1839
-
1840
- [oryAccessToken](../README.md#oryAccessToken)
1841
-
1842
- ### HTTP request headers
1843
-
1844
- - **Content-Type**: Not defined
1845
- - **Accept**: application/json
1846
-
1847
-
1848
- ## admin_list_identity_sessions
1849
-
1850
- > <Array<Session>> admin_list_identity_sessions(id, opts)
1851
-
1852
- This endpoint returns all sessions that belong to the given Identity.
1853
-
1854
- This endpoint is useful for: Listing all sessions that belong to an Identity in an administrative context.
1855
-
1856
- ### Examples
1857
-
1858
- ```ruby
1859
- require 'time'
1860
- require 'ory-client'
1861
- # setup authorization
1862
- OryClient.configure do |config|
1863
- # Configure Bearer authorization: oryAccessToken
1864
- config.access_token = 'YOUR_BEARER_TOKEN'
1865
- end
1866
-
1867
- api_instance = OryClient::V0alpha2Api.new
1868
- id = 'id_example' # String | ID is the identity's ID.
1869
- opts = {
1870
- per_page: 789, # Integer | Items per Page This is the number of items per page.
1871
- page: 789, # Integer | Pagination Page This value is currently an integer, but it is not sequential. The value is not the page number, but a reference. The next page can be any number and some numbers might return an empty list. For example, page 2 might not follow after page 1. And even if page 3 and 5 exist, but page 4 might not exist.
1872
- active: true # Boolean | Active is a boolean flag that filters out sessions based on the state. If no value is provided, all sessions are returned.
1873
- }
1874
-
1875
- begin
1876
- # This endpoint returns all sessions that belong to the given Identity.
1877
- result = api_instance.admin_list_identity_sessions(id, opts)
1878
- p result
1879
- rescue OryClient::ApiError => e
1880
- puts "Error when calling V0alpha2Api->admin_list_identity_sessions: #{e}"
1881
- end
1882
- ```
1883
-
1884
- #### Using the admin_list_identity_sessions_with_http_info variant
1885
-
1886
- This returns an Array which contains the response data, status code and headers.
1887
-
1888
- > <Array(<Array<Session>>, Integer, Hash)> admin_list_identity_sessions_with_http_info(id, opts)
1889
-
1890
- ```ruby
1891
- begin
1892
- # This endpoint returns all sessions that belong to the given Identity.
1893
- data, status_code, headers = api_instance.admin_list_identity_sessions_with_http_info(id, opts)
1894
- p status_code # => 2xx
1895
- p headers # => { ... }
1896
- p data # => <Array<Session>>
1897
- rescue OryClient::ApiError => e
1898
- puts "Error when calling V0alpha2Api->admin_list_identity_sessions_with_http_info: #{e}"
1899
- end
1900
- ```
1901
-
1902
- ### Parameters
1903
-
1904
- | Name | Type | Description | Notes |
1905
- | ---- | ---- | ----------- | ----- |
1906
- | **id** | **String** | ID is the identity&#39;s ID. | |
1907
- | **per_page** | **Integer** | Items per Page This is the number of items per page. | [optional][default to 250] |
1908
- | **page** | **Integer** | Pagination Page This value is currently an integer, but it is not sequential. The value is not the page number, but a reference. The next page can be any number and some numbers might return an empty list. For example, page 2 might not follow after page 1. And even if page 3 and 5 exist, but page 4 might not exist. | [optional][default to 1] |
1909
- | **active** | **Boolean** | Active is a boolean flag that filters out sessions based on the state. If no value is provided, all sessions are returned. | [optional] |
1910
-
1911
- ### Return type
1912
-
1913
- [**Array&lt;Session&gt;**](Session.md)
1914
-
1915
- ### Authorization
1916
-
1917
- [oryAccessToken](../README.md#oryAccessToken)
1918
-
1919
- ### HTTP request headers
1920
-
1921
- - **Content-Type**: Not defined
1922
- - **Accept**: application/json
1923
-
1924
-
1925
- ## admin_list_o_auth2_clients
1926
-
1927
- > <Array<OAuth2Client>> admin_list_o_auth2_clients(opts)
1928
-
1929
- List OAuth 2.0 Clients
1930
-
1931
- This endpoint lists all clients in the database, and never returns client secrets. As a default it lists the first 100 clients. The `limit` parameter can be used to retrieve more clients, but it has an upper bound at 500 objects. Pagination should be used to retrieve more than 500 objects. OAuth 2.0 clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are generated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities. The \"Link\" header is also included in successful responses, which contains one or more links for pagination, formatted like so: '<https://project-slug.projects.oryapis.com/admin/clients?limit={limit}&offset={offset}>; rel=\"{page}\"', where page is one of the following applicable pages: 'first', 'next', 'last', and 'previous'. Multiple links can be included in this header, and will be separated by a comma.
1932
-
1933
- ### Examples
1934
-
1935
- ```ruby
1936
- require 'time'
1937
- require 'ory-client'
1938
- # setup authorization
1939
- OryClient.configure do |config|
1940
- # Configure Bearer authorization: oryAccessToken
1941
- config.access_token = 'YOUR_BEARER_TOKEN'
1942
- end
1943
-
1944
- api_instance = OryClient::V0alpha2Api.new
1945
- opts = {
1946
- page_size: 789, # Integer | Items per page This is the number of items per page to return. For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination).
1947
- page_token: 'page_token_example', # String | Next Page Token The next page token. For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination).
1948
- client_name: 'client_name_example', # String | The name of the clients to filter by.
1949
- owner: 'owner_example' # String | The owner of the clients to filter by.
1950
- }
1951
-
1952
- begin
1953
- # List OAuth 2.0 Clients
1954
- result = api_instance.admin_list_o_auth2_clients(opts)
1955
- p result
1956
- rescue OryClient::ApiError => e
1957
- puts "Error when calling V0alpha2Api->admin_list_o_auth2_clients: #{e}"
1958
- end
1959
- ```
1960
-
1961
- #### Using the admin_list_o_auth2_clients_with_http_info variant
1962
-
1963
- This returns an Array which contains the response data, status code and headers.
1964
-
1965
- > <Array(<Array<OAuth2Client>>, Integer, Hash)> admin_list_o_auth2_clients_with_http_info(opts)
1966
-
1967
- ```ruby
1968
- begin
1969
- # List OAuth 2.0 Clients
1970
- data, status_code, headers = api_instance.admin_list_o_auth2_clients_with_http_info(opts)
1971
- p status_code # => 2xx
1972
- p headers # => { ... }
1973
- p data # => <Array<OAuth2Client>>
1974
- rescue OryClient::ApiError => e
1975
- puts "Error when calling V0alpha2Api->admin_list_o_auth2_clients_with_http_info: #{e}"
1976
- end
1977
- ```
1978
-
1979
- ### Parameters
1980
-
1981
- | Name | Type | Description | Notes |
1982
- | ---- | ---- | ----------- | ----- |
1983
- | **page_size** | **Integer** | Items per page This is the number of items per page to return. For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination). | [optional][default to 250] |
1984
- | **page_token** | **String** | Next Page Token The next page token. For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination). | [optional][default to &#39;1&#39;] |
1985
- | **client_name** | **String** | The name of the clients to filter by. | [optional] |
1986
- | **owner** | **String** | The owner of the clients to filter by. | [optional] |
1987
-
1988
- ### Return type
1989
-
1990
- [**Array&lt;OAuth2Client&gt;**](OAuth2Client.md)
1991
-
1992
- ### Authorization
1993
-
1994
- [oryAccessToken](../README.md#oryAccessToken)
1995
-
1996
- ### HTTP request headers
1997
-
1998
- - **Content-Type**: Not defined
1999
- - **Accept**: application/json
2000
-
2001
-
2002
- ## admin_list_o_auth2_subject_consent_sessions
2003
-
2004
- > <Array<PreviousOAuth2ConsentSession>> admin_list_o_auth2_subject_consent_sessions(subject, opts)
2005
-
2006
- List OAuth 2.0 Consent Sessions of a Subject
2007
-
2008
- This endpoint lists all subject's granted consent sessions, including client and granted scope. If the subject is unknown or has not granted any consent sessions yet, the endpoint returns an empty JSON array with status code 200 OK. The \"Link\" header is also included in successful responses, which contains one or more links for pagination, formatted like so: '<https://hydra-url/admin/oauth2/auth/sessions/consent?subject={user}&limit={limit}&offset={offset}>; rel=\"{page}\"', where page is one of the following applicable pages: 'first', 'next', 'last', and 'previous'. Multiple links can be included in this header, and will be separated by a comma.
2009
-
2010
- ### Examples
2011
-
2012
- ```ruby
2013
- require 'time'
2014
- require 'ory-client'
2015
- # setup authorization
2016
- OryClient.configure do |config|
2017
- # Configure Bearer authorization: oryAccessToken
2018
- config.access_token = 'YOUR_BEARER_TOKEN'
2019
- end
2020
-
2021
- api_instance = OryClient::V0alpha2Api.new
2022
- subject = 'subject_example' # String | The subject to list the consent sessions for.
2023
- opts = {
2024
- link: 'link_example', # String | The link header contains pagination links. For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination).
2025
- x_total_count: 'x_total_count_example' # String | The total number of clients.
2026
- }
2027
-
2028
- begin
2029
- # List OAuth 2.0 Consent Sessions of a Subject
2030
- result = api_instance.admin_list_o_auth2_subject_consent_sessions(subject, opts)
2031
- p result
2032
- rescue OryClient::ApiError => e
2033
- puts "Error when calling V0alpha2Api->admin_list_o_auth2_subject_consent_sessions: #{e}"
2034
- end
2035
- ```
2036
-
2037
- #### Using the admin_list_o_auth2_subject_consent_sessions_with_http_info variant
2038
-
2039
- This returns an Array which contains the response data, status code and headers.
2040
-
2041
- > <Array(<Array<PreviousOAuth2ConsentSession>>, Integer, Hash)> admin_list_o_auth2_subject_consent_sessions_with_http_info(subject, opts)
2042
-
2043
- ```ruby
2044
- begin
2045
- # List OAuth 2.0 Consent Sessions of a Subject
2046
- data, status_code, headers = api_instance.admin_list_o_auth2_subject_consent_sessions_with_http_info(subject, opts)
2047
- p status_code # => 2xx
2048
- p headers # => { ... }
2049
- p data # => <Array<PreviousOAuth2ConsentSession>>
2050
- rescue OryClient::ApiError => e
2051
- puts "Error when calling V0alpha2Api->admin_list_o_auth2_subject_consent_sessions_with_http_info: #{e}"
2052
- end
2053
- ```
2054
-
2055
- ### Parameters
2056
-
2057
- | Name | Type | Description | Notes |
2058
- | ---- | ---- | ----------- | ----- |
2059
- | **subject** | **String** | The subject to list the consent sessions for. | |
2060
- | **link** | **String** | The link header contains pagination links. For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination). | [optional] |
2061
- | **x_total_count** | **String** | The total number of clients. | [optional] |
2062
-
2063
- ### Return type
2064
-
2065
- [**Array&lt;PreviousOAuth2ConsentSession&gt;**](PreviousOAuth2ConsentSession.md)
2066
-
2067
- ### Authorization
2068
-
2069
- [oryAccessToken](../README.md#oryAccessToken)
2070
-
2071
- ### HTTP request headers
2072
-
2073
- - **Content-Type**: Not defined
2074
- - **Accept**: application/json
2075
-
2076
-
2077
- ## admin_list_trusted_o_auth2_jwt_grant_issuers
2078
-
2079
- > <Array<TrustedOAuth2JwtGrantIssuer>> admin_list_trusted_o_auth2_jwt_grant_issuers(opts)
2080
-
2081
- List Trusted OAuth2 JWT Bearer Grant Type Issuers
2082
-
2083
- Use this endpoint to list all trusted JWT Bearer Grant Type Issuers.
2084
-
2085
- ### Examples
2086
-
2087
- ```ruby
2088
- require 'time'
2089
- require 'ory-client'
2090
- # setup authorization
2091
- OryClient.configure do |config|
2092
- # Configure Bearer authorization: oryAccessToken
2093
- config.access_token = 'YOUR_BEARER_TOKEN'
2094
- end
2095
-
2096
- api_instance = OryClient::V0alpha2Api.new
2097
- opts = {
2098
- max_items: 789, # Integer |
2099
- default_items: 789, # Integer |
2100
- issuer: 'issuer_example', # String | If optional \"issuer\" is supplied, only jwt-bearer grants with this issuer will be returned.
2101
- limit: 789, # Integer | The maximum amount of policies returned, upper bound is 500 policies
2102
- offset: 789 # Integer | The offset from where to start looking.
2103
- }
2104
-
2105
- begin
2106
- # List Trusted OAuth2 JWT Bearer Grant Type Issuers
2107
- result = api_instance.admin_list_trusted_o_auth2_jwt_grant_issuers(opts)
2108
- p result
2109
- rescue OryClient::ApiError => e
2110
- puts "Error when calling V0alpha2Api->admin_list_trusted_o_auth2_jwt_grant_issuers: #{e}"
2111
- end
2112
- ```
2113
-
2114
- #### Using the admin_list_trusted_o_auth2_jwt_grant_issuers_with_http_info variant
2115
-
2116
- This returns an Array which contains the response data, status code and headers.
2117
-
2118
- > <Array(<Array<TrustedOAuth2JwtGrantIssuer>>, Integer, Hash)> admin_list_trusted_o_auth2_jwt_grant_issuers_with_http_info(opts)
2119
-
2120
- ```ruby
2121
- begin
2122
- # List Trusted OAuth2 JWT Bearer Grant Type Issuers
2123
- data, status_code, headers = api_instance.admin_list_trusted_o_auth2_jwt_grant_issuers_with_http_info(opts)
2124
- p status_code # => 2xx
2125
- p headers # => { ... }
2126
- p data # => <Array<TrustedOAuth2JwtGrantIssuer>>
2127
- rescue OryClient::ApiError => e
2128
- puts "Error when calling V0alpha2Api->admin_list_trusted_o_auth2_jwt_grant_issuers_with_http_info: #{e}"
2129
- end
2130
- ```
2131
-
2132
- ### Parameters
2133
-
2134
- | Name | Type | Description | Notes |
2135
- | ---- | ---- | ----------- | ----- |
2136
- | **max_items** | **Integer** | | [optional] |
2137
- | **default_items** | **Integer** | | [optional] |
2138
- | **issuer** | **String** | If optional \&quot;issuer\&quot; is supplied, only jwt-bearer grants with this issuer will be returned. | [optional] |
2139
- | **limit** | **Integer** | The maximum amount of policies returned, upper bound is 500 policies | [optional] |
2140
- | **offset** | **Integer** | The offset from where to start looking. | [optional] |
2141
-
2142
- ### Return type
2143
-
2144
- [**Array&lt;TrustedOAuth2JwtGrantIssuer&gt;**](TrustedOAuth2JwtGrantIssuer.md)
2145
-
2146
- ### Authorization
2147
-
2148
- [oryAccessToken](../README.md#oryAccessToken)
2149
-
2150
- ### HTTP request headers
2151
-
2152
- - **Content-Type**: Not defined
2153
- - **Accept**: application/json
2154
-
2155
-
2156
- ## admin_patch_identity
2157
-
2158
- > <Identity> admin_patch_identity(id, opts)
2159
-
2160
- Partially updates an Identity's field using [JSON Patch](https://jsonpatch.com/)
2161
-
2162
- NOTE: The fields `id`, `stateChangedAt` and `credentials` are not updateable. Learn how identities work in [Ory Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
2163
-
2164
- ### Examples
2165
-
2166
- ```ruby
2167
- require 'time'
2168
- require 'ory-client'
2169
- # setup authorization
2170
- OryClient.configure do |config|
2171
- # Configure Bearer authorization: oryAccessToken
2172
- config.access_token = 'YOUR_BEARER_TOKEN'
2173
- end
2174
-
2175
- api_instance = OryClient::V0alpha2Api.new
2176
- id = 'id_example' # String | ID must be set to the ID of identity you want to update
2177
- opts = {
2178
- json_patch: [OryClient::JsonPatch.new({op: 'add', path: '/services/identity/config/smtp/from_name'})] # Array<JsonPatch> |
2179
- }
2180
-
2181
- begin
2182
- # Partially updates an Identity's field using [JSON Patch](https://jsonpatch.com/)
2183
- result = api_instance.admin_patch_identity(id, opts)
2184
- p result
2185
- rescue OryClient::ApiError => e
2186
- puts "Error when calling V0alpha2Api->admin_patch_identity: #{e}"
2187
- end
2188
- ```
2189
-
2190
- #### Using the admin_patch_identity_with_http_info variant
2191
-
2192
- This returns an Array which contains the response data, status code and headers.
2193
-
2194
- > <Array(<Identity>, Integer, Hash)> admin_patch_identity_with_http_info(id, opts)
2195
-
2196
- ```ruby
2197
- begin
2198
- # Partially updates an Identity's field using [JSON Patch](https://jsonpatch.com/)
2199
- data, status_code, headers = api_instance.admin_patch_identity_with_http_info(id, opts)
2200
- p status_code # => 2xx
2201
- p headers # => { ... }
2202
- p data # => <Identity>
2203
- rescue OryClient::ApiError => e
2204
- puts "Error when calling V0alpha2Api->admin_patch_identity_with_http_info: #{e}"
2205
- end
2206
- ```
2207
-
2208
- ### Parameters
2209
-
2210
- | Name | Type | Description | Notes |
2211
- | ---- | ---- | ----------- | ----- |
2212
- | **id** | **String** | ID must be set to the ID of identity you want to update | |
2213
- | **json_patch** | [**Array&lt;JsonPatch&gt;**](JsonPatch.md) | | [optional] |
2214
-
2215
- ### Return type
2216
-
2217
- [**Identity**](Identity.md)
2218
-
2219
- ### Authorization
2220
-
2221
- [oryAccessToken](../README.md#oryAccessToken)
2222
-
2223
- ### HTTP request headers
2224
-
2225
- - **Content-Type**: application/json
2226
- - **Accept**: application/json
2227
-
2228
-
2229
- ## admin_patch_o_auth2_client
2230
-
2231
- > <OAuth2Client> admin_patch_o_auth2_client(id, json_patch)
2232
-
2233
- Patch an OAuth 2.0 Client
2234
-
2235
- Patch an existing OAuth 2.0 Client. If you pass `client_secret` the secret will be updated and returned via the API. This is the only time you will be able to retrieve the client secret, so write it down and keep it safe. OAuth 2.0 clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are generated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities.
2236
-
2237
- ### Examples
2238
-
2239
- ```ruby
2240
- require 'time'
2241
- require 'ory-client'
2242
- # setup authorization
2243
- OryClient.configure do |config|
2244
- # Configure Bearer authorization: oryAccessToken
2245
- config.access_token = 'YOUR_BEARER_TOKEN'
2246
- end
2247
-
2248
- api_instance = OryClient::V0alpha2Api.new
2249
- id = 'id_example' # String | The id of the OAuth 2.0 Client.
2250
- json_patch = [OryClient::JsonPatch.new({op: 'add', path: '/services/identity/config/smtp/from_name'})] # Array<JsonPatch> |
2251
-
2252
- begin
2253
- # Patch an OAuth 2.0 Client
2254
- result = api_instance.admin_patch_o_auth2_client(id, json_patch)
2255
- p result
2256
- rescue OryClient::ApiError => e
2257
- puts "Error when calling V0alpha2Api->admin_patch_o_auth2_client: #{e}"
2258
- end
2259
- ```
2260
-
2261
- #### Using the admin_patch_o_auth2_client_with_http_info variant
2262
-
2263
- This returns an Array which contains the response data, status code and headers.
2264
-
2265
- > <Array(<OAuth2Client>, Integer, Hash)> admin_patch_o_auth2_client_with_http_info(id, json_patch)
2266
-
2267
- ```ruby
2268
- begin
2269
- # Patch an OAuth 2.0 Client
2270
- data, status_code, headers = api_instance.admin_patch_o_auth2_client_with_http_info(id, json_patch)
2271
- p status_code # => 2xx
2272
- p headers # => { ... }
2273
- p data # => <OAuth2Client>
2274
- rescue OryClient::ApiError => e
2275
- puts "Error when calling V0alpha2Api->admin_patch_o_auth2_client_with_http_info: #{e}"
2276
- end
2277
- ```
2278
-
2279
- ### Parameters
2280
-
2281
- | Name | Type | Description | Notes |
2282
- | ---- | ---- | ----------- | ----- |
2283
- | **id** | **String** | The id of the OAuth 2.0 Client. | |
2284
- | **json_patch** | [**Array&lt;JsonPatch&gt;**](JsonPatch.md) | | |
2285
-
2286
- ### Return type
2287
-
2288
- [**OAuth2Client**](OAuth2Client.md)
2289
-
2290
- ### Authorization
2291
-
2292
- [oryAccessToken](../README.md#oryAccessToken)
2293
-
2294
- ### HTTP request headers
2295
-
2296
- - **Content-Type**: application/json
2297
- - **Accept**: application/json
2298
-
2299
-
2300
- ## admin_reject_o_auth2_consent_request
2301
-
2302
- > <SuccessfulOAuth2RequestResponse> admin_reject_o_auth2_consent_request(consent_challenge, opts)
2303
-
2304
- Reject an OAuth 2.0 Consent Request
2305
-
2306
- When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider to authenticate the subject and then tell ORY Hydra now about it. If the subject authenticated, he/she must now be asked if the OAuth 2.0 Client which initiated the flow should be allowed to access the resources on the subject's behalf. The consent provider which handles this request and is a web app implemented and hosted by you. It shows a subject interface which asks the subject to grant or deny the client access to the requested scope (\"Application my-dropbox-app wants write access to all your private files\"). The consent challenge is appended to the consent provider's URL to which the subject's user-agent (browser) is redirected to. The consent provider uses that challenge to fetch information on the OAuth2 request and then tells ORY Hydra if the subject accepted or rejected the request. This endpoint tells ORY Hydra that the subject has not authorized the OAuth 2.0 client to access resources on his/her behalf. The consent provider must include a reason why the consent was not granted. The response contains a redirect URL which the consent provider should redirect the user-agent to.
2307
-
2308
- ### Examples
2309
-
2310
- ```ruby
2311
- require 'time'
2312
- require 'ory-client'
2313
- # setup authorization
2314
- OryClient.configure do |config|
2315
- # Configure Bearer authorization: oryAccessToken
2316
- config.access_token = 'YOUR_BEARER_TOKEN'
2317
- end
2318
-
2319
- api_instance = OryClient::V0alpha2Api.new
2320
- consent_challenge = 'consent_challenge_example' # String |
2321
- opts = {
2322
- reject_o_auth2_request: OryClient::RejectOAuth2Request.new # RejectOAuth2Request |
2323
- }
2324
-
2325
- begin
2326
- # Reject an OAuth 2.0 Consent Request
2327
- result = api_instance.admin_reject_o_auth2_consent_request(consent_challenge, opts)
2328
- p result
2329
- rescue OryClient::ApiError => e
2330
- puts "Error when calling V0alpha2Api->admin_reject_o_auth2_consent_request: #{e}"
2331
- end
2332
- ```
2333
-
2334
- #### Using the admin_reject_o_auth2_consent_request_with_http_info variant
2335
-
2336
- This returns an Array which contains the response data, status code and headers.
2337
-
2338
- > <Array(<SuccessfulOAuth2RequestResponse>, Integer, Hash)> admin_reject_o_auth2_consent_request_with_http_info(consent_challenge, opts)
2339
-
2340
- ```ruby
2341
- begin
2342
- # Reject an OAuth 2.0 Consent Request
2343
- data, status_code, headers = api_instance.admin_reject_o_auth2_consent_request_with_http_info(consent_challenge, opts)
2344
- p status_code # => 2xx
2345
- p headers # => { ... }
2346
- p data # => <SuccessfulOAuth2RequestResponse>
2347
- rescue OryClient::ApiError => e
2348
- puts "Error when calling V0alpha2Api->admin_reject_o_auth2_consent_request_with_http_info: #{e}"
2349
- end
2350
- ```
2351
-
2352
- ### Parameters
2353
-
2354
- | Name | Type | Description | Notes |
2355
- | ---- | ---- | ----------- | ----- |
2356
- | **consent_challenge** | **String** | | |
2357
- | **reject_o_auth2_request** | [**RejectOAuth2Request**](RejectOAuth2Request.md) | | [optional] |
2358
-
2359
- ### Return type
2360
-
2361
- [**SuccessfulOAuth2RequestResponse**](SuccessfulOAuth2RequestResponse.md)
2362
-
2363
- ### Authorization
2364
-
2365
- [oryAccessToken](../README.md#oryAccessToken)
2366
-
2367
- ### HTTP request headers
2368
-
2369
- - **Content-Type**: application/json
2370
- - **Accept**: application/json
2371
-
2372
-
2373
- ## admin_reject_o_auth2_login_request
2374
-
2375
- > <SuccessfulOAuth2RequestResponse> admin_reject_o_auth2_login_request(login_challenge, opts)
2376
-
2377
- Reject an OAuth 2.0 Login Request
2378
-
2379
- When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider (sometimes called \"identity provider\") to authenticate the subject and then tell ORY Hydra now about it. The login provider is an web-app you write and host, and it must be able to authenticate (\"show the subject a login screen\") a subject (in OAuth2 the proper name for subject is \"resource owner\"). The authentication challenge is appended to the login provider URL to which the subject's user-agent (browser) is redirected to. The login provider uses that challenge to fetch information on the OAuth2 request and then accept or reject the requested authentication process. This endpoint tells ORY Hydra that the subject has not authenticated and includes a reason why the authentication was denied. The response contains a redirect URL which the login provider should redirect the user-agent to.
2380
-
2381
- ### Examples
2382
-
2383
- ```ruby
2384
- require 'time'
2385
- require 'ory-client'
2386
- # setup authorization
2387
- OryClient.configure do |config|
2388
- # Configure Bearer authorization: oryAccessToken
2389
- config.access_token = 'YOUR_BEARER_TOKEN'
2390
- end
2391
-
2392
- api_instance = OryClient::V0alpha2Api.new
2393
- login_challenge = 'login_challenge_example' # String |
2394
- opts = {
2395
- reject_o_auth2_request: OryClient::RejectOAuth2Request.new # RejectOAuth2Request |
2396
- }
2397
-
2398
- begin
2399
- # Reject an OAuth 2.0 Login Request
2400
- result = api_instance.admin_reject_o_auth2_login_request(login_challenge, opts)
2401
- p result
2402
- rescue OryClient::ApiError => e
2403
- puts "Error when calling V0alpha2Api->admin_reject_o_auth2_login_request: #{e}"
2404
- end
2405
- ```
2406
-
2407
- #### Using the admin_reject_o_auth2_login_request_with_http_info variant
2408
-
2409
- This returns an Array which contains the response data, status code and headers.
2410
-
2411
- > <Array(<SuccessfulOAuth2RequestResponse>, Integer, Hash)> admin_reject_o_auth2_login_request_with_http_info(login_challenge, opts)
2412
-
2413
- ```ruby
2414
- begin
2415
- # Reject an OAuth 2.0 Login Request
2416
- data, status_code, headers = api_instance.admin_reject_o_auth2_login_request_with_http_info(login_challenge, opts)
2417
- p status_code # => 2xx
2418
- p headers # => { ... }
2419
- p data # => <SuccessfulOAuth2RequestResponse>
2420
- rescue OryClient::ApiError => e
2421
- puts "Error when calling V0alpha2Api->admin_reject_o_auth2_login_request_with_http_info: #{e}"
2422
- end
2423
- ```
2424
-
2425
- ### Parameters
2426
-
2427
- | Name | Type | Description | Notes |
2428
- | ---- | ---- | ----------- | ----- |
2429
- | **login_challenge** | **String** | | |
2430
- | **reject_o_auth2_request** | [**RejectOAuth2Request**](RejectOAuth2Request.md) | | [optional] |
2431
-
2432
- ### Return type
2433
-
2434
- [**SuccessfulOAuth2RequestResponse**](SuccessfulOAuth2RequestResponse.md)
2435
-
2436
- ### Authorization
2437
-
2438
- [oryAccessToken](../README.md#oryAccessToken)
2439
-
2440
- ### HTTP request headers
2441
-
2442
- - **Content-Type**: application/json
2443
- - **Accept**: application/json
2444
-
2445
-
2446
- ## admin_reject_o_auth2_logout_request
2447
-
2448
- > admin_reject_o_auth2_logout_request(logout_challenge, opts)
2449
-
2450
- Reject an OAuth 2.0 Logout Request
2451
-
2452
- When a user or an application requests ORY Hydra to log out a user, this endpoint is used to deny that logout request. No body is required. The response is empty as the logout provider has to chose what action to perform next.
2453
-
2454
- ### Examples
2455
-
2456
- ```ruby
2457
- require 'time'
2458
- require 'ory-client'
2459
- # setup authorization
2460
- OryClient.configure do |config|
2461
- # Configure Bearer authorization: oryAccessToken
2462
- config.access_token = 'YOUR_BEARER_TOKEN'
2463
- end
2464
-
2465
- api_instance = OryClient::V0alpha2Api.new
2466
- logout_challenge = 'logout_challenge_example' # String |
2467
- opts = {
2468
- reject_o_auth2_request: OryClient::RejectOAuth2Request.new # RejectOAuth2Request |
2469
- }
2470
-
2471
- begin
2472
- # Reject an OAuth 2.0 Logout Request
2473
- api_instance.admin_reject_o_auth2_logout_request(logout_challenge, opts)
2474
- rescue OryClient::ApiError => e
2475
- puts "Error when calling V0alpha2Api->admin_reject_o_auth2_logout_request: #{e}"
2476
- end
2477
- ```
2478
-
2479
- #### Using the admin_reject_o_auth2_logout_request_with_http_info variant
2480
-
2481
- This returns an Array which contains the response data (`nil` in this case), status code and headers.
2482
-
2483
- > <Array(nil, Integer, Hash)> admin_reject_o_auth2_logout_request_with_http_info(logout_challenge, opts)
2484
-
2485
- ```ruby
2486
- begin
2487
- # Reject an OAuth 2.0 Logout Request
2488
- data, status_code, headers = api_instance.admin_reject_o_auth2_logout_request_with_http_info(logout_challenge, opts)
2489
- p status_code # => 2xx
2490
- p headers # => { ... }
2491
- p data # => nil
2492
- rescue OryClient::ApiError => e
2493
- puts "Error when calling V0alpha2Api->admin_reject_o_auth2_logout_request_with_http_info: #{e}"
2494
- end
2495
- ```
2496
-
2497
- ### Parameters
2498
-
2499
- | Name | Type | Description | Notes |
2500
- | ---- | ---- | ----------- | ----- |
2501
- | **logout_challenge** | **String** | | |
2502
- | **reject_o_auth2_request** | [**RejectOAuth2Request**](RejectOAuth2Request.md) | | [optional] |
2503
-
2504
- ### Return type
2505
-
2506
- nil (empty response body)
2507
-
2508
- ### Authorization
2509
-
2510
- [oryAccessToken](../README.md#oryAccessToken)
2511
-
2512
- ### HTTP request headers
2513
-
2514
- - **Content-Type**: application/json, application/x-www-form-urlencoded
2515
- - **Accept**: application/json
2516
-
2517
-
2518
- ## admin_revoke_o_auth2_consent_sessions
2519
-
2520
- > admin_revoke_o_auth2_consent_sessions(subject, opts)
2521
-
2522
- Revokes OAuth 2.0 Consent Sessions of a Subject for a Specific OAuth 2.0 Client
2523
-
2524
- This endpoint revokes a subject's granted consent sessions for a specific OAuth 2.0 Client and invalidates all associated OAuth 2.0 Access Tokens.
2525
-
2526
- ### Examples
2527
-
2528
- ```ruby
2529
- require 'time'
2530
- require 'ory-client'
2531
- # setup authorization
2532
- OryClient.configure do |config|
2533
- # Configure Bearer authorization: oryAccessToken
2534
- config.access_token = 'YOUR_BEARER_TOKEN'
2535
- end
2536
-
2537
- api_instance = OryClient::V0alpha2Api.new
2538
- subject = 'subject_example' # String | The subject (Subject) whose consent sessions should be deleted.
2539
- opts = {
2540
- client: 'client_example', # String | If set, deletes only those consent sessions by the Subject that have been granted to the specified OAuth 2.0 Client ID
2541
- all: true # Boolean | If set to `true` deletes all consent sessions by the Subject that have been granted.
2542
- }
2543
-
2544
- begin
2545
- # Revokes OAuth 2.0 Consent Sessions of a Subject for a Specific OAuth 2.0 Client
2546
- api_instance.admin_revoke_o_auth2_consent_sessions(subject, opts)
2547
- rescue OryClient::ApiError => e
2548
- puts "Error when calling V0alpha2Api->admin_revoke_o_auth2_consent_sessions: #{e}"
2549
- end
2550
- ```
2551
-
2552
- #### Using the admin_revoke_o_auth2_consent_sessions_with_http_info variant
2553
-
2554
- This returns an Array which contains the response data (`nil` in this case), status code and headers.
2555
-
2556
- > <Array(nil, Integer, Hash)> admin_revoke_o_auth2_consent_sessions_with_http_info(subject, opts)
2557
-
2558
- ```ruby
2559
- begin
2560
- # Revokes OAuth 2.0 Consent Sessions of a Subject for a Specific OAuth 2.0 Client
2561
- data, status_code, headers = api_instance.admin_revoke_o_auth2_consent_sessions_with_http_info(subject, opts)
2562
- p status_code # => 2xx
2563
- p headers # => { ... }
2564
- p data # => nil
2565
- rescue OryClient::ApiError => e
2566
- puts "Error when calling V0alpha2Api->admin_revoke_o_auth2_consent_sessions_with_http_info: #{e}"
2567
- end
2568
- ```
2569
-
2570
- ### Parameters
2571
-
2572
- | Name | Type | Description | Notes |
2573
- | ---- | ---- | ----------- | ----- |
2574
- | **subject** | **String** | The subject (Subject) whose consent sessions should be deleted. | |
2575
- | **client** | **String** | If set, deletes only those consent sessions by the Subject that have been granted to the specified OAuth 2.0 Client ID | [optional] |
2576
- | **all** | **Boolean** | If set to &#x60;true&#x60; deletes all consent sessions by the Subject that have been granted. | [optional] |
2577
-
2578
- ### Return type
2579
-
2580
- nil (empty response body)
2581
-
2582
- ### Authorization
2583
-
2584
- [oryAccessToken](../README.md#oryAccessToken)
2585
-
2586
- ### HTTP request headers
2587
-
2588
- - **Content-Type**: Not defined
2589
- - **Accept**: application/json
2590
-
2591
-
2592
- ## admin_revoke_o_auth2_login_sessions
2593
-
2594
- > admin_revoke_o_auth2_login_sessions(subject)
2595
-
2596
- Invalidates All OAuth 2.0 Login Sessions of a Certain User
2597
-
2598
- This endpoint invalidates a subject's authentication session. After revoking the authentication session, the subject has to re-authenticate at ORY Hydra. This endpoint does not invalidate any tokens and does not work with OpenID Connect Front- or Back-channel logout.
2599
-
2600
- ### Examples
2601
-
2602
- ```ruby
2603
- require 'time'
2604
- require 'ory-client'
2605
- # setup authorization
2606
- OryClient.configure do |config|
2607
- # Configure Bearer authorization: oryAccessToken
2608
- config.access_token = 'YOUR_BEARER_TOKEN'
2609
- end
2610
-
2611
- api_instance = OryClient::V0alpha2Api.new
2612
- subject = 'subject_example' # String | The subject to revoke authentication sessions for.
2613
-
2614
- begin
2615
- # Invalidates All OAuth 2.0 Login Sessions of a Certain User
2616
- api_instance.admin_revoke_o_auth2_login_sessions(subject)
2617
- rescue OryClient::ApiError => e
2618
- puts "Error when calling V0alpha2Api->admin_revoke_o_auth2_login_sessions: #{e}"
2619
- end
2620
- ```
2621
-
2622
- #### Using the admin_revoke_o_auth2_login_sessions_with_http_info variant
2623
-
2624
- This returns an Array which contains the response data (`nil` in this case), status code and headers.
2625
-
2626
- > <Array(nil, Integer, Hash)> admin_revoke_o_auth2_login_sessions_with_http_info(subject)
2627
-
2628
- ```ruby
2629
- begin
2630
- # Invalidates All OAuth 2.0 Login Sessions of a Certain User
2631
- data, status_code, headers = api_instance.admin_revoke_o_auth2_login_sessions_with_http_info(subject)
2632
- p status_code # => 2xx
2633
- p headers # => { ... }
2634
- p data # => nil
2635
- rescue OryClient::ApiError => e
2636
- puts "Error when calling V0alpha2Api->admin_revoke_o_auth2_login_sessions_with_http_info: #{e}"
2637
- end
2638
- ```
2639
-
2640
- ### Parameters
2641
-
2642
- | Name | Type | Description | Notes |
2643
- | ---- | ---- | ----------- | ----- |
2644
- | **subject** | **String** | The subject to revoke authentication sessions for. | |
2645
-
2646
- ### Return type
2647
-
2648
- nil (empty response body)
2649
-
2650
- ### Authorization
2651
-
2652
- [oryAccessToken](../README.md#oryAccessToken)
2653
-
2654
- ### HTTP request headers
2655
-
2656
- - **Content-Type**: Not defined
2657
- - **Accept**: application/json
2658
-
2659
-
2660
- ## admin_trust_o_auth2_jwt_grant_issuer
2661
-
2662
- > <TrustedOAuth2JwtGrantIssuer> admin_trust_o_auth2_jwt_grant_issuer(opts)
2663
-
2664
- Trust an OAuth2 JWT Bearer Grant Type Issuer
2665
-
2666
- Use this endpoint to establish a trust relationship for a JWT issuer to perform JSON Web Token (JWT) Profile for OAuth 2.0 Client Authentication and Authorization Grants [RFC7523](https://datatracker.ietf.org/doc/html/rfc7523).
2667
-
2668
- ### Examples
2669
-
2670
- ```ruby
2671
- require 'time'
2672
- require 'ory-client'
2673
- # setup authorization
2674
- OryClient.configure do |config|
2675
- # Configure Bearer authorization: oryAccessToken
2676
- config.access_token = 'YOUR_BEARER_TOKEN'
2677
- end
2678
-
2679
- api_instance = OryClient::V0alpha2Api.new
2680
- opts = {
2681
- admin_trust_o_auth2_jwt_grant_issuer_body: OryClient::AdminTrustOAuth2JwtGrantIssuerBody.new({expires_at: Time.now, issuer: 'https://jwt-idp.example.com', jwk: OryClient::JsonWebKey.new({alg: 'RS256', kid: '1603dfe0af8f4596', kty: 'RSA', use: 'sig'}), scope: ["openid", "offline"]}) # AdminTrustOAuth2JwtGrantIssuerBody |
2682
- }
2683
-
2684
- begin
2685
- # Trust an OAuth2 JWT Bearer Grant Type Issuer
2686
- result = api_instance.admin_trust_o_auth2_jwt_grant_issuer(opts)
2687
- p result
2688
- rescue OryClient::ApiError => e
2689
- puts "Error when calling V0alpha2Api->admin_trust_o_auth2_jwt_grant_issuer: #{e}"
2690
- end
2691
- ```
2692
-
2693
- #### Using the admin_trust_o_auth2_jwt_grant_issuer_with_http_info variant
2694
-
2695
- This returns an Array which contains the response data, status code and headers.
2696
-
2697
- > <Array(<TrustedOAuth2JwtGrantIssuer>, Integer, Hash)> admin_trust_o_auth2_jwt_grant_issuer_with_http_info(opts)
2698
-
2699
- ```ruby
2700
- begin
2701
- # Trust an OAuth2 JWT Bearer Grant Type Issuer
2702
- data, status_code, headers = api_instance.admin_trust_o_auth2_jwt_grant_issuer_with_http_info(opts)
2703
- p status_code # => 2xx
2704
- p headers # => { ... }
2705
- p data # => <TrustedOAuth2JwtGrantIssuer>
2706
- rescue OryClient::ApiError => e
2707
- puts "Error when calling V0alpha2Api->admin_trust_o_auth2_jwt_grant_issuer_with_http_info: #{e}"
2708
- end
2709
- ```
2710
-
2711
- ### Parameters
2712
-
2713
- | Name | Type | Description | Notes |
2714
- | ---- | ---- | ----------- | ----- |
2715
- | **admin_trust_o_auth2_jwt_grant_issuer_body** | [**AdminTrustOAuth2JwtGrantIssuerBody**](AdminTrustOAuth2JwtGrantIssuerBody.md) | | [optional] |
2716
-
2717
- ### Return type
2718
-
2719
- [**TrustedOAuth2JwtGrantIssuer**](TrustedOAuth2JwtGrantIssuer.md)
2720
-
2721
- ### Authorization
2722
-
2723
- [oryAccessToken](../README.md#oryAccessToken)
2724
-
2725
- ### HTTP request headers
2726
-
2727
- - **Content-Type**: application/json
2728
- - **Accept**: application/json
2729
-
2730
-
2731
- ## admin_update_identity
2732
-
2733
- > <Identity> admin_update_identity(id, opts)
2734
-
2735
- Update an Identity
2736
-
2737
- This endpoint updates an identity. The full identity payload (except credentials) is expected. This endpoint does not support patching. Learn how identities work in [Ory Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
2738
-
2739
- ### Examples
2740
-
2741
- ```ruby
2742
- require 'time'
2743
- require 'ory-client'
2744
- # setup authorization
2745
- OryClient.configure do |config|
2746
- # Configure Bearer authorization: oryAccessToken
2747
- config.access_token = 'YOUR_BEARER_TOKEN'
2748
- end
2749
-
2750
- api_instance = OryClient::V0alpha2Api.new
2751
- id = 'id_example' # String | ID must be set to the ID of identity you want to update
2752
- opts = {
2753
- admin_update_identity_body: OryClient::AdminUpdateIdentityBody.new({schema_id: 'schema_id_example', state: OryClient::IdentityState::ACTIVE, traits: 3.56}) # AdminUpdateIdentityBody |
2754
- }
2755
-
2756
- begin
2757
- # Update an Identity
2758
- result = api_instance.admin_update_identity(id, opts)
2759
- p result
2760
- rescue OryClient::ApiError => e
2761
- puts "Error when calling V0alpha2Api->admin_update_identity: #{e}"
2762
- end
2763
- ```
2764
-
2765
- #### Using the admin_update_identity_with_http_info variant
2766
-
2767
- This returns an Array which contains the response data, status code and headers.
2768
-
2769
- > <Array(<Identity>, Integer, Hash)> admin_update_identity_with_http_info(id, opts)
2770
-
2771
- ```ruby
2772
- begin
2773
- # Update an Identity
2774
- data, status_code, headers = api_instance.admin_update_identity_with_http_info(id, opts)
2775
- p status_code # => 2xx
2776
- p headers # => { ... }
2777
- p data # => <Identity>
2778
- rescue OryClient::ApiError => e
2779
- puts "Error when calling V0alpha2Api->admin_update_identity_with_http_info: #{e}"
2780
- end
2781
- ```
2782
-
2783
- ### Parameters
2784
-
2785
- | Name | Type | Description | Notes |
2786
- | ---- | ---- | ----------- | ----- |
2787
- | **id** | **String** | ID must be set to the ID of identity you want to update | |
2788
- | **admin_update_identity_body** | [**AdminUpdateIdentityBody**](AdminUpdateIdentityBody.md) | | [optional] |
2789
-
2790
- ### Return type
2791
-
2792
- [**Identity**](Identity.md)
2793
-
2794
- ### Authorization
2795
-
2796
- [oryAccessToken](../README.md#oryAccessToken)
2797
-
2798
- ### HTTP request headers
2799
-
2800
- - **Content-Type**: application/json
2801
- - **Accept**: application/json
2802
-
2803
-
2804
- ## admin_update_json_web_key
2805
-
2806
- > <JsonWebKey> admin_update_json_web_key(set, kid, opts)
2807
-
2808
- Update a JSON Web Key
2809
-
2810
- Use this method if you do not want to let Hydra generate the JWKs for you, but instead save your own. A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing user-defined keys as well.
2811
-
2812
- ### Examples
2813
-
2814
- ```ruby
2815
- require 'time'
2816
- require 'ory-client'
2817
- # setup authorization
2818
- OryClient.configure do |config|
2819
- # Configure Bearer authorization: oryAccessToken
2820
- config.access_token = 'YOUR_BEARER_TOKEN'
2821
- end
2822
-
2823
- api_instance = OryClient::V0alpha2Api.new
2824
- set = 'set_example' # String | The JSON Web Key Set
2825
- kid = 'kid_example' # String | The JSON Web Key ID (kid)
2826
- opts = {
2827
- json_web_key: OryClient::JsonWebKey.new({alg: 'RS256', kid: '1603dfe0af8f4596', kty: 'RSA', use: 'sig'}) # JsonWebKey |
2828
- }
2829
-
2830
- begin
2831
- # Update a JSON Web Key
2832
- result = api_instance.admin_update_json_web_key(set, kid, opts)
2833
- p result
2834
- rescue OryClient::ApiError => e
2835
- puts "Error when calling V0alpha2Api->admin_update_json_web_key: #{e}"
2836
- end
2837
- ```
2838
-
2839
- #### Using the admin_update_json_web_key_with_http_info variant
2840
-
2841
- This returns an Array which contains the response data, status code and headers.
2842
-
2843
- > <Array(<JsonWebKey>, Integer, Hash)> admin_update_json_web_key_with_http_info(set, kid, opts)
2844
-
2845
- ```ruby
2846
- begin
2847
- # Update a JSON Web Key
2848
- data, status_code, headers = api_instance.admin_update_json_web_key_with_http_info(set, kid, opts)
2849
- p status_code # => 2xx
2850
- p headers # => { ... }
2851
- p data # => <JsonWebKey>
2852
- rescue OryClient::ApiError => e
2853
- puts "Error when calling V0alpha2Api->admin_update_json_web_key_with_http_info: #{e}"
2854
- end
2855
- ```
2856
-
2857
- ### Parameters
2858
-
2859
- | Name | Type | Description | Notes |
2860
- | ---- | ---- | ----------- | ----- |
2861
- | **set** | **String** | The JSON Web Key Set | |
2862
- | **kid** | **String** | The JSON Web Key ID (kid) | |
2863
- | **json_web_key** | [**JsonWebKey**](JsonWebKey.md) | | [optional] |
2864
-
2865
- ### Return type
2866
-
2867
- [**JsonWebKey**](JsonWebKey.md)
2868
-
2869
- ### Authorization
2870
-
2871
- [oryAccessToken](../README.md#oryAccessToken)
2872
-
2873
- ### HTTP request headers
2874
-
2875
- - **Content-Type**: application/json
2876
- - **Accept**: application/json
2877
-
2878
-
2879
- ## admin_update_json_web_key_set
2880
-
2881
- > <JsonWebKeySet> admin_update_json_web_key_set(set, opts)
2882
-
2883
- Update a JSON Web Key Set
2884
-
2885
- Use this method if you do not want to let Hydra generate the JWKs for you, but instead save your own. A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing user-defined keys as well.
2886
-
2887
- ### Examples
2888
-
2889
- ```ruby
2890
- require 'time'
2891
- require 'ory-client'
2892
- # setup authorization
2893
- OryClient.configure do |config|
2894
- # Configure Bearer authorization: oryAccessToken
2895
- config.access_token = 'YOUR_BEARER_TOKEN'
2896
- end
2897
-
2898
- api_instance = OryClient::V0alpha2Api.new
2899
- set = 'set_example' # String | The JSON Web Key Set
2900
- opts = {
2901
- json_web_key_set: OryClient::JsonWebKeySet.new # JsonWebKeySet |
2902
- }
2903
-
2904
- begin
2905
- # Update a JSON Web Key Set
2906
- result = api_instance.admin_update_json_web_key_set(set, opts)
2907
- p result
2908
- rescue OryClient::ApiError => e
2909
- puts "Error when calling V0alpha2Api->admin_update_json_web_key_set: #{e}"
2910
- end
2911
- ```
2912
-
2913
- #### Using the admin_update_json_web_key_set_with_http_info variant
2914
-
2915
- This returns an Array which contains the response data, status code and headers.
2916
-
2917
- > <Array(<JsonWebKeySet>, Integer, Hash)> admin_update_json_web_key_set_with_http_info(set, opts)
2918
-
2919
- ```ruby
2920
- begin
2921
- # Update a JSON Web Key Set
2922
- data, status_code, headers = api_instance.admin_update_json_web_key_set_with_http_info(set, opts)
2923
- p status_code # => 2xx
2924
- p headers # => { ... }
2925
- p data # => <JsonWebKeySet>
2926
- rescue OryClient::ApiError => e
2927
- puts "Error when calling V0alpha2Api->admin_update_json_web_key_set_with_http_info: #{e}"
2928
- end
2929
- ```
2930
-
2931
- ### Parameters
2932
-
2933
- | Name | Type | Description | Notes |
2934
- | ---- | ---- | ----------- | ----- |
2935
- | **set** | **String** | The JSON Web Key Set | |
2936
- | **json_web_key_set** | [**JsonWebKeySet**](JsonWebKeySet.md) | | [optional] |
2937
-
2938
- ### Return type
2939
-
2940
- [**JsonWebKeySet**](JsonWebKeySet.md)
2941
-
2942
- ### Authorization
2943
-
2944
- [oryAccessToken](../README.md#oryAccessToken)
2945
-
2946
- ### HTTP request headers
2947
-
2948
- - **Content-Type**: application/json
2949
- - **Accept**: application/json
2950
-
2951
-
2952
- ## admin_update_o_auth2_client
2953
-
2954
- > <OAuth2Client> admin_update_o_auth2_client(id, o_auth2_client)
2955
-
2956
- Update an OAuth 2.0 Client
2957
-
2958
- Update an existing OAuth 2.0 Client. If you pass `client_secret` the secret is used, otherwise a random secret is generated. The secret is echoed in the response. It is not possible to retrieve it later on. OAuth 2.0 clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are generated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities.
2959
-
2960
- ### Examples
2961
-
2962
- ```ruby
2963
- require 'time'
2964
- require 'ory-client'
2965
- # setup authorization
2966
- OryClient.configure do |config|
2967
- # Configure Bearer authorization: oryAccessToken
2968
- config.access_token = 'YOUR_BEARER_TOKEN'
2969
- end
2970
-
2971
- api_instance = OryClient::V0alpha2Api.new
2972
- id = 'id_example' # String | The id of the OAuth 2.0 Client.
2973
- o_auth2_client = OryClient::OAuth2Client.new # OAuth2Client |
2974
-
2975
- begin
2976
- # Update an OAuth 2.0 Client
2977
- result = api_instance.admin_update_o_auth2_client(id, o_auth2_client)
2978
- p result
2979
- rescue OryClient::ApiError => e
2980
- puts "Error when calling V0alpha2Api->admin_update_o_auth2_client: #{e}"
2981
- end
2982
- ```
2983
-
2984
- #### Using the admin_update_o_auth2_client_with_http_info variant
2985
-
2986
- This returns an Array which contains the response data, status code and headers.
2987
-
2988
- > <Array(<OAuth2Client>, Integer, Hash)> admin_update_o_auth2_client_with_http_info(id, o_auth2_client)
2989
-
2990
- ```ruby
2991
- begin
2992
- # Update an OAuth 2.0 Client
2993
- data, status_code, headers = api_instance.admin_update_o_auth2_client_with_http_info(id, o_auth2_client)
2994
- p status_code # => 2xx
2995
- p headers # => { ... }
2996
- p data # => <OAuth2Client>
2997
- rescue OryClient::ApiError => e
2998
- puts "Error when calling V0alpha2Api->admin_update_o_auth2_client_with_http_info: #{e}"
2999
- end
3000
- ```
3001
-
3002
- ### Parameters
3003
-
3004
- | Name | Type | Description | Notes |
3005
- | ---- | ---- | ----------- | ----- |
3006
- | **id** | **String** | The id of the OAuth 2.0 Client. | |
3007
- | **o_auth2_client** | [**OAuth2Client**](OAuth2Client.md) | | |
3008
-
3009
- ### Return type
3010
-
3011
- [**OAuth2Client**](OAuth2Client.md)
3012
-
3013
- ### Authorization
3014
-
3015
- [oryAccessToken](../README.md#oryAccessToken)
3016
-
3017
- ### HTTP request headers
3018
-
3019
- - **Content-Type**: application/json
3020
- - **Accept**: application/json
3021
-
3022
-
3023
- ## create_project
3024
-
3025
- > <Project> create_project(opts)
3026
-
3027
- Create a Project
3028
-
3029
- Creates a new project.
3030
-
3031
- ### Examples
3032
-
3033
- ```ruby
3034
- require 'time'
3035
- require 'ory-client'
3036
- # setup authorization
3037
- OryClient.configure do |config|
3038
- # Configure Bearer authorization: oryAccessToken
3039
- config.access_token = 'YOUR_BEARER_TOKEN'
3040
- end
3041
-
3042
- api_instance = OryClient::V0alpha2Api.new
3043
- opts = {
3044
- create_project_body: OryClient::CreateProjectBody.new({name: 'name_example'}) # CreateProjectBody |
3045
- }
3046
-
3047
- begin
3048
- # Create a Project
3049
- result = api_instance.create_project(opts)
3050
- p result
3051
- rescue OryClient::ApiError => e
3052
- puts "Error when calling V0alpha2Api->create_project: #{e}"
3053
- end
3054
- ```
3055
-
3056
- #### Using the create_project_with_http_info variant
3057
-
3058
- This returns an Array which contains the response data, status code and headers.
3059
-
3060
- > <Array(<Project>, Integer, Hash)> create_project_with_http_info(opts)
3061
-
3062
- ```ruby
3063
- begin
3064
- # Create a Project
3065
- data, status_code, headers = api_instance.create_project_with_http_info(opts)
3066
- p status_code # => 2xx
3067
- p headers # => { ... }
3068
- p data # => <Project>
3069
- rescue OryClient::ApiError => e
3070
- puts "Error when calling V0alpha2Api->create_project_with_http_info: #{e}"
3071
- end
3072
- ```
3073
-
3074
- ### Parameters
3075
-
3076
- | Name | Type | Description | Notes |
3077
- | ---- | ---- | ----------- | ----- |
3078
- | **create_project_body** | [**CreateProjectBody**](CreateProjectBody.md) | | [optional] |
3079
-
3080
- ### Return type
3081
-
3082
- [**Project**](Project.md)
3083
-
3084
- ### Authorization
3085
-
3086
- [oryAccessToken](../README.md#oryAccessToken)
3087
-
3088
- ### HTTP request headers
3089
-
3090
- - **Content-Type**: application/json
3091
- - **Accept**: application/json
3092
-
3093
-
3094
- ## create_self_service_logout_flow_url_for_browsers
3095
-
3096
- > <SelfServiceLogoutUrl> create_self_service_logout_flow_url_for_browsers(opts)
3097
-
3098
- Create a Logout URL for Browsers
3099
-
3100
- This endpoint initializes a browser-based user logout flow and a URL which can be used to log out the user. This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). For API clients you can call the `/self-service/logout/api` URL directly with the Ory Session Token. The URL is only valid for the currently signed in user. If no user is signed in, this endpoint returns a 401 error. When calling this endpoint from a backend, please ensure to properly forward the HTTP cookies.
3101
-
3102
- ### Examples
3103
-
3104
- ```ruby
3105
- require 'time'
3106
- require 'ory-client'
3107
-
3108
- api_instance = OryClient::V0alpha2Api.new
3109
- opts = {
3110
- cookie: 'cookie_example' # String | HTTP Cookies If you call this endpoint from a backend, please include the original Cookie header in the request.
3111
- }
3112
-
3113
- begin
3114
- # Create a Logout URL for Browsers
3115
- result = api_instance.create_self_service_logout_flow_url_for_browsers(opts)
730
+ # Update an Identity
731
+ result = api_instance.admin_update_identity(id, opts)
3116
732
  p result
3117
733
  rescue OryClient::ApiError => e
3118
- puts "Error when calling V0alpha2Api->create_self_service_logout_flow_url_for_browsers: #{e}"
734
+ puts "Error when calling V0alpha2Api->admin_update_identity: #{e}"
3119
735
  end
3120
736
  ```
3121
737
 
3122
- #### Using the create_self_service_logout_flow_url_for_browsers_with_http_info variant
738
+ #### Using the admin_update_identity_with_http_info variant
3123
739
 
3124
740
  This returns an Array which contains the response data, status code and headers.
3125
741
 
3126
- > <Array(<SelfServiceLogoutUrl>, Integer, Hash)> create_self_service_logout_flow_url_for_browsers_with_http_info(opts)
742
+ > <Array(<Identity>, Integer, Hash)> admin_update_identity_with_http_info(id, opts)
3127
743
 
3128
744
  ```ruby
3129
745
  begin
3130
- # Create a Logout URL for Browsers
3131
- data, status_code, headers = api_instance.create_self_service_logout_flow_url_for_browsers_with_http_info(opts)
746
+ # Update an Identity
747
+ data, status_code, headers = api_instance.admin_update_identity_with_http_info(id, opts)
3132
748
  p status_code # => 2xx
3133
749
  p headers # => { ... }
3134
- p data # => <SelfServiceLogoutUrl>
750
+ p data # => <Identity>
3135
751
  rescue OryClient::ApiError => e
3136
- puts "Error when calling V0alpha2Api->create_self_service_logout_flow_url_for_browsers_with_http_info: #{e}"
752
+ puts "Error when calling V0alpha2Api->admin_update_identity_with_http_info: #{e}"
3137
753
  end
3138
754
  ```
3139
755
 
@@ -3141,185 +757,71 @@ end
3141
757
 
3142
758
  | Name | Type | Description | Notes |
3143
759
  | ---- | ---- | ----------- | ----- |
3144
- | **cookie** | **String** | HTTP Cookies If you call this endpoint from a backend, please include the original Cookie header in the request. | [optional] |
3145
-
3146
- ### Return type
3147
-
3148
- [**SelfServiceLogoutUrl**](SelfServiceLogoutUrl.md)
3149
-
3150
- ### Authorization
3151
-
3152
- No authorization required
3153
-
3154
- ### HTTP request headers
3155
-
3156
- - **Content-Type**: Not defined
3157
- - **Accept**: application/json
3158
-
3159
-
3160
- ## discover_json_web_keys
3161
-
3162
- > <JsonWebKeySet> discover_json_web_keys
3163
-
3164
- Discover JSON Web Keys
3165
-
3166
- This endpoint returns JSON Web Keys required to verifying OpenID Connect ID Tokens and, if enabled, OAuth 2.0 JWT Access Tokens. This endpoint can be used with client libraries like [node-jwks-rsa](https://github.com/auth0/node-jwks-rsa) among others.
3167
-
3168
- ### Examples
3169
-
3170
- ```ruby
3171
- require 'time'
3172
- require 'ory-client'
3173
-
3174
- api_instance = OryClient::V0alpha2Api.new
3175
-
3176
- begin
3177
- # Discover JSON Web Keys
3178
- result = api_instance.discover_json_web_keys
3179
- p result
3180
- rescue OryClient::ApiError => e
3181
- puts "Error when calling V0alpha2Api->discover_json_web_keys: #{e}"
3182
- end
3183
- ```
3184
-
3185
- #### Using the discover_json_web_keys_with_http_info variant
3186
-
3187
- This returns an Array which contains the response data, status code and headers.
3188
-
3189
- > <Array(<JsonWebKeySet>, Integer, Hash)> discover_json_web_keys_with_http_info
3190
-
3191
- ```ruby
3192
- begin
3193
- # Discover JSON Web Keys
3194
- data, status_code, headers = api_instance.discover_json_web_keys_with_http_info
3195
- p status_code # => 2xx
3196
- p headers # => { ... }
3197
- p data # => <JsonWebKeySet>
3198
- rescue OryClient::ApiError => e
3199
- puts "Error when calling V0alpha2Api->discover_json_web_keys_with_http_info: #{e}"
3200
- end
3201
- ```
3202
-
3203
- ### Parameters
3204
-
3205
- This endpoint does not need any parameter.
760
+ | **id** | **String** | ID must be set to the ID of identity you want to update | |
761
+ | **admin_update_identity_body** | [**AdminUpdateIdentityBody**](AdminUpdateIdentityBody.md) | | [optional] |
3206
762
 
3207
763
  ### Return type
3208
764
 
3209
- [**JsonWebKeySet**](JsonWebKeySet.md)
765
+ [**Identity**](Identity.md)
3210
766
 
3211
767
  ### Authorization
3212
768
 
3213
- No authorization required
769
+ [oryAccessToken](../README.md#oryAccessToken)
3214
770
 
3215
771
  ### HTTP request headers
3216
772
 
3217
- - **Content-Type**: Not defined
773
+ - **Content-Type**: application/json
3218
774
  - **Accept**: application/json
3219
775
 
3220
776
 
3221
- ## discover_oidc_configuration
777
+ ## create_project
3222
778
 
3223
- > <OidcConfiguration> discover_oidc_configuration
779
+ > <Project> create_project(opts)
3224
780
 
3225
- OpenID Connect Discovery
781
+ # Create a Project
3226
782
 
3227
- The well known endpoint an be used to retrieve information for OpenID Connect clients. We encourage you to not roll your own OpenID Connect client but to use an OpenID Connect client library instead. You can learn more on this flow at https://openid.net/specs/openid-connect-discovery-1_0.html . Popular libraries for OpenID Connect clients include oidc-client-js (JavaScript), go-oidc (Golang), and others. For a full list of clients go here: https://openid.net/developers/certified/
783
+ Creates a new project.
3228
784
 
3229
785
  ### Examples
3230
786
 
3231
787
  ```ruby
3232
788
  require 'time'
3233
789
  require 'ory-client'
3234
-
3235
- api_instance = OryClient::V0alpha2Api.new
3236
-
3237
- begin
3238
- # OpenID Connect Discovery
3239
- result = api_instance.discover_oidc_configuration
3240
- p result
3241
- rescue OryClient::ApiError => e
3242
- puts "Error when calling V0alpha2Api->discover_oidc_configuration: #{e}"
3243
- end
3244
- ```
3245
-
3246
- #### Using the discover_oidc_configuration_with_http_info variant
3247
-
3248
- This returns an Array which contains the response data, status code and headers.
3249
-
3250
- > <Array(<OidcConfiguration>, Integer, Hash)> discover_oidc_configuration_with_http_info
3251
-
3252
- ```ruby
3253
- begin
3254
- # OpenID Connect Discovery
3255
- data, status_code, headers = api_instance.discover_oidc_configuration_with_http_info
3256
- p status_code # => 2xx
3257
- p headers # => { ... }
3258
- p data # => <OidcConfiguration>
3259
- rescue OryClient::ApiError => e
3260
- puts "Error when calling V0alpha2Api->discover_oidc_configuration_with_http_info: #{e}"
790
+ # setup authorization
791
+ OryClient.configure do |config|
792
+ # Configure Bearer authorization: oryAccessToken
793
+ config.access_token = 'YOUR_BEARER_TOKEN'
3261
794
  end
3262
- ```
3263
-
3264
- ### Parameters
3265
-
3266
- This endpoint does not need any parameter.
3267
-
3268
- ### Return type
3269
-
3270
- [**OidcConfiguration**](OidcConfiguration.md)
3271
-
3272
- ### Authorization
3273
-
3274
- No authorization required
3275
-
3276
- ### HTTP request headers
3277
-
3278
- - **Content-Type**: Not defined
3279
- - **Accept**: application/json
3280
-
3281
-
3282
- ## dynamic_client_registration_create_o_auth2_client
3283
-
3284
- > <OAuth2Client> dynamic_client_registration_create_o_auth2_client(o_auth2_client)
3285
-
3286
- Register an OAuth 2.0 Client using the OpenID / OAuth2 Dynamic Client Registration Management Protocol
3287
-
3288
- This endpoint behaves like the administrative counterpart (`createOAuth2Client`) but is capable of facing the public internet directly and can be used in self-service. It implements the OpenID Connect Dynamic Client Registration Protocol. This feature needs to be enabled in the configuration. This endpoint is disabled by default. It can be enabled by an administrator. Please note that using this endpoint you are not able to choose the `client_secret` nor the `client_id` as those values will be server generated when specifying `token_endpoint_auth_method` as `client_secret_basic` or `client_secret_post`. The `client_secret` will be returned in the response and you will not be able to retrieve it later on. Write the secret down and keep it somewhere safe.
3289
-
3290
- ### Examples
3291
-
3292
- ```ruby
3293
- require 'time'
3294
- require 'ory-client'
3295
795
 
3296
796
  api_instance = OryClient::V0alpha2Api.new
3297
- o_auth2_client = OryClient::OAuth2Client.new # OAuth2Client |
797
+ opts = {
798
+ create_project_body: OryClient::CreateProjectBody.new({name: 'name_example'}) # CreateProjectBody |
799
+ }
3298
800
 
3299
801
  begin
3300
- # Register an OAuth 2.0 Client using the OpenID / OAuth2 Dynamic Client Registration Management Protocol
3301
- result = api_instance.dynamic_client_registration_create_o_auth2_client(o_auth2_client)
802
+ # # Create a Project
803
+ result = api_instance.create_project(opts)
3302
804
  p result
3303
805
  rescue OryClient::ApiError => e
3304
- puts "Error when calling V0alpha2Api->dynamic_client_registration_create_o_auth2_client: #{e}"
806
+ puts "Error when calling V0alpha2Api->create_project: #{e}"
3305
807
  end
3306
808
  ```
3307
809
 
3308
- #### Using the dynamic_client_registration_create_o_auth2_client_with_http_info variant
810
+ #### Using the create_project_with_http_info variant
3309
811
 
3310
812
  This returns an Array which contains the response data, status code and headers.
3311
813
 
3312
- > <Array(<OAuth2Client>, Integer, Hash)> dynamic_client_registration_create_o_auth2_client_with_http_info(o_auth2_client)
814
+ > <Array(<Project>, Integer, Hash)> create_project_with_http_info(opts)
3313
815
 
3314
816
  ```ruby
3315
817
  begin
3316
- # Register an OAuth 2.0 Client using the OpenID / OAuth2 Dynamic Client Registration Management Protocol
3317
- data, status_code, headers = api_instance.dynamic_client_registration_create_o_auth2_client_with_http_info(o_auth2_client)
818
+ # # Create a Project
819
+ data, status_code, headers = api_instance.create_project_with_http_info(opts)
3318
820
  p status_code # => 2xx
3319
821
  p headers # => { ... }
3320
- p data # => <OAuth2Client>
822
+ p data # => <Project>
3321
823
  rescue OryClient::ApiError => e
3322
- puts "Error when calling V0alpha2Api->dynamic_client_registration_create_o_auth2_client_with_http_info: #{e}"
824
+ puts "Error when calling V0alpha2Api->create_project_with_http_info: #{e}"
3323
825
  end
3324
826
  ```
3325
827
 
@@ -3327,15 +829,15 @@ end
3327
829
 
3328
830
  | Name | Type | Description | Notes |
3329
831
  | ---- | ---- | ----------- | ----- |
3330
- | **o_auth2_client** | [**OAuth2Client**](OAuth2Client.md) | | |
832
+ | **create_project_body** | [**CreateProjectBody**](CreateProjectBody.md) | | [optional] |
3331
833
 
3332
834
  ### Return type
3333
835
 
3334
- [**OAuth2Client**](OAuth2Client.md)
836
+ [**Project**](Project.md)
3335
837
 
3336
838
  ### Authorization
3337
839
 
3338
- No authorization required
840
+ [oryAccessToken](../README.md#oryAccessToken)
3339
841
 
3340
842
  ### HTTP request headers
3341
843
 
@@ -3343,13 +845,13 @@ No authorization required
3343
845
  - **Accept**: application/json
3344
846
 
3345
847
 
3346
- ## dynamic_client_registration_delete_o_auth2_client
848
+ ## create_project_api_key
3347
849
 
3348
- > dynamic_client_registration_delete_o_auth2_client(id)
850
+ > <ProjectApiKey> create_project_api_key(project, opts)
3349
851
 
3350
- Deletes an OAuth 2.0 Client using the OpenID / OAuth2 Dynamic Client Registration Management Protocol
852
+ # Create API Token
3351
853
 
3352
- This endpoint behaves like the administrative counterpart (`deleteOAuth2Client`) but is capable of facing the public internet directly and can be used in self-service. It implements the OpenID Connect Dynamic Client Registration Protocol. This feature needs to be enabled in the configuration. This endpoint is disabled by default. It can be enabled by an administrator. To use this endpoint, you will need to present the client's authentication credentials. If the OAuth2 Client uses the Token Endpoint Authentication Method `client_secret_post`, you need to present the client secret in the URL query. If it uses `client_secret_basic`, present the Client ID and the Client Secret in the Authorization header. OAuth 2.0 clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are generated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities.
854
+ Create an API token for a project.
3353
855
 
3354
856
  ### Examples
3355
857
 
@@ -3358,36 +860,40 @@ require 'time'
3358
860
  require 'ory-client'
3359
861
  # setup authorization
3360
862
  OryClient.configure do |config|
3361
- # Configure Bearer authorization: bearer
863
+ # Configure Bearer authorization: oryAccessToken
3362
864
  config.access_token = 'YOUR_BEARER_TOKEN'
3363
865
  end
3364
866
 
3365
867
  api_instance = OryClient::V0alpha2Api.new
3366
- id = 'id_example' # String | The id of the OAuth 2.0 Client.
868
+ project = 'project_example' # String | The Project ID or Project slug
869
+ opts = {
870
+ create_project_api_key_request: OryClient::CreateProjectApiKeyRequest.new({name: 'name_example'}) # CreateProjectApiKeyRequest |
871
+ }
3367
872
 
3368
873
  begin
3369
- # Deletes an OAuth 2.0 Client using the OpenID / OAuth2 Dynamic Client Registration Management Protocol
3370
- api_instance.dynamic_client_registration_delete_o_auth2_client(id)
874
+ # # Create API Token
875
+ result = api_instance.create_project_api_key(project, opts)
876
+ p result
3371
877
  rescue OryClient::ApiError => e
3372
- puts "Error when calling V0alpha2Api->dynamic_client_registration_delete_o_auth2_client: #{e}"
878
+ puts "Error when calling V0alpha2Api->create_project_api_key: #{e}"
3373
879
  end
3374
880
  ```
3375
881
 
3376
- #### Using the dynamic_client_registration_delete_o_auth2_client_with_http_info variant
882
+ #### Using the create_project_api_key_with_http_info variant
3377
883
 
3378
- This returns an Array which contains the response data (`nil` in this case), status code and headers.
884
+ This returns an Array which contains the response data, status code and headers.
3379
885
 
3380
- > <Array(nil, Integer, Hash)> dynamic_client_registration_delete_o_auth2_client_with_http_info(id)
886
+ > <Array(<ProjectApiKey>, Integer, Hash)> create_project_api_key_with_http_info(project, opts)
3381
887
 
3382
888
  ```ruby
3383
889
  begin
3384
- # Deletes an OAuth 2.0 Client using the OpenID / OAuth2 Dynamic Client Registration Management Protocol
3385
- data, status_code, headers = api_instance.dynamic_client_registration_delete_o_auth2_client_with_http_info(id)
890
+ # # Create API Token
891
+ data, status_code, headers = api_instance.create_project_api_key_with_http_info(project, opts)
3386
892
  p status_code # => 2xx
3387
893
  p headers # => { ... }
3388
- p data # => nil
894
+ p data # => <ProjectApiKey>
3389
895
  rescue OryClient::ApiError => e
3390
- puts "Error when calling V0alpha2Api->dynamic_client_registration_delete_o_auth2_client_with_http_info: #{e}"
896
+ puts "Error when calling V0alpha2Api->create_project_api_key_with_http_info: #{e}"
3391
897
  end
3392
898
  ```
3393
899
 
@@ -3395,68 +901,66 @@ end
3395
901
 
3396
902
  | Name | Type | Description | Notes |
3397
903
  | ---- | ---- | ----------- | ----- |
3398
- | **id** | **String** | The id of the OAuth 2.0 Client. | |
904
+ | **project** | **String** | The Project ID or Project slug | |
905
+ | **create_project_api_key_request** | [**CreateProjectApiKeyRequest**](CreateProjectApiKeyRequest.md) | | [optional] |
3399
906
 
3400
907
  ### Return type
3401
908
 
3402
- nil (empty response body)
909
+ [**ProjectApiKey**](ProjectApiKey.md)
3403
910
 
3404
911
  ### Authorization
3405
912
 
3406
- [bearer](../README.md#bearer)
913
+ [oryAccessToken](../README.md#oryAccessToken)
3407
914
 
3408
915
  ### HTTP request headers
3409
916
 
3410
- - **Content-Type**: Not defined
917
+ - **Content-Type**: application/json
3411
918
  - **Accept**: application/json
3412
919
 
3413
920
 
3414
- ## dynamic_client_registration_get_o_auth2_client
921
+ ## create_self_service_logout_flow_url_for_browsers
3415
922
 
3416
- > <OAuth2Client> dynamic_client_registration_get_o_auth2_client(id)
923
+ > <SelfServiceLogoutUrl> create_self_service_logout_flow_url_for_browsers(opts)
3417
924
 
3418
- Get an OAuth 2.0 Client using the OpenID / OAuth2 Dynamic Client Registration Management Protocol
925
+ Create a Logout URL for Browsers
3419
926
 
3420
- This endpoint behaves like the administrative counterpart (`getOAuth2Client`) but is capable of facing the public internet directly and can be used in self-service. It implements the OpenID Connect Dynamic Client Registration Protocol. This feature needs to be enabled in the configuration. This endpoint is disabled by default. It can be enabled by an administrator. To use this endpoint, you will need to present the client's authentication credentials. If the OAuth2 Client uses the Token Endpoint Authentication Method `client_secret_post`, you need to present the client secret in the URL query. If it uses `client_secret_basic`, present the Client ID and the Client Secret in the Authorization header. OAuth 2.0 clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are generated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities.
927
+ This endpoint initializes a browser-based user logout flow and a URL which can be used to log out the user. This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). For API clients you can call the `/self-service/logout/api` URL directly with the Ory Session Token. The URL is only valid for the currently signed in user. If no user is signed in, this endpoint returns a 401 error. When calling this endpoint from a backend, please ensure to properly forward the HTTP cookies.
3421
928
 
3422
929
  ### Examples
3423
930
 
3424
931
  ```ruby
3425
932
  require 'time'
3426
933
  require 'ory-client'
3427
- # setup authorization
3428
- OryClient.configure do |config|
3429
- # Configure Bearer authorization: bearer
3430
- config.access_token = 'YOUR_BEARER_TOKEN'
3431
- end
3432
934
 
3433
935
  api_instance = OryClient::V0alpha2Api.new
3434
- id = 'id_example' # String | The id of the OAuth 2.0 Client.
936
+ opts = {
937
+ cookie: 'cookie_example' # String | HTTP Cookies If you call this endpoint from a backend, please include the original Cookie header in the request.
938
+ }
3435
939
 
3436
940
  begin
3437
- # Get an OAuth 2.0 Client using the OpenID / OAuth2 Dynamic Client Registration Management Protocol
3438
- result = api_instance.dynamic_client_registration_get_o_auth2_client(id)
941
+ # Create a Logout URL for Browsers
942
+ result = api_instance.create_self_service_logout_flow_url_for_browsers(opts)
3439
943
  p result
3440
944
  rescue OryClient::ApiError => e
3441
- puts "Error when calling V0alpha2Api->dynamic_client_registration_get_o_auth2_client: #{e}"
945
+ puts "Error when calling V0alpha2Api->create_self_service_logout_flow_url_for_browsers: #{e}"
3442
946
  end
3443
947
  ```
3444
948
 
3445
- #### Using the dynamic_client_registration_get_o_auth2_client_with_http_info variant
949
+ #### Using the create_self_service_logout_flow_url_for_browsers_with_http_info variant
3446
950
 
3447
951
  This returns an Array which contains the response data, status code and headers.
3448
952
 
3449
- > <Array(<OAuth2Client>, Integer, Hash)> dynamic_client_registration_get_o_auth2_client_with_http_info(id)
953
+ > <Array(<SelfServiceLogoutUrl>, Integer, Hash)> create_self_service_logout_flow_url_for_browsers_with_http_info(opts)
3450
954
 
3451
955
  ```ruby
3452
956
  begin
3453
- # Get an OAuth 2.0 Client using the OpenID / OAuth2 Dynamic Client Registration Management Protocol
3454
- data, status_code, headers = api_instance.dynamic_client_registration_get_o_auth2_client_with_http_info(id)
957
+ # Create a Logout URL for Browsers
958
+ data, status_code, headers = api_instance.create_self_service_logout_flow_url_for_browsers_with_http_info(opts)
3455
959
  p status_code # => 2xx
3456
960
  p headers # => { ... }
3457
- p data # => <OAuth2Client>
961
+ p data # => <SelfServiceLogoutUrl>
3458
962
  rescue OryClient::ApiError => e
3459
- puts "Error when calling V0alpha2Api->dynamic_client_registration_get_o_auth2_client_with_http_info: #{e}"
963
+ puts "Error when calling V0alpha2Api->create_self_service_logout_flow_url_for_browsers_with_http_info: #{e}"
3460
964
  end
3461
965
  ```
3462
966
 
@@ -3464,15 +968,15 @@ end
3464
968
 
3465
969
  | Name | Type | Description | Notes |
3466
970
  | ---- | ---- | ----------- | ----- |
3467
- | **id** | **String** | The id of the OAuth 2.0 Client. | |
971
+ | **cookie** | **String** | HTTP Cookies If you call this endpoint from a backend, please include the original Cookie header in the request. | [optional] |
3468
972
 
3469
973
  ### Return type
3470
974
 
3471
- [**OAuth2Client**](OAuth2Client.md)
975
+ [**SelfServiceLogoutUrl**](SelfServiceLogoutUrl.md)
3472
976
 
3473
977
  ### Authorization
3474
978
 
3475
- [bearer](../README.md#bearer)
979
+ No authorization required
3476
980
 
3477
981
  ### HTTP request headers
3478
982
 
@@ -3480,13 +984,13 @@ end
3480
984
  - **Accept**: application/json
3481
985
 
3482
986
 
3483
- ## dynamic_client_registration_update_o_auth2_client
987
+ ## delete_project_api_key
3484
988
 
3485
- > <OAuth2Client> dynamic_client_registration_update_o_auth2_client(id, o_auth2_client)
989
+ > delete_project_api_key(project, token_id)
3486
990
 
3487
- Update an OAuth 2.0 Client using the OpenID / OAuth2 Dynamic Client Registration Management Protocol
991
+ # Delete API Token
3488
992
 
3489
- This endpoint behaves like the administrative counterpart (`updateOAuth2Client`) but is capable of facing the public internet directly and can be used in self-service. It implements the OpenID Connect Dynamic Client Registration Protocol. This feature needs to be enabled in the configuration. This endpoint is disabled by default. It can be enabled by an administrator. If you pass `client_secret` the secret is used, otherwise a random secret is generated. The secret is echoed in the response. It is not possible to retrieve it later on. To use this endpoint, you will need to present the client's authentication credentials. If the OAuth2 Client uses the Token Endpoint Authentication Method `client_secret_post`, you need to present the client secret in the URL query. If it uses `client_secret_basic`, present the Client ID and the Client Secret in the Authorization header. OAuth 2.0 clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are generated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities.
993
+ Deletes an API Token and immediately removes it.
3490
994
 
3491
995
  ### Examples
3492
996
 
@@ -3495,38 +999,37 @@ require 'time'
3495
999
  require 'ory-client'
3496
1000
  # setup authorization
3497
1001
  OryClient.configure do |config|
3498
- # Configure Bearer authorization: bearer
1002
+ # Configure Bearer authorization: oryAccessToken
3499
1003
  config.access_token = 'YOUR_BEARER_TOKEN'
3500
1004
  end
3501
1005
 
3502
1006
  api_instance = OryClient::V0alpha2Api.new
3503
- id = 'id_example' # String | The id of the OAuth 2.0 Client.
3504
- o_auth2_client = OryClient::OAuth2Client.new # OAuth2Client |
1007
+ project = 'project_example' # String | The Project ID or Project slug
1008
+ token_id = 'token_id_example' # String | The Token ID
3505
1009
 
3506
1010
  begin
3507
- # Update an OAuth 2.0 Client using the OpenID / OAuth2 Dynamic Client Registration Management Protocol
3508
- result = api_instance.dynamic_client_registration_update_o_auth2_client(id, o_auth2_client)
3509
- p result
1011
+ # # Delete API Token
1012
+ api_instance.delete_project_api_key(project, token_id)
3510
1013
  rescue OryClient::ApiError => e
3511
- puts "Error when calling V0alpha2Api->dynamic_client_registration_update_o_auth2_client: #{e}"
1014
+ puts "Error when calling V0alpha2Api->delete_project_api_key: #{e}"
3512
1015
  end
3513
1016
  ```
3514
1017
 
3515
- #### Using the dynamic_client_registration_update_o_auth2_client_with_http_info variant
1018
+ #### Using the delete_project_api_key_with_http_info variant
3516
1019
 
3517
- This returns an Array which contains the response data, status code and headers.
1020
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
3518
1021
 
3519
- > <Array(<OAuth2Client>, Integer, Hash)> dynamic_client_registration_update_o_auth2_client_with_http_info(id, o_auth2_client)
1022
+ > <Array(nil, Integer, Hash)> delete_project_api_key_with_http_info(project, token_id)
3520
1023
 
3521
1024
  ```ruby
3522
1025
  begin
3523
- # Update an OAuth 2.0 Client using the OpenID / OAuth2 Dynamic Client Registration Management Protocol
3524
- data, status_code, headers = api_instance.dynamic_client_registration_update_o_auth2_client_with_http_info(id, o_auth2_client)
1026
+ # # Delete API Token
1027
+ data, status_code, headers = api_instance.delete_project_api_key_with_http_info(project, token_id)
3525
1028
  p status_code # => 2xx
3526
1029
  p headers # => { ... }
3527
- p data # => <OAuth2Client>
1030
+ p data # => nil
3528
1031
  rescue OryClient::ApiError => e
3529
- puts "Error when calling V0alpha2Api->dynamic_client_registration_update_o_auth2_client_with_http_info: #{e}"
1032
+ puts "Error when calling V0alpha2Api->delete_project_api_key_with_http_info: #{e}"
3530
1033
  end
3531
1034
  ```
3532
1035
 
@@ -3534,20 +1037,20 @@ end
3534
1037
 
3535
1038
  | Name | Type | Description | Notes |
3536
1039
  | ---- | ---- | ----------- | ----- |
3537
- | **id** | **String** | The id of the OAuth 2.0 Client. | |
3538
- | **o_auth2_client** | [**OAuth2Client**](OAuth2Client.md) | | |
1040
+ | **project** | **String** | The Project ID or Project slug | |
1041
+ | **token_id** | **String** | The Token ID | |
3539
1042
 
3540
1043
  ### Return type
3541
1044
 
3542
- [**OAuth2Client**](OAuth2Client.md)
1045
+ nil (empty response body)
3543
1046
 
3544
1047
  ### Authorization
3545
1048
 
3546
- [bearer](../README.md#bearer)
1049
+ [oryAccessToken](../README.md#oryAccessToken)
3547
1050
 
3548
1051
  ### HTTP request headers
3549
1052
 
3550
- - **Content-Type**: application/json
1053
+ - **Content-Type**: Not defined
3551
1054
  - **Accept**: application/json
3552
1055
 
3553
1056
 
@@ -3597,83 +1100,17 @@ end
3597
1100
 
3598
1101
  ### Parameters
3599
1102
 
3600
- | Name | Type | Description | Notes |
3601
- | ---- | ---- | ----------- | ----- |
3602
- | **id** | **String** | ID must be set to the ID of schema you want to get | |
3603
-
3604
- ### Return type
3605
-
3606
- **Object**
3607
-
3608
- ### Authorization
3609
-
3610
- No authorization required
3611
-
3612
- ### HTTP request headers
3613
-
3614
- - **Content-Type**: Not defined
3615
- - **Accept**: application/json
3616
-
3617
-
3618
- ## get_oidc_user_info
3619
-
3620
- > <OidcUserInfo> get_oidc_user_info
3621
-
3622
- OpenID Connect Userinfo
3623
-
3624
- This endpoint returns the payload of the ID Token, including the idTokenExtra values, of the provided OAuth 2.0 Access Token. For more information please [refer to the spec](http://openid.net/specs/openid-connect-core-1_0.html#UserInfo). In the case of authentication error, a WWW-Authenticate header might be set in the response with more information about the error. See [the spec](https://datatracker.ietf.org/doc/html/rfc6750#section-3) for more details about header format.
3625
-
3626
- ### Examples
3627
-
3628
- ```ruby
3629
- require 'time'
3630
- require 'ory-client'
3631
- # setup authorization
3632
- OryClient.configure do |config|
3633
- # Configure OAuth2 access token for authorization: oauth2
3634
- config.access_token = 'YOUR ACCESS TOKEN'
3635
- end
3636
-
3637
- api_instance = OryClient::V0alpha2Api.new
3638
-
3639
- begin
3640
- # OpenID Connect Userinfo
3641
- result = api_instance.get_oidc_user_info
3642
- p result
3643
- rescue OryClient::ApiError => e
3644
- puts "Error when calling V0alpha2Api->get_oidc_user_info: #{e}"
3645
- end
3646
- ```
3647
-
3648
- #### Using the get_oidc_user_info_with_http_info variant
3649
-
3650
- This returns an Array which contains the response data, status code and headers.
3651
-
3652
- > <Array(<OidcUserInfo>, Integer, Hash)> get_oidc_user_info_with_http_info
3653
-
3654
- ```ruby
3655
- begin
3656
- # OpenID Connect Userinfo
3657
- data, status_code, headers = api_instance.get_oidc_user_info_with_http_info
3658
- p status_code # => 2xx
3659
- p headers # => { ... }
3660
- p data # => <OidcUserInfo>
3661
- rescue OryClient::ApiError => e
3662
- puts "Error when calling V0alpha2Api->get_oidc_user_info_with_http_info: #{e}"
3663
- end
3664
- ```
3665
-
3666
- ### Parameters
3667
-
3668
- This endpoint does not need any parameter.
1103
+ | Name | Type | Description | Notes |
1104
+ | ---- | ---- | ----------- | ----- |
1105
+ | **id** | **String** | ID must be set to the ID of schema you want to get | |
3669
1106
 
3670
1107
  ### Return type
3671
1108
 
3672
- [**OidcUserInfo**](OidcUserInfo.md)
1109
+ **Object**
3673
1110
 
3674
1111
  ### Authorization
3675
1112
 
3676
- [oauth2](../README.md#oauth2)
1113
+ No authorization required
3677
1114
 
3678
1115
  ### HTTP request headers
3679
1116
 
@@ -3685,7 +1122,7 @@ This endpoint does not need any parameter.
3685
1122
 
3686
1123
  > <Project> get_project(project_id)
3687
1124
 
3688
- Get a Project
1125
+ # Get a Project
3689
1126
 
3690
1127
  Get a projects you have access to by its ID.
3691
1128
 
@@ -3704,7 +1141,7 @@ api_instance = OryClient::V0alpha2Api.new
3704
1141
  project_id = 'project_id_example' # String | Project ID The project's ID.
3705
1142
 
3706
1143
  begin
3707
- # Get a Project
1144
+ # # Get a Project
3708
1145
  result = api_instance.get_project(project_id)
3709
1146
  p result
3710
1147
  rescue OryClient::ApiError => e
@@ -3720,7 +1157,7 @@ This returns an Array which contains the response data, status code and headers.
3720
1157
 
3721
1158
  ```ruby
3722
1159
  begin
3723
- # Get a Project
1160
+ # # Get a Project
3724
1161
  data, status_code, headers = api_instance.get_project_with_http_info(project_id)
3725
1162
  p status_code # => 2xx
3726
1163
  p headers # => { ... }
@@ -4161,7 +1598,7 @@ No authorization required
4161
1598
 
4162
1599
  > <SelfServiceVerificationFlow> get_self_service_verification_flow(id, opts)
4163
1600
 
4164
- Get Verification Flow
1601
+ # Get Verification Flow
4165
1602
 
4166
1603
  This endpoint returns a verification flow's context with, for example, error details and other information. Browser flows expect the anti-CSRF cookie to be included in the request's HTTP Cookie Header. For AJAX requests you must ensure that cookies are included in the request or requests will fail. If you use the browser-flow for server-side apps, the services need to run on a common top-level-domain and you need to forward the incoming HTTP Cookie header to this endpoint: ```js pseudo-code example router.get('/recovery', async function (req, res) { const flow = await client.getSelfServiceVerificationFlow(req.header('cookie'), req.query['flow']) res.render('verification', flow) }) More information can be found at [Ory Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
4167
1604
 
@@ -4178,7 +1615,7 @@ opts = {
4178
1615
  }
4179
1616
 
4180
1617
  begin
4181
- # Get Verification Flow
1618
+ # # Get Verification Flow
4182
1619
  result = api_instance.get_self_service_verification_flow(id, opts)
4183
1620
  p result
4184
1621
  rescue OryClient::ApiError => e
@@ -4194,7 +1631,7 @@ This returns an Array which contains the response data, status code and headers.
4194
1631
 
4195
1632
  ```ruby
4196
1633
  begin
4197
- # Get Verification Flow
1634
+ # # Get Verification Flow
4198
1635
  data, status_code, headers = api_instance.get_self_service_verification_flow_with_http_info(id, opts)
4199
1636
  p status_code # => 2xx
4200
1637
  p headers # => { ... }
@@ -5007,11 +2444,80 @@ No authorization required
5007
2444
  - **Accept**: application/json
5008
2445
 
5009
2446
 
2447
+ ## list_project_api_keys
2448
+
2449
+ > <Array<ProjectApiKey>> list_project_api_keys(project)
2450
+
2451
+ # List a Project's API Tokens
2452
+
2453
+ A list of all the project's API tokens.
2454
+
2455
+ ### Examples
2456
+
2457
+ ```ruby
2458
+ require 'time'
2459
+ require 'ory-client'
2460
+ # setup authorization
2461
+ OryClient.configure do |config|
2462
+ # Configure Bearer authorization: oryAccessToken
2463
+ config.access_token = 'YOUR_BEARER_TOKEN'
2464
+ end
2465
+
2466
+ api_instance = OryClient::V0alpha2Api.new
2467
+ project = 'project_example' # String | The Project ID or Project slug
2468
+
2469
+ begin
2470
+ # # List a Project's API Tokens
2471
+ result = api_instance.list_project_api_keys(project)
2472
+ p result
2473
+ rescue OryClient::ApiError => e
2474
+ puts "Error when calling V0alpha2Api->list_project_api_keys: #{e}"
2475
+ end
2476
+ ```
2477
+
2478
+ #### Using the list_project_api_keys_with_http_info variant
2479
+
2480
+ This returns an Array which contains the response data, status code and headers.
2481
+
2482
+ > <Array(<Array<ProjectApiKey>>, Integer, Hash)> list_project_api_keys_with_http_info(project)
2483
+
2484
+ ```ruby
2485
+ begin
2486
+ # # List a Project's API Tokens
2487
+ data, status_code, headers = api_instance.list_project_api_keys_with_http_info(project)
2488
+ p status_code # => 2xx
2489
+ p headers # => { ... }
2490
+ p data # => <Array<ProjectApiKey>>
2491
+ rescue OryClient::ApiError => e
2492
+ puts "Error when calling V0alpha2Api->list_project_api_keys_with_http_info: #{e}"
2493
+ end
2494
+ ```
2495
+
2496
+ ### Parameters
2497
+
2498
+ | Name | Type | Description | Notes |
2499
+ | ---- | ---- | ----------- | ----- |
2500
+ | **project** | **String** | The Project ID or Project slug | |
2501
+
2502
+ ### Return type
2503
+
2504
+ [**Array&lt;ProjectApiKey&gt;**](ProjectApiKey.md)
2505
+
2506
+ ### Authorization
2507
+
2508
+ [oryAccessToken](../README.md#oryAccessToken)
2509
+
2510
+ ### HTTP request headers
2511
+
2512
+ - **Content-Type**: Not defined
2513
+ - **Accept**: application/json
2514
+
2515
+
5010
2516
  ## list_projects
5011
2517
 
5012
2518
  > <Array<ProjectMetadata>> list_projects
5013
2519
 
5014
- List All Projects
2520
+ # List All Projects
5015
2521
 
5016
2522
  Lists all projects you have access to.
5017
2523
 
@@ -5029,7 +2535,7 @@ end
5029
2535
  api_instance = OryClient::V0alpha2Api.new
5030
2536
 
5031
2537
  begin
5032
- # List All Projects
2538
+ # # List All Projects
5033
2539
  result = api_instance.list_projects
5034
2540
  p result
5035
2541
  rescue OryClient::ApiError => e
@@ -5045,7 +2551,7 @@ This returns an Array which contains the response data, status code and headers.
5045
2551
 
5046
2552
  ```ruby
5047
2553
  begin
5048
- # List All Projects
2554
+ # # List All Projects
5049
2555
  data, status_code, headers = api_instance.list_projects_with_http_info
5050
2556
  p status_code # => 2xx
5051
2557
  p headers # => { ... }
@@ -5218,215 +2724,11 @@ end
5218
2724
  - **Accept**: application/json
5219
2725
 
5220
2726
 
5221
- ## perform_o_auth2_authorization_flow
5222
-
5223
- > <OAuth2ApiError> perform_o_auth2_authorization_flow
5224
-
5225
- The OAuth 2.0 Authorize Endpoint
5226
-
5227
- This endpoint is not documented here because you should never use your own implementation to perform OAuth2 flows. OAuth2 is a very popular protocol and a library for your programming language will exists. To learn more about this flow please refer to the specification: https://tools.ietf.org/html/rfc6749
5228
-
5229
- ### Examples
5230
-
5231
- ```ruby
5232
- require 'time'
5233
- require 'ory-client'
5234
-
5235
- api_instance = OryClient::V0alpha2Api.new
5236
-
5237
- begin
5238
- # The OAuth 2.0 Authorize Endpoint
5239
- result = api_instance.perform_o_auth2_authorization_flow
5240
- p result
5241
- rescue OryClient::ApiError => e
5242
- puts "Error when calling V0alpha2Api->perform_o_auth2_authorization_flow: #{e}"
5243
- end
5244
- ```
5245
-
5246
- #### Using the perform_o_auth2_authorization_flow_with_http_info variant
5247
-
5248
- This returns an Array which contains the response data, status code and headers.
5249
-
5250
- > <Array(<OAuth2ApiError>, Integer, Hash)> perform_o_auth2_authorization_flow_with_http_info
5251
-
5252
- ```ruby
5253
- begin
5254
- # The OAuth 2.0 Authorize Endpoint
5255
- data, status_code, headers = api_instance.perform_o_auth2_authorization_flow_with_http_info
5256
- p status_code # => 2xx
5257
- p headers # => { ... }
5258
- p data # => <OAuth2ApiError>
5259
- rescue OryClient::ApiError => e
5260
- puts "Error when calling V0alpha2Api->perform_o_auth2_authorization_flow_with_http_info: #{e}"
5261
- end
5262
- ```
5263
-
5264
- ### Parameters
5265
-
5266
- This endpoint does not need any parameter.
5267
-
5268
- ### Return type
5269
-
5270
- [**OAuth2ApiError**](OAuth2ApiError.md)
5271
-
5272
- ### Authorization
5273
-
5274
- No authorization required
5275
-
5276
- ### HTTP request headers
5277
-
5278
- - **Content-Type**: Not defined
5279
- - **Accept**: application/json
5280
-
5281
-
5282
- ## perform_o_auth2_token_flow
5283
-
5284
- > <OAuth2TokenResponse> perform_o_auth2_token_flow(grant_type, opts)
5285
-
5286
- The OAuth 2.0 Token Endpoint
5287
-
5288
- The client makes a request to the token endpoint by sending the following parameters using the \"application/x-www-form-urlencoded\" HTTP request entity-body. > Do not implement a client for this endpoint yourself. Use a library. There are many libraries > available for any programming language. You can find a list of libraries here: https://oauth.net/code/ > > Do note that Hydra SDK does not implement this endpoint properly. Use one of the libraries listed above
5289
-
5290
- ### Examples
5291
-
5292
- ```ruby
5293
- require 'time'
5294
- require 'ory-client'
5295
- # setup authorization
5296
- OryClient.configure do |config|
5297
- # Configure HTTP basic authorization: basic
5298
- config.username = 'YOUR USERNAME'
5299
- config.password = 'YOUR PASSWORD'
5300
-
5301
- # Configure OAuth2 access token for authorization: oauth2
5302
- config.access_token = 'YOUR ACCESS TOKEN'
5303
- end
5304
-
5305
- api_instance = OryClient::V0alpha2Api.new
5306
- grant_type = 'grant_type_example' # String |
5307
- opts = {
5308
- client_id: 'client_id_example', # String |
5309
- code: 'code_example', # String |
5310
- redirect_uri: 'redirect_uri_example', # String |
5311
- refresh_token: 'refresh_token_example' # String |
5312
- }
5313
-
5314
- begin
5315
- # The OAuth 2.0 Token Endpoint
5316
- result = api_instance.perform_o_auth2_token_flow(grant_type, opts)
5317
- p result
5318
- rescue OryClient::ApiError => e
5319
- puts "Error when calling V0alpha2Api->perform_o_auth2_token_flow: #{e}"
5320
- end
5321
- ```
5322
-
5323
- #### Using the perform_o_auth2_token_flow_with_http_info variant
5324
-
5325
- This returns an Array which contains the response data, status code and headers.
5326
-
5327
- > <Array(<OAuth2TokenResponse>, Integer, Hash)> perform_o_auth2_token_flow_with_http_info(grant_type, opts)
5328
-
5329
- ```ruby
5330
- begin
5331
- # The OAuth 2.0 Token Endpoint
5332
- data, status_code, headers = api_instance.perform_o_auth2_token_flow_with_http_info(grant_type, opts)
5333
- p status_code # => 2xx
5334
- p headers # => { ... }
5335
- p data # => <OAuth2TokenResponse>
5336
- rescue OryClient::ApiError => e
5337
- puts "Error when calling V0alpha2Api->perform_o_auth2_token_flow_with_http_info: #{e}"
5338
- end
5339
- ```
5340
-
5341
- ### Parameters
5342
-
5343
- | Name | Type | Description | Notes |
5344
- | ---- | ---- | ----------- | ----- |
5345
- | **grant_type** | **String** | | |
5346
- | **client_id** | **String** | | [optional] |
5347
- | **code** | **String** | | [optional] |
5348
- | **redirect_uri** | **String** | | [optional] |
5349
- | **refresh_token** | **String** | | [optional] |
5350
-
5351
- ### Return type
5352
-
5353
- [**OAuth2TokenResponse**](OAuth2TokenResponse.md)
5354
-
5355
- ### Authorization
5356
-
5357
- [basic](../README.md#basic), [oauth2](../README.md#oauth2)
5358
-
5359
- ### HTTP request headers
5360
-
5361
- - **Content-Type**: application/x-www-form-urlencoded
5362
- - **Accept**: application/json
5363
-
5364
-
5365
- ## perform_oidc_front_or_back_channel_logout
5366
-
5367
- > perform_oidc_front_or_back_channel_logout
5368
-
5369
- OpenID Connect Front- or Back-channel Enabled Logout
5370
-
5371
- This endpoint initiates and completes user logout at Ory Hydra and initiates OpenID Connect Front- / Back-channel logout: https://openid.net/specs/openid-connect-frontchannel-1_0.html https://openid.net/specs/openid-connect-backchannel-1_0.html Back-channel logout is performed asynchronously and does not affect logout flow.
5372
-
5373
- ### Examples
5374
-
5375
- ```ruby
5376
- require 'time'
5377
- require 'ory-client'
5378
-
5379
- api_instance = OryClient::V0alpha2Api.new
5380
-
5381
- begin
5382
- # OpenID Connect Front- or Back-channel Enabled Logout
5383
- api_instance.perform_oidc_front_or_back_channel_logout
5384
- rescue OryClient::ApiError => e
5385
- puts "Error when calling V0alpha2Api->perform_oidc_front_or_back_channel_logout: #{e}"
5386
- end
5387
- ```
5388
-
5389
- #### Using the perform_oidc_front_or_back_channel_logout_with_http_info variant
5390
-
5391
- This returns an Array which contains the response data (`nil` in this case), status code and headers.
5392
-
5393
- > <Array(nil, Integer, Hash)> perform_oidc_front_or_back_channel_logout_with_http_info
5394
-
5395
- ```ruby
5396
- begin
5397
- # OpenID Connect Front- or Back-channel Enabled Logout
5398
- data, status_code, headers = api_instance.perform_oidc_front_or_back_channel_logout_with_http_info
5399
- p status_code # => 2xx
5400
- p headers # => { ... }
5401
- p data # => nil
5402
- rescue OryClient::ApiError => e
5403
- puts "Error when calling V0alpha2Api->perform_oidc_front_or_back_channel_logout_with_http_info: #{e}"
5404
- end
5405
- ```
5406
-
5407
- ### Parameters
5408
-
5409
- This endpoint does not need any parameter.
5410
-
5411
- ### Return type
5412
-
5413
- nil (empty response body)
5414
-
5415
- ### Authorization
5416
-
5417
- No authorization required
5418
-
5419
- ### HTTP request headers
5420
-
5421
- - **Content-Type**: Not defined
5422
- - **Accept**: Not defined
5423
-
5424
-
5425
2727
  ## purge_project
5426
2728
 
5427
2729
  > purge_project(project_id)
5428
2730
 
5429
- Irrecoverably Purge a Project
2731
+ # Irrecoverably Purge a Project
5430
2732
 
5431
2733
  !! Use with extreme caution !! Using this API endpoint you can purge (completely delete) a project and its data. This action can not be undone and will delete ALL your data. !! Use with extreme caution !!
5432
2734
 
@@ -5445,7 +2747,7 @@ api_instance = OryClient::V0alpha2Api.new
5445
2747
  project_id = 'project_id_example' # String | Project ID The project's ID.
5446
2748
 
5447
2749
  begin
5448
- # Irrecoverably Purge a Project
2750
+ # # Irrecoverably Purge a Project
5449
2751
  api_instance.purge_project(project_id)
5450
2752
  rescue OryClient::ApiError => e
5451
2753
  puts "Error when calling V0alpha2Api->purge_project: #{e}"
@@ -5460,7 +2762,7 @@ This returns an Array which contains the response data (`nil` in this case), sta
5460
2762
 
5461
2763
  ```ruby
5462
2764
  begin
5463
- # Irrecoverably Purge a Project
2765
+ # # Irrecoverably Purge a Project
5464
2766
  data, status_code, headers = api_instance.purge_project_with_http_info(project_id)
5465
2767
  p status_code # => 2xx
5466
2768
  p headers # => { ... }
@@ -5560,78 +2862,6 @@ nil (empty response body)
5560
2862
  - **Accept**: application/json
5561
2863
 
5562
2864
 
5563
- ## revoke_o_auth2_token
5564
-
5565
- > revoke_o_auth2_token(token)
5566
-
5567
- Revoke an OAuth2 Access or Refresh Token
5568
-
5569
- Revoking a token (both access and refresh) means that the tokens will be invalid. A revoked access token can no longer be used to make access requests, and a revoked refresh token can no longer be used to refresh an access token. Revoking a refresh token also invalidates the access token that was created with it. A token may only be revoked by the client the token was generated for.
5570
-
5571
- ### Examples
5572
-
5573
- ```ruby
5574
- require 'time'
5575
- require 'ory-client'
5576
- # setup authorization
5577
- OryClient.configure do |config|
5578
- # Configure HTTP basic authorization: basic
5579
- config.username = 'YOUR USERNAME'
5580
- config.password = 'YOUR PASSWORD'
5581
-
5582
- # Configure OAuth2 access token for authorization: oauth2
5583
- config.access_token = 'YOUR ACCESS TOKEN'
5584
- end
5585
-
5586
- api_instance = OryClient::V0alpha2Api.new
5587
- token = 'token_example' # String |
5588
-
5589
- begin
5590
- # Revoke an OAuth2 Access or Refresh Token
5591
- api_instance.revoke_o_auth2_token(token)
5592
- rescue OryClient::ApiError => e
5593
- puts "Error when calling V0alpha2Api->revoke_o_auth2_token: #{e}"
5594
- end
5595
- ```
5596
-
5597
- #### Using the revoke_o_auth2_token_with_http_info variant
5598
-
5599
- This returns an Array which contains the response data (`nil` in this case), status code and headers.
5600
-
5601
- > <Array(nil, Integer, Hash)> revoke_o_auth2_token_with_http_info(token)
5602
-
5603
- ```ruby
5604
- begin
5605
- # Revoke an OAuth2 Access or Refresh Token
5606
- data, status_code, headers = api_instance.revoke_o_auth2_token_with_http_info(token)
5607
- p status_code # => 2xx
5608
- p headers # => { ... }
5609
- p data # => nil
5610
- rescue OryClient::ApiError => e
5611
- puts "Error when calling V0alpha2Api->revoke_o_auth2_token_with_http_info: #{e}"
5612
- end
5613
- ```
5614
-
5615
- ### Parameters
5616
-
5617
- | Name | Type | Description | Notes |
5618
- | ---- | ---- | ----------- | ----- |
5619
- | **token** | **String** | | |
5620
-
5621
- ### Return type
5622
-
5623
- nil (empty response body)
5624
-
5625
- ### Authorization
5626
-
5627
- [basic](../README.md#basic), [oauth2](../README.md#oauth2)
5628
-
5629
- ### HTTP request headers
5630
-
5631
- - **Content-Type**: application/x-www-form-urlencoded
5632
- - **Accept**: application/json
5633
-
5634
-
5635
2865
  ## revoke_session
5636
2866
 
5637
2867
  > revoke_session(id)
@@ -6183,7 +3413,7 @@ No authorization required
6183
3413
 
6184
3414
  > <SelfServiceVerificationFlow> submit_self_service_verification_flow(flow, submit_self_service_verification_flow_body, opts)
6185
3415
 
6186
- Complete Verification Flow
3416
+ # Complete Verification Flow
6187
3417
 
6188
3418
  Use this endpoint to complete a verification flow. This endpoint behaves differently for API and browser flows and has several states: `choose_method` expects `flow` (in the URL query) and `email` (in the body) to be sent and works with API- and Browser-initiated flows. For API clients and Browser clients with HTTP Header `Accept: application/json` it either returns a HTTP 200 OK when the form is valid and HTTP 400 OK when the form is invalid and a HTTP 303 See Other redirect with a fresh verification flow if the flow was otherwise invalid (e.g. expired). For Browser clients without HTTP Header `Accept` or with `Accept: text/*` it returns a HTTP 303 See Other redirect to the Verification UI URL with the Verification Flow ID appended. `sent_email` is the success state after `choose_method` when using the `link` method and allows the user to request another verification email. It works for both API and Browser-initiated flows and returns the same responses as the flow in `choose_method` state. `passed_challenge` expects a `token` to be sent in the URL query and given the nature of the flow (\"sending a verification link\") does not have any API capabilities. The server responds with a HTTP 303 See Other redirect either to the Settings UI URL (if the link was valid) and instructs the user to update their password, or a redirect to the Verification UI URL with a new Verification Flow ID which contains an error message that the verification link was invalid. More information can be found at [Ory Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
6189
3419
 
@@ -6202,7 +3432,7 @@ opts = {
6202
3432
  }
6203
3433
 
6204
3434
  begin
6205
- # Complete Verification Flow
3435
+ # # Complete Verification Flow
6206
3436
  result = api_instance.submit_self_service_verification_flow(flow, submit_self_service_verification_flow_body, opts)
6207
3437
  p result
6208
3438
  rescue OryClient::ApiError => e
@@ -6218,7 +3448,7 @@ This returns an Array which contains the response data, status code and headers.
6218
3448
 
6219
3449
  ```ruby
6220
3450
  begin
6221
- # Complete Verification Flow
3451
+ # # Complete Verification Flow
6222
3452
  data, status_code, headers = api_instance.submit_self_service_verification_flow_with_http_info(flow, submit_self_service_verification_flow_body, opts)
6223
3453
  p status_code # => 2xx
6224
3454
  p headers # => { ... }
@@ -6323,7 +3553,7 @@ No authorization required
6323
3553
 
6324
3554
  > <SuccessfulProjectUpdate> update_project(project_id, opts)
6325
3555
 
6326
- Update an Ory Cloud Project Configuration
3556
+ # Update an Ory Cloud Project Configuration
6327
3557
 
6328
3558
  This endpoints allows you to update the Ory Cloud Project configuration for individual services (identity, permission, ...). The configuration is fully compatible with the open source projects for the respective services (e.g. Ory Kratos for Identity, Ory Keto for Permissions). This endpoint expects the `version` key to be set in the payload. If it is unset, it will try to import the config as if it is from the most recent version. If you have an older version of a configuration, you should set the version key in the payload! While this endpoint is able to process all configuration items related to features (e.g. password reset), it does not support operational configuration items (e.g. port, tracing, logging) otherwise available in the open source. For configuration items that can not be translated to Ory Cloud, this endpoint will return a list of warnings to help you understand which parts of your config could not be processed. Be aware that updating any service's configuration will completely override your current configuration for that service!
6329
3559
 
@@ -6345,7 +3575,7 @@ opts = {
6345
3575
  }
6346
3576
 
6347
3577
  begin
6348
- # Update an Ory Cloud Project Configuration
3578
+ # # Update an Ory Cloud Project Configuration
6349
3579
  result = api_instance.update_project(project_id, opts)
6350
3580
  p result
6351
3581
  rescue OryClient::ApiError => e
@@ -6361,7 +3591,7 @@ This returns an Array which contains the response data, status code and headers.
6361
3591
 
6362
3592
  ```ruby
6363
3593
  begin
6364
- # Update an Ory Cloud Project Configuration
3594
+ # # Update an Ory Cloud Project Configuration
6365
3595
  data, status_code, headers = api_instance.update_project_with_http_info(project_id, opts)
6366
3596
  p status_code # => 2xx
6367
3597
  p headers # => { ... }