ory-client 0.2.0.alpha48 → 0.2.0.alpha60

Sign up to get free protection for your applications and to get access to all the features.
Files changed (571) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +2 -2
  3. data/README.md +123 -99
  4. data/docs/{AcceptConsentRequest.md → AcceptOAuth2ConsentRequest.md} +3 -3
  5. data/docs/{ConsentRequestSession.md → AcceptOAuth2ConsentRequestSession.md} +2 -2
  6. data/docs/{AcceptLoginRequest.md → AcceptOAuth2LoginRequest.md} +2 -2
  7. data/docs/AdminApi.md +15 -2093
  8. data/docs/AdminCreateIdentityBody.md +1 -1
  9. data/docs/{JsonWebKeySetGeneratorRequest.md → AdminCreateJsonWebKeySetBody.md} +2 -2
  10. data/docs/AdminCreateSelfServiceRecoveryCodeBody.md +20 -0
  11. data/docs/AdminCreateSelfServiceRecoveryLinkBody.md +1 -1
  12. data/docs/{TrustJwtGrantIssuerBody.md → AdminTrustOAuth2JwtGrantIssuerBody.md} +3 -3
  13. data/docs/CourierMessageStatus.md +15 -0
  14. data/docs/CourierMessageType.md +15 -0
  15. data/docs/GetNamespacesResponse.md +18 -0
  16. data/docs/HandledOAuth2ConsentRequest.md +18 -0
  17. data/docs/{RequestWasHandledResponse.md → HandledOAuth2LoginRequest.md} +2 -2
  18. data/docs/HandledOAuth2LogoutRequest.md +18 -0
  19. data/docs/Headers.md +18 -0
  20. data/docs/IDTokenClaims.md +44 -0
  21. data/docs/Identity.md +2 -2
  22. data/docs/{OAuth2TokenIntrospection.md → IntrospectedOAuth2Token.md} +2 -2
  23. data/docs/JsonError.md +1 -7
  24. data/docs/{JSONWebKey.md → JsonWebKey.md} +2 -2
  25. data/docs/JsonWebKeySet.md +18 -0
  26. data/docs/Message.md +36 -0
  27. data/docs/Namespace.md +18 -0
  28. data/docs/NamespacesApi.md +74 -0
  29. data/docs/NormalizedProjectRevision.md +21 -1
  30. data/docs/OAuth2AccessRequest.md +24 -0
  31. data/docs/OAuth2ApiError.md +24 -0
  32. data/docs/OAuth2Client.md +26 -2
  33. data/docs/{ConsentRequest.md → OAuth2ConsentRequest.md} +3 -3
  34. data/docs/{OpenIDConnectContext.md → OAuth2ConsentRequestOpenIDConnectContext.md} +2 -2
  35. data/docs/OAuth2ConsentSession.md +38 -0
  36. data/docs/OAuth2ConsentSessionExpiresAt.md +26 -0
  37. data/docs/{LoginRequest.md → OAuth2LoginRequest.md} +3 -3
  38. data/docs/{LogoutRequest.md → OAuth2LogoutRequest.md} +2 -2
  39. data/docs/{OauthTokenResponse.md → OAuth2TokenResponse.md} +2 -2
  40. data/docs/{WellKnown.md → OidcConfiguration.md} +6 -2
  41. data/docs/{UserinfoResponse.md → OidcUserInfo.md} +2 -2
  42. data/docs/Pagination.md +4 -0
  43. data/docs/PaginationHeaders.md +20 -0
  44. data/docs/ParseError.md +22 -0
  45. data/docs/PostCheckOplSyntaxResponse.md +18 -0
  46. data/docs/{PreviousConsentSession.md → PreviousOAuth2ConsentSession.md} +4 -4
  47. data/docs/ReadApi.md +24 -24
  48. data/docs/{RecoveryAddress.md → RecoveryIdentityAddress.md} +2 -2
  49. data/docs/RefreshTokenHookRequest.md +4 -0
  50. data/docs/RefreshTokenHookResponse.md +1 -1
  51. data/docs/{RejectRequest.md → RejectOAuth2Request.md} +2 -2
  52. data/docs/SelfServiceError.md +1 -1
  53. data/docs/SelfServiceFlowExpiredError.md +1 -1
  54. data/docs/SelfServiceLoginFlow.md +1 -1
  55. data/docs/SelfServiceRecoveryCode.md +22 -0
  56. data/docs/SelfServiceRecoveryFlow.md +2 -2
  57. data/docs/SelfServiceRegistrationFlow.md +1 -1
  58. data/docs/SelfServiceSettingsFlow.md +1 -1
  59. data/docs/SelfServiceVerificationFlow.md +1 -1
  60. data/docs/Session.md +3 -1
  61. data/docs/SessionDevice.md +7 -1
  62. data/docs/SourcePosition.md +20 -0
  63. data/docs/SubmitSelfServiceRecoveryFlowBody.md +4 -1
  64. data/docs/SubmitSelfServiceRecoveryFlowWithCodeMethodBody.md +24 -0
  65. data/docs/{CompletedRequest.md → SuccessfulOAuth2RequestResponse.md} +2 -2
  66. data/docs/SyntaxApi.md +77 -0
  67. data/docs/{TrustedJwtGrantIssuer.md → TrustedOAuth2JwtGrantIssuer.md} +3 -3
  68. data/docs/{TrustedJsonWebKey.md → TrustedOAuth2JwtGrantJsonWebKey.md} +2 -2
  69. data/docs/UiNode.md +2 -2
  70. data/docs/UiNodeInputAttributes.md +2 -2
  71. data/docs/UpdateOAuth2ClientLifespans.md +40 -0
  72. data/docs/V0alpha2Api.md +3473 -334
  73. data/docs/VerifiableIdentityAddress.md +1 -1
  74. data/docs/WriteApi.md +12 -12
  75. data/lib/ory-client/api/admin_api.rb +14 -2108
  76. data/lib/ory-client/api/metadata_api.rb +1 -1
  77. data/lib/ory-client/api/namespaces_api.rb +79 -0
  78. data/lib/ory-client/api/read_api.rb +13 -13
  79. data/lib/ory-client/api/syntax_api.rb +90 -0
  80. data/lib/ory-client/api/v0alpha2_api.rb +3336 -368
  81. data/lib/ory-client/api/write_api.rb +7 -7
  82. data/lib/ory-client/api_client.rb +1 -1
  83. data/lib/ory-client/api_error.rb +1 -1
  84. data/lib/ory-client/configuration.rb +8 -1
  85. data/lib/ory-client/models/{accept_consent_request.rb → accept_o_auth2_consent_request.rb} +5 -5
  86. data/lib/ory-client/models/{consent_request_session.rb → accept_o_auth2_consent_request_session.rb} +4 -4
  87. data/lib/ory-client/models/{accept_login_request.rb → accept_o_auth2_login_request.rb} +4 -4
  88. data/lib/ory-client/models/active_project.rb +1 -1
  89. data/lib/ory-client/models/admin_create_identity_body.rb +2 -2
  90. data/lib/ory-client/models/admin_create_identity_import_credentials_oidc.rb +1 -1
  91. data/lib/ory-client/models/admin_create_identity_import_credentials_oidc_config.rb +1 -1
  92. data/lib/ory-client/models/admin_create_identity_import_credentials_oidc_provider.rb +1 -1
  93. data/lib/ory-client/models/admin_create_identity_import_credentials_password.rb +1 -1
  94. data/lib/ory-client/models/admin_create_identity_import_credentials_password_config.rb +1 -1
  95. data/lib/ory-client/models/{json_web_key_set_generator_request.rb → admin_create_json_web_key_set_body.rb} +4 -4
  96. data/lib/ory-client/models/admin_create_self_service_recovery_code_body.rb +252 -0
  97. data/lib/ory-client/models/admin_create_self_service_recovery_link_body.rb +2 -1
  98. data/lib/ory-client/models/admin_identity_import_credentials.rb +1 -1
  99. data/lib/ory-client/models/{trust_jwt_grant_issuer_body.rb → admin_trust_o_auth2_jwt_grant_issuer_body.rb} +5 -5
  100. data/lib/ory-client/models/admin_update_identity_body.rb +1 -1
  101. data/lib/ory-client/models/authenticator_assurance_level.rb +1 -1
  102. data/lib/ory-client/models/cloud_account.rb +1 -1
  103. data/lib/ory-client/models/cname_settings.rb +1 -1
  104. data/lib/ory-client/models/courier_message_status.rb +39 -0
  105. data/lib/ory-client/models/courier_message_type.rb +37 -0
  106. data/lib/ory-client/models/create_custom_hostname_body.rb +1 -1
  107. data/lib/ory-client/models/create_project_api_key_request.rb +1 -1
  108. data/lib/ory-client/models/create_project_body.rb +1 -1
  109. data/lib/ory-client/models/create_subscription_payload.rb +1 -1
  110. data/lib/ory-client/models/error_authenticator_assurance_level_not_satisfied.rb +1 -1
  111. data/lib/ory-client/models/expand_tree.rb +1 -1
  112. data/lib/ory-client/models/generic_error.rb +1 -1
  113. data/lib/ory-client/models/generic_error_content.rb +1 -1
  114. data/lib/ory-client/models/get_check_response.rb +1 -1
  115. data/lib/ory-client/models/get_managed_identity_schema_location.rb +1 -1
  116. data/lib/ory-client/models/{flush_login_consent_request.rb → get_namespaces_response.rb} +13 -12
  117. data/lib/ory-client/models/get_relation_tuples_response.rb +1 -1
  118. data/lib/ory-client/models/get_version200_response.rb +1 -1
  119. data/lib/ory-client/models/handled_o_auth2_consent_request.rb +225 -0
  120. data/lib/ory-client/models/{request_was_handled_response.rb → handled_o_auth2_login_request.rb} +4 -4
  121. data/lib/ory-client/models/handled_o_auth2_logout_request.rb +225 -0
  122. data/lib/ory-client/models/{flush_inactive_o_auth2_tokens_request.rb → headers.rb} +14 -12
  123. data/lib/ory-client/models/health_not_ready_status.rb +1 -1
  124. data/lib/ory-client/models/health_status.rb +1 -1
  125. data/lib/ory-client/models/id_token_claims.rb +343 -0
  126. data/lib/ory-client/models/identity.rb +3 -2
  127. data/lib/ory-client/models/identity_credentials.rb +1 -1
  128. data/lib/ory-client/models/identity_credentials_oidc.rb +1 -1
  129. data/lib/ory-client/models/identity_credentials_oidc_provider.rb +1 -1
  130. data/lib/ory-client/models/identity_credentials_password.rb +1 -1
  131. data/lib/ory-client/models/identity_credentials_type.rb +1 -1
  132. data/lib/ory-client/models/identity_schema_container.rb +1 -1
  133. data/lib/ory-client/models/identity_schema_preset.rb +1 -1
  134. data/lib/ory-client/models/identity_state.rb +1 -1
  135. data/lib/ory-client/models/{o_auth2_token_introspection.rb → introspected_o_auth2_token.rb} +5 -5
  136. data/lib/ory-client/models/invite_payload.rb +1 -1
  137. data/lib/ory-client/models/is_owner_for_project_by_slug.rb +1 -1
  138. data/lib/ory-client/models/is_owner_for_project_by_slug_payload.rb +1 -1
  139. data/lib/ory-client/models/is_ready200_response.rb +1 -1
  140. data/lib/ory-client/models/is_ready503_response.rb +1 -1
  141. data/lib/ory-client/models/json_error.rb +5 -35
  142. data/lib/ory-client/models/json_patch.rb +1 -1
  143. data/lib/ory-client/models/json_web_key.rb +4 -5
  144. data/lib/ory-client/models/json_web_key_set.rb +6 -6
  145. data/lib/ory-client/models/keto_namespace.rb +1 -1
  146. data/lib/ory-client/models/managed_identity_schema.rb +1 -1
  147. data/lib/ory-client/models/managed_identity_schema_validation_result.rb +1 -1
  148. data/lib/ory-client/models/message.rb +302 -0
  149. data/lib/ory-client/models/namespace.rb +220 -0
  150. data/lib/ory-client/models/needs_privileged_session_error.rb +1 -1
  151. data/lib/ory-client/models/normalized_project.rb +1 -1
  152. data/lib/ory-client/models/normalized_project_revision.rb +103 -3
  153. data/lib/ory-client/models/normalized_project_revision_hook.rb +1 -1
  154. data/lib/ory-client/models/normalized_project_revision_identity_schema.rb +1 -1
  155. data/lib/ory-client/models/normalized_project_revision_third_party_provider.rb +1 -1
  156. data/lib/ory-client/models/null_plan.rb +1 -1
  157. data/lib/ory-client/models/o_auth2_access_request.rb +256 -0
  158. data/lib/ory-client/models/{patch_document.rb → o_auth2_api_error.rb} +34 -44
  159. data/lib/ory-client/models/o_auth2_client.rb +320 -13
  160. data/lib/ory-client/models/{consent_request.rb → o_auth2_consent_request.rb} +5 -5
  161. data/lib/ory-client/models/{open_id_connect_context.rb → o_auth2_consent_request_open_id_connect_context.rb} +4 -4
  162. data/lib/ory-client/models/o_auth2_consent_session.rb +313 -0
  163. data/lib/ory-client/models/{oauth2_token_response.rb → o_auth2_consent_session_expires_at.rb} +25 -35
  164. data/lib/ory-client/models/{login_request.rb → o_auth2_login_request.rb} +5 -5
  165. data/lib/ory-client/models/{logout_request.rb → o_auth2_logout_request.rb} +4 -4
  166. data/lib/ory-client/models/{oauth_token_response.rb → o_auth2_token_response.rb} +5 -5
  167. data/lib/ory-client/models/{well_known.rb → oidc_configuration.rb} +40 -6
  168. data/lib/ory-client/models/{userinfo_response.rb → oidc_user_info.rb} +4 -4
  169. data/lib/ory-client/models/pagination.rb +56 -2
  170. data/lib/ory-client/models/pagination_headers.rb +230 -0
  171. data/lib/ory-client/models/parse_error.rb +237 -0
  172. data/lib/ory-client/models/patch_delta.rb +1 -1
  173. data/lib/ory-client/models/post_check_opl_syntax_response.rb +222 -0
  174. data/lib/ory-client/models/{previous_consent_session.rb → previous_o_auth2_consent_session.rb} +6 -6
  175. data/lib/ory-client/models/project.rb +1 -1
  176. data/lib/ory-client/models/project_api_key.rb +1 -1
  177. data/lib/ory-client/models/project_host.rb +1 -1
  178. data/lib/ory-client/models/project_invite.rb +1 -1
  179. data/lib/ory-client/models/project_metadata.rb +1 -1
  180. data/lib/ory-client/models/project_service_identity.rb +1 -1
  181. data/lib/ory-client/models/project_service_o_auth2.rb +1 -1
  182. data/lib/ory-client/models/project_service_permission.rb +1 -1
  183. data/lib/ory-client/models/project_services.rb +1 -1
  184. data/lib/ory-client/models/provision_mock_subscription_payload.rb +1 -1
  185. data/lib/ory-client/models/quota_custom_domains.rb +1 -1
  186. data/lib/ory-client/models/quota_project_member_seats.rb +1 -1
  187. data/lib/ory-client/models/{recovery_address.rb → recovery_identity_address.rb} +4 -4
  188. data/lib/ory-client/models/refresh_token_hook_request.rb +20 -2
  189. data/lib/ory-client/models/refresh_token_hook_response.rb +2 -2
  190. data/lib/ory-client/models/{reject_request.rb → reject_o_auth2_request.rb} +4 -4
  191. data/lib/ory-client/models/relation_query.rb +1 -1
  192. data/lib/ory-client/models/relation_tuple.rb +1 -1
  193. data/lib/ory-client/models/revoked_sessions.rb +1 -1
  194. data/lib/ory-client/models/schema_patch.rb +1 -1
  195. data/lib/ory-client/models/self_service_browser_location_change_required_error.rb +1 -1
  196. data/lib/ory-client/models/self_service_error.rb +2 -1
  197. data/lib/ory-client/models/self_service_flow_expired_error.rb +2 -1
  198. data/lib/ory-client/models/self_service_login_flow.rb +2 -1
  199. data/lib/ory-client/models/self_service_logout_url.rb +1 -1
  200. data/lib/ory-client/models/self_service_recovery_code.rb +250 -0
  201. data/lib/ory-client/models/self_service_recovery_flow.rb +3 -2
  202. data/lib/ory-client/models/self_service_recovery_flow_state.rb +1 -1
  203. data/lib/ory-client/models/self_service_recovery_link.rb +1 -1
  204. data/lib/ory-client/models/self_service_registration_flow.rb +2 -1
  205. data/lib/ory-client/models/self_service_settings_flow.rb +2 -1
  206. data/lib/ory-client/models/self_service_settings_flow_state.rb +1 -1
  207. data/lib/ory-client/models/self_service_verification_flow.rb +2 -1
  208. data/lib/ory-client/models/self_service_verification_flow_state.rb +1 -1
  209. data/lib/ory-client/models/session.rb +15 -2
  210. data/lib/ory-client/models/session_authentication_method.rb +3 -3
  211. data/lib/ory-client/models/session_device.rb +39 -3
  212. data/lib/ory-client/models/settings_profile_form_config.rb +1 -1
  213. data/lib/ory-client/models/source_position.rb +228 -0
  214. data/lib/ory-client/models/stripe_customer_response.rb +1 -1
  215. data/lib/ory-client/models/subject_set.rb +1 -1
  216. data/lib/ory-client/models/submit_self_service_flow_with_web_authn_registration_method.rb +1 -1
  217. data/lib/ory-client/models/submit_self_service_login_flow_body.rb +1 -1
  218. data/lib/ory-client/models/submit_self_service_login_flow_with_lookup_secret_method_body.rb +1 -1
  219. data/lib/ory-client/models/submit_self_service_login_flow_with_oidc_method_body.rb +1 -1
  220. data/lib/ory-client/models/submit_self_service_login_flow_with_password_method_body.rb +1 -1
  221. data/lib/ory-client/models/submit_self_service_login_flow_with_totp_method_body.rb +1 -1
  222. data/lib/ory-client/models/submit_self_service_login_flow_with_web_authn_method_body.rb +1 -1
  223. data/lib/ory-client/models/submit_self_service_logout_flow_without_browser_body.rb +1 -1
  224. data/lib/ory-client/models/submit_self_service_recovery_flow_body.rb +3 -1
  225. data/lib/ory-client/models/submit_self_service_recovery_flow_with_code_method_body.rb +255 -0
  226. data/lib/ory-client/models/submit_self_service_recovery_flow_with_link_method_body.rb +1 -1
  227. data/lib/ory-client/models/submit_self_service_registration_flow_body.rb +1 -1
  228. data/lib/ory-client/models/submit_self_service_registration_flow_with_oidc_method_body.rb +1 -1
  229. data/lib/ory-client/models/submit_self_service_registration_flow_with_password_method_body.rb +1 -1
  230. data/lib/ory-client/models/submit_self_service_registration_flow_with_web_authn_method_body.rb +1 -1
  231. data/lib/ory-client/models/submit_self_service_settings_flow_body.rb +1 -1
  232. data/lib/ory-client/models/submit_self_service_settings_flow_with_lookup_method_body.rb +1 -1
  233. data/lib/ory-client/models/submit_self_service_settings_flow_with_oidc_method_body.rb +1 -1
  234. data/lib/ory-client/models/submit_self_service_settings_flow_with_password_method_body.rb +1 -1
  235. data/lib/ory-client/models/submit_self_service_settings_flow_with_profile_method_body.rb +1 -1
  236. data/lib/ory-client/models/submit_self_service_settings_flow_with_totp_method_body.rb +1 -1
  237. data/lib/ory-client/models/submit_self_service_settings_flow_with_web_authn_method_body.rb +1 -1
  238. data/lib/ory-client/models/submit_self_service_verification_flow_body.rb +1 -1
  239. data/lib/ory-client/models/submit_self_service_verification_flow_with_link_method_body.rb +1 -1
  240. data/lib/ory-client/models/subscription.rb +1 -1
  241. data/lib/ory-client/models/{completed_request.rb → successful_o_auth2_request_response.rb} +4 -4
  242. data/lib/ory-client/models/successful_project_update.rb +1 -1
  243. data/lib/ory-client/models/successful_self_service_login_without_browser.rb +1 -1
  244. data/lib/ory-client/models/successful_self_service_registration_without_browser.rb +1 -1
  245. data/lib/ory-client/models/token_pagination.rb +1 -1
  246. data/lib/ory-client/models/token_pagination_headers.rb +1 -1
  247. data/lib/ory-client/models/{trusted_jwt_grant_issuer.rb → trusted_o_auth2_jwt_grant_issuer.rb} +5 -5
  248. data/lib/ory-client/models/{trusted_json_web_key.rb → trusted_o_auth2_jwt_grant_json_web_key.rb} +4 -4
  249. data/lib/ory-client/models/ui_container.rb +1 -1
  250. data/lib/ory-client/models/ui_node.rb +5 -5
  251. data/lib/ory-client/models/ui_node_anchor_attributes.rb +1 -1
  252. data/lib/ory-client/models/ui_node_attributes.rb +1 -1
  253. data/lib/ory-client/models/ui_node_image_attributes.rb +1 -1
  254. data/lib/ory-client/models/ui_node_input_attributes.rb +3 -3
  255. data/lib/ory-client/models/ui_node_meta.rb +1 -1
  256. data/lib/ory-client/models/ui_node_script_attributes.rb +1 -1
  257. data/lib/ory-client/models/ui_node_text_attributes.rb +1 -1
  258. data/lib/ory-client/models/ui_text.rb +1 -1
  259. data/lib/ory-client/models/update_custom_hostname_body.rb +1 -1
  260. data/lib/ory-client/models/update_o_auth2_client_lifespans.rb +535 -0
  261. data/lib/ory-client/models/update_project.rb +1 -1
  262. data/lib/ory-client/models/update_subscription_payload.rb +1 -1
  263. data/lib/ory-client/models/verifiable_identity_address.rb +2 -1
  264. data/lib/ory-client/models/version.rb +1 -1
  265. data/lib/ory-client/models/warning.rb +1 -1
  266. data/lib/ory-client/version.rb +2 -2
  267. data/lib/ory-client.rb +46 -28
  268. data/ory-client.gemspec +1 -1
  269. data/spec/api/admin_api_spec.rb +5 -400
  270. data/spec/api/metadata_api_spec.rb +1 -1
  271. data/spec/api/namespaces_api_spec.rb +46 -0
  272. data/spec/api/read_api_spec.rb +7 -7
  273. data/spec/api/syntax_api_spec.rb +47 -0
  274. data/spec/api/v0alpha2_api_spec.rb +573 -15
  275. data/spec/api/write_api_spec.rb +4 -4
  276. data/spec/api_client_spec.rb +1 -1
  277. data/spec/configuration_spec.rb +1 -1
  278. data/spec/models/{consent_request_session_spec.rb → accept_o_auth2_consent_request_session_spec.rb} +7 -7
  279. data/spec/models/{accept_consent_request_spec.rb → accept_o_auth2_consent_request_spec.rb} +7 -7
  280. data/spec/models/{accept_login_request_spec.rb → accept_o_auth2_login_request_spec.rb} +7 -7
  281. data/spec/models/active_project_spec.rb +1 -1
  282. data/spec/models/admin_create_identity_body_spec.rb +1 -1
  283. data/spec/models/admin_create_identity_import_credentials_oidc_config_spec.rb +1 -1
  284. data/spec/models/admin_create_identity_import_credentials_oidc_provider_spec.rb +1 -1
  285. data/spec/models/admin_create_identity_import_credentials_oidc_spec.rb +1 -1
  286. data/spec/models/admin_create_identity_import_credentials_password_config_spec.rb +1 -1
  287. data/spec/models/admin_create_identity_import_credentials_password_spec.rb +1 -1
  288. data/spec/models/{json_web_key_set_generator_request_spec.rb → admin_create_json_web_key_set_body_spec.rb} +7 -7
  289. data/spec/models/admin_create_self_service_recovery_code_body_spec.rb +40 -0
  290. data/spec/models/admin_create_self_service_recovery_link_body_spec.rb +1 -1
  291. data/spec/models/admin_identity_import_credentials_spec.rb +1 -1
  292. data/spec/models/{trust_jwt_grant_issuer_body_spec.rb → admin_trust_o_auth2_jwt_grant_issuer_body_spec.rb} +7 -7
  293. data/spec/models/admin_update_identity_body_spec.rb +1 -1
  294. data/spec/models/authenticator_assurance_level_spec.rb +1 -1
  295. data/spec/models/cloud_account_spec.rb +1 -1
  296. data/spec/models/cname_settings_spec.rb +1 -1
  297. data/spec/models/courier_message_status_spec.rb +28 -0
  298. data/spec/models/courier_message_type_spec.rb +28 -0
  299. data/spec/models/create_custom_hostname_body_spec.rb +1 -1
  300. data/spec/models/create_project_api_key_request_spec.rb +1 -1
  301. data/spec/models/create_project_body_spec.rb +1 -1
  302. data/spec/models/create_subscription_payload_spec.rb +1 -1
  303. data/spec/models/error_authenticator_assurance_level_not_satisfied_spec.rb +1 -1
  304. data/spec/models/expand_tree_spec.rb +1 -1
  305. data/spec/models/generic_error_content_spec.rb +1 -1
  306. data/spec/models/generic_error_spec.rb +1 -1
  307. data/spec/models/get_check_response_spec.rb +1 -1
  308. data/spec/models/get_managed_identity_schema_location_spec.rb +1 -1
  309. data/spec/models/{flush_login_consent_request_spec.rb → get_namespaces_response_spec.rb} +8 -8
  310. data/spec/models/get_relation_tuples_response_spec.rb +1 -1
  311. data/spec/models/get_version200_response_spec.rb +1 -1
  312. data/spec/models/{flush_inactive_o_auth2_tokens_request_spec.rb → handled_o_auth2_consent_request_spec.rb} +8 -8
  313. data/spec/models/{request_was_handled_response_spec.rb → handled_o_auth2_login_request_spec.rb} +7 -7
  314. data/spec/models/{completed_request_spec.rb → handled_o_auth2_logout_request_spec.rb} +7 -7
  315. data/spec/models/headers_spec.rb +34 -0
  316. data/spec/models/health_not_ready_status_spec.rb +1 -1
  317. data/spec/models/health_status_spec.rb +1 -1
  318. data/spec/models/id_token_claims_spec.rb +112 -0
  319. data/spec/models/identity_credentials_oidc_provider_spec.rb +1 -1
  320. data/spec/models/identity_credentials_oidc_spec.rb +1 -1
  321. data/spec/models/identity_credentials_password_spec.rb +1 -1
  322. data/spec/models/identity_credentials_spec.rb +1 -1
  323. data/spec/models/identity_credentials_type_spec.rb +1 -1
  324. data/spec/models/identity_schema_container_spec.rb +1 -1
  325. data/spec/models/identity_schema_preset_spec.rb +1 -1
  326. data/spec/models/identity_spec.rb +1 -1
  327. data/spec/models/identity_state_spec.rb +1 -1
  328. data/spec/models/{o_auth2_token_introspection_spec.rb → introspected_o_auth2_token_spec.rb} +7 -7
  329. data/spec/models/invite_payload_spec.rb +1 -1
  330. data/spec/models/is_owner_for_project_by_slug_payload_spec.rb +1 -1
  331. data/spec/models/is_owner_for_project_by_slug_spec.rb +1 -1
  332. data/spec/models/is_ready200_response_spec.rb +1 -1
  333. data/spec/models/is_ready503_response_spec.rb +1 -1
  334. data/spec/models/json_error_spec.rb +1 -19
  335. data/spec/models/json_patch_spec.rb +1 -1
  336. data/spec/models/json_web_key_set_spec.rb +7 -7
  337. data/spec/models/json_web_key_spec.rb +7 -7
  338. data/spec/models/keto_namespace_spec.rb +1 -1
  339. data/spec/models/managed_identity_schema_spec.rb +1 -1
  340. data/spec/models/managed_identity_schema_validation_result_spec.rb +1 -1
  341. data/spec/models/message_spec.rb +88 -0
  342. data/spec/models/namespace_spec.rb +34 -0
  343. data/spec/models/needs_privileged_session_error_spec.rb +1 -1
  344. data/spec/models/normalized_project_revision_hook_spec.rb +1 -1
  345. data/spec/models/normalized_project_revision_identity_schema_spec.rb +1 -1
  346. data/spec/models/normalized_project_revision_spec.rb +61 -1
  347. data/spec/models/normalized_project_revision_third_party_provider_spec.rb +1 -1
  348. data/spec/models/normalized_project_spec.rb +1 -1
  349. data/spec/models/null_plan_spec.rb +1 -1
  350. data/spec/models/o_auth2_access_request_spec.rb +52 -0
  351. data/spec/models/{patch_document_spec.rb → o_auth2_api_error_spec.rb} +11 -11
  352. data/spec/models/o_auth2_client_spec.rb +73 -1
  353. data/spec/models/{open_id_connect_context_spec.rb → o_auth2_consent_request_open_id_connect_context_spec.rb} +7 -7
  354. data/spec/models/{consent_request_spec.rb → o_auth2_consent_request_spec.rb} +7 -7
  355. data/spec/models/{oauth_token_response_spec.rb → o_auth2_consent_session_expires_at_spec.rb} +10 -16
  356. data/spec/models/o_auth2_consent_session_spec.rb +94 -0
  357. data/spec/models/{login_request_spec.rb → o_auth2_login_request_spec.rb} +7 -7
  358. data/spec/models/{logout_request_spec.rb → o_auth2_logout_request_spec.rb} +7 -7
  359. data/spec/models/{oauth2_token_response_spec.rb → o_auth2_token_response_spec.rb} +7 -7
  360. data/spec/models/{well_known_spec.rb → oidc_configuration_spec.rb} +19 -7
  361. data/spec/models/{userinfo_response_spec.rb → oidc_user_info_spec.rb} +7 -7
  362. data/spec/models/pagination_headers_spec.rb +40 -0
  363. data/spec/models/pagination_spec.rb +13 -1
  364. data/spec/models/parse_error_spec.rb +46 -0
  365. data/spec/models/patch_delta_spec.rb +1 -1
  366. data/spec/models/post_check_opl_syntax_response_spec.rb +34 -0
  367. data/spec/models/{previous_consent_session_spec.rb → previous_o_auth2_consent_session_spec.rb} +7 -7
  368. data/spec/models/project_api_key_spec.rb +1 -1
  369. data/spec/models/project_host_spec.rb +1 -1
  370. data/spec/models/project_invite_spec.rb +1 -1
  371. data/spec/models/project_metadata_spec.rb +1 -1
  372. data/spec/models/project_service_identity_spec.rb +1 -1
  373. data/spec/models/project_service_o_auth2_spec.rb +1 -1
  374. data/spec/models/project_service_permission_spec.rb +1 -1
  375. data/spec/models/project_services_spec.rb +1 -1
  376. data/spec/models/project_spec.rb +1 -1
  377. data/spec/models/provision_mock_subscription_payload_spec.rb +1 -1
  378. data/spec/models/quota_custom_domains_spec.rb +1 -1
  379. data/spec/models/quota_project_member_seats_spec.rb +1 -1
  380. data/spec/models/{recovery_address_spec.rb → recovery_identity_address_spec.rb} +7 -7
  381. data/spec/models/refresh_token_hook_request_spec.rb +13 -1
  382. data/spec/models/refresh_token_hook_response_spec.rb +1 -1
  383. data/spec/models/{reject_request_spec.rb → reject_o_auth2_request_spec.rb} +7 -7
  384. data/spec/models/relation_query_spec.rb +1 -1
  385. data/spec/models/relation_tuple_spec.rb +1 -1
  386. data/spec/models/revoked_sessions_spec.rb +1 -1
  387. data/spec/models/schema_patch_spec.rb +1 -1
  388. data/spec/models/self_service_browser_location_change_required_error_spec.rb +1 -1
  389. data/spec/models/self_service_error_spec.rb +1 -1
  390. data/spec/models/self_service_flow_expired_error_spec.rb +1 -1
  391. data/spec/models/self_service_login_flow_spec.rb +1 -1
  392. data/spec/models/self_service_logout_url_spec.rb +1 -1
  393. data/spec/models/self_service_recovery_code_spec.rb +46 -0
  394. data/spec/models/self_service_recovery_flow_spec.rb +1 -1
  395. data/spec/models/self_service_recovery_flow_state_spec.rb +1 -1
  396. data/spec/models/self_service_recovery_link_spec.rb +1 -1
  397. data/spec/models/self_service_registration_flow_spec.rb +1 -1
  398. data/spec/models/self_service_settings_flow_spec.rb +1 -1
  399. data/spec/models/self_service_settings_flow_state_spec.rb +1 -1
  400. data/spec/models/self_service_verification_flow_spec.rb +1 -1
  401. data/spec/models/self_service_verification_flow_state_spec.rb +1 -1
  402. data/spec/models/session_authentication_method_spec.rb +2 -2
  403. data/spec/models/session_device_spec.rb +19 -1
  404. data/spec/models/session_spec.rb +7 -1
  405. data/spec/models/settings_profile_form_config_spec.rb +1 -1
  406. data/spec/models/source_position_spec.rb +40 -0
  407. data/spec/models/stripe_customer_response_spec.rb +1 -1
  408. data/spec/models/subject_set_spec.rb +1 -1
  409. data/spec/models/submit_self_service_flow_with_web_authn_registration_method_spec.rb +1 -1
  410. data/spec/models/submit_self_service_login_flow_body_spec.rb +1 -1
  411. data/spec/models/submit_self_service_login_flow_with_lookup_secret_method_body_spec.rb +1 -1
  412. data/spec/models/submit_self_service_login_flow_with_oidc_method_body_spec.rb +1 -1
  413. data/spec/models/submit_self_service_login_flow_with_password_method_body_spec.rb +1 -1
  414. data/spec/models/submit_self_service_login_flow_with_totp_method_body_spec.rb +1 -1
  415. data/spec/models/submit_self_service_login_flow_with_web_authn_method_body_spec.rb +1 -1
  416. data/spec/models/submit_self_service_logout_flow_without_browser_body_spec.rb +1 -1
  417. data/spec/models/submit_self_service_recovery_flow_body_spec.rb +1 -1
  418. data/spec/models/submit_self_service_recovery_flow_with_code_method_body_spec.rb +52 -0
  419. data/spec/models/submit_self_service_recovery_flow_with_link_method_body_spec.rb +1 -1
  420. data/spec/models/submit_self_service_registration_flow_body_spec.rb +1 -1
  421. data/spec/models/submit_self_service_registration_flow_with_oidc_method_body_spec.rb +1 -1
  422. data/spec/models/submit_self_service_registration_flow_with_password_method_body_spec.rb +1 -1
  423. data/spec/models/submit_self_service_registration_flow_with_web_authn_method_body_spec.rb +1 -1
  424. data/spec/models/submit_self_service_settings_flow_body_spec.rb +1 -1
  425. data/spec/models/submit_self_service_settings_flow_with_lookup_method_body_spec.rb +1 -1
  426. data/spec/models/submit_self_service_settings_flow_with_oidc_method_body_spec.rb +1 -1
  427. data/spec/models/submit_self_service_settings_flow_with_password_method_body_spec.rb +1 -1
  428. data/spec/models/submit_self_service_settings_flow_with_profile_method_body_spec.rb +1 -1
  429. data/spec/models/submit_self_service_settings_flow_with_totp_method_body_spec.rb +1 -1
  430. data/spec/models/submit_self_service_settings_flow_with_web_authn_method_body_spec.rb +1 -1
  431. data/spec/models/submit_self_service_verification_flow_body_spec.rb +1 -1
  432. data/spec/models/submit_self_service_verification_flow_with_link_method_body_spec.rb +1 -1
  433. data/spec/models/subscription_spec.rb +1 -1
  434. data/spec/models/successful_o_auth2_request_response_spec.rb +34 -0
  435. data/spec/models/successful_project_update_spec.rb +1 -1
  436. data/spec/models/successful_self_service_login_without_browser_spec.rb +1 -1
  437. data/spec/models/successful_self_service_registration_without_browser_spec.rb +1 -1
  438. data/spec/models/token_pagination_headers_spec.rb +1 -1
  439. data/spec/models/token_pagination_spec.rb +1 -1
  440. data/spec/models/{trusted_jwt_grant_issuer_spec.rb → trusted_o_auth2_jwt_grant_issuer_spec.rb} +7 -7
  441. data/spec/models/{trusted_json_web_key_spec.rb → trusted_o_auth2_jwt_grant_json_web_key_spec.rb} +7 -7
  442. data/spec/models/ui_container_spec.rb +1 -1
  443. data/spec/models/ui_node_anchor_attributes_spec.rb +1 -1
  444. data/spec/models/ui_node_attributes_spec.rb +1 -1
  445. data/spec/models/ui_node_image_attributes_spec.rb +1 -1
  446. data/spec/models/ui_node_input_attributes_spec.rb +1 -1
  447. data/spec/models/ui_node_meta_spec.rb +1 -1
  448. data/spec/models/ui_node_script_attributes_spec.rb +1 -1
  449. data/spec/models/ui_node_spec.rb +2 -2
  450. data/spec/models/ui_node_text_attributes_spec.rb +1 -1
  451. data/spec/models/ui_text_spec.rb +1 -1
  452. data/spec/models/update_custom_hostname_body_spec.rb +1 -1
  453. data/spec/models/update_o_auth2_client_lifespans_spec.rb +100 -0
  454. data/spec/models/update_project_spec.rb +1 -1
  455. data/spec/models/update_subscription_payload_spec.rb +1 -1
  456. data/spec/models/verifiable_identity_address_spec.rb +1 -1
  457. data/spec/models/version_spec.rb +1 -1
  458. data/spec/models/warning_spec.rb +1 -1
  459. data/spec/spec_helper.rb +1 -1
  460. data/vendor/bundle/ruby/2.5.0/cache/psych-4.0.6.gem +0 -0
  461. data/vendor/bundle/ruby/2.5.0/extensions/x86_64-linux/2.5.0/byebug-11.1.3/gem_make.out +2 -2
  462. data/vendor/bundle/ruby/2.5.0/extensions/x86_64-linux/2.5.0/ffi-1.15.5/gem_make.out +2 -2
  463. data/vendor/bundle/ruby/2.5.0/extensions/x86_64-linux/2.5.0/jaro_winkler-1.5.4/gem_make.out +2 -2
  464. data/vendor/bundle/ruby/2.5.0/extensions/x86_64-linux/2.5.0/{psych-4.0.5 → psych-4.0.6}/gem.build_complete +0 -0
  465. data/vendor/bundle/ruby/2.5.0/extensions/x86_64-linux/2.5.0/{psych-4.0.5 → psych-4.0.6}/gem_make.out +6 -6
  466. data/vendor/bundle/ruby/2.5.0/extensions/x86_64-linux/2.5.0/{psych-4.0.5 → psych-4.0.6}/mkmf.log +0 -0
  467. data/vendor/bundle/ruby/2.5.0/extensions/x86_64-linux/2.5.0/{psych-4.0.5 → psych-4.0.6}/psych.so +0 -0
  468. data/vendor/bundle/ruby/2.5.0/extensions/x86_64-linux/2.5.0/stringio-3.0.2/gem_make.out +2 -2
  469. data/vendor/bundle/ruby/2.5.0/extensions/x86_64-linux/2.5.0/stringio-3.0.2/mkmf.log +1 -1
  470. data/vendor/bundle/ruby/2.5.0/gems/byebug-11.1.3/ext/byebug/Makefile +2 -2
  471. data/vendor/bundle/ruby/2.5.0/gems/ffi-1.15.5/ext/ffi_c/Makefile +2 -2
  472. data/vendor/bundle/ruby/2.5.0/gems/jaro_winkler-1.5.4/ext/jaro_winkler/Makefile +2 -2
  473. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/.gitignore +0 -0
  474. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/Gemfile +0 -0
  475. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/LICENSE +0 -0
  476. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/Mavenfile +0 -0
  477. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/README.md +0 -0
  478. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/Rakefile +0 -0
  479. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/bin/console +0 -0
  480. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/bin/setup +0 -0
  481. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/ext/psych/.sitearchdir.time +0 -0
  482. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/ext/psych/Makefile +2 -2
  483. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/ext/psych/api.o +0 -0
  484. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/ext/psych/depend +0 -0
  485. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/ext/psych/dumper.o +0 -0
  486. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/ext/psych/emitter.o +0 -0
  487. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/ext/psych/extconf.rb +0 -0
  488. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/ext/psych/loader.o +0 -0
  489. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/ext/psych/parser.o +0 -0
  490. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/ext/psych/psych.c +0 -0
  491. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/ext/psych/psych.h +0 -0
  492. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/ext/psych/psych.o +0 -0
  493. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5/lib → psych-4.0.6/ext/psych}/psych.so +0 -0
  494. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/ext/psych/psych_emitter.c +0 -0
  495. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/ext/psych/psych_emitter.h +0 -0
  496. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/ext/psych/psych_emitter.o +0 -0
  497. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/ext/psych/psych_parser.c +0 -0
  498. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/ext/psych/psych_parser.h +0 -0
  499. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/ext/psych/psych_parser.o +0 -0
  500. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/ext/psych/psych_to_ruby.c +0 -0
  501. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/ext/psych/psych_to_ruby.h +0 -0
  502. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/ext/psych/psych_to_ruby.o +0 -0
  503. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/ext/psych/psych_yaml_tree.c +0 -0
  504. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/ext/psych/psych_yaml_tree.h +0 -0
  505. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/ext/psych/psych_yaml_tree.o +0 -0
  506. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/ext/psych/reader.o +0 -0
  507. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/ext/psych/scanner.o +0 -0
  508. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/ext/psych/writer.o +0 -0
  509. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/ext/psych/yaml/LICENSE +0 -0
  510. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/ext/psych/yaml/api.c +0 -0
  511. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/ext/psych/yaml/config.h +0 -0
  512. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/ext/psych/yaml/dumper.c +0 -0
  513. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/ext/psych/yaml/emitter.c +0 -0
  514. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/ext/psych/yaml/loader.c +0 -0
  515. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/ext/psych/yaml/parser.c +0 -0
  516. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/ext/psych/yaml/reader.c +0 -0
  517. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/ext/psych/yaml/scanner.c +0 -0
  518. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/ext/psych/yaml/writer.c +0 -0
  519. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/ext/psych/yaml/yaml.h +0 -0
  520. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/ext/psych/yaml/yaml_private.h +0 -0
  521. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/lib/psych/class_loader.rb +0 -0
  522. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/lib/psych/coder.rb +0 -0
  523. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/lib/psych/core_ext.rb +0 -0
  524. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/lib/psych/exception.rb +0 -0
  525. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/lib/psych/handler.rb +0 -0
  526. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/lib/psych/handlers/document_stream.rb +0 -0
  527. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/lib/psych/handlers/recorder.rb +0 -0
  528. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/lib/psych/json/ruby_events.rb +0 -0
  529. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/lib/psych/json/stream.rb +0 -0
  530. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/lib/psych/json/tree_builder.rb +0 -0
  531. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/lib/psych/json/yaml_events.rb +0 -0
  532. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/lib/psych/nodes/alias.rb +0 -0
  533. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/lib/psych/nodes/document.rb +0 -0
  534. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/lib/psych/nodes/mapping.rb +0 -0
  535. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/lib/psych/nodes/node.rb +0 -0
  536. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/lib/psych/nodes/scalar.rb +0 -0
  537. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/lib/psych/nodes/sequence.rb +0 -0
  538. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/lib/psych/nodes/stream.rb +0 -0
  539. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/lib/psych/nodes.rb +0 -0
  540. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/lib/psych/omap.rb +0 -0
  541. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/lib/psych/parser.rb +0 -0
  542. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/lib/psych/scalar_scanner.rb +0 -0
  543. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/lib/psych/set.rb +0 -0
  544. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/lib/psych/stream.rb +0 -0
  545. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/lib/psych/streaming.rb +0 -0
  546. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/lib/psych/syntax_error.rb +0 -0
  547. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/lib/psych/tree_builder.rb +0 -0
  548. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/lib/psych/versions.rb +2 -2
  549. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/lib/psych/visitors/depth_first.rb +0 -0
  550. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/lib/psych/visitors/emitter.rb +0 -0
  551. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/lib/psych/visitors/json_tree.rb +0 -0
  552. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/lib/psych/visitors/to_ruby.rb +0 -0
  553. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/lib/psych/visitors/visitor.rb +0 -0
  554. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/lib/psych/visitors/yaml_tree.rb +0 -0
  555. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/lib/psych/visitors.rb +0 -0
  556. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/lib/psych/y.rb +0 -0
  557. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/lib/psych.rb +0 -0
  558. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5/ext/psych → psych-4.0.6/lib}/psych.so +0 -0
  559. data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.5 → psych-4.0.6}/psych.gemspec +0 -0
  560. data/vendor/bundle/ruby/2.5.0/gems/stringio-3.0.2/ext/stringio/Makefile +2 -2
  561. data/vendor/bundle/ruby/2.5.0/specifications/{psych-4.0.5.gemspec → psych-4.0.6.gemspec} +3 -3
  562. metadata +271 -199
  563. data/docs/FlushInactiveOAuth2TokensRequest.md +0 -18
  564. data/docs/FlushLoginConsentRequest.md +0 -18
  565. data/docs/JSONWebKeySet.md +0 -18
  566. data/docs/Oauth2TokenResponse.md +0 -28
  567. data/docs/PatchDocument.md +0 -24
  568. data/docs/PublicApi.md +0 -738
  569. data/lib/ory-client/api/public_api.rb +0 -723
  570. data/spec/api/public_api_spec.rb +0 -167
  571. data/vendor/bundle/ruby/2.5.0/cache/psych-4.0.5.gem +0 -0
data/docs/AdminApi.md CHANGED
@@ -4,2028 +4,16 @@ All URIs are relative to *https://playground.projects.oryapis.com*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
- | [**accept_consent_request**](AdminApi.md#accept_consent_request) | **PUT** /oauth2/auth/requests/consent/accept | Accept a Consent Request |
8
- | [**accept_login_request**](AdminApi.md#accept_login_request) | **PUT** /oauth2/auth/requests/login/accept | Accept a Login Request |
9
- | [**accept_logout_request**](AdminApi.md#accept_logout_request) | **PUT** /oauth2/auth/requests/logout/accept | Accept a Logout Request |
10
- | [**create_json_web_key_set**](AdminApi.md#create_json_web_key_set) | **POST** /keys/{set} | Generate a New JSON Web Key |
11
- | [**create_o_auth2_client**](AdminApi.md#create_o_auth2_client) | **POST** /clients | Create an OAuth 2.0 Client |
12
- | [**delete_json_web_key**](AdminApi.md#delete_json_web_key) | **DELETE** /keys/{set}/{kid} | Delete a JSON Web Key |
13
- | [**delete_json_web_key_set**](AdminApi.md#delete_json_web_key_set) | **DELETE** /keys/{set} | Delete a JSON Web Key Set |
14
- | [**delete_o_auth2_client**](AdminApi.md#delete_o_auth2_client) | **DELETE** /clients/{id} | Deletes an OAuth 2.0 Client |
15
- | [**delete_o_auth2_token**](AdminApi.md#delete_o_auth2_token) | **DELETE** /oauth2/tokens | Delete OAuth2 Access Tokens from a Client |
16
- | [**delete_trusted_jwt_grant_issuer**](AdminApi.md#delete_trusted_jwt_grant_issuer) | **DELETE** /trust/grants/jwt-bearer/issuers/{id} | Delete a Trusted OAuth2 JWT Bearer Grant Type Issuer |
17
- | [**flush_inactive_o_auth2_tokens**](AdminApi.md#flush_inactive_o_auth2_tokens) | **POST** /oauth2/flush | Flush Expired OAuth2 Access Tokens |
18
- | [**get_consent_request**](AdminApi.md#get_consent_request) | **GET** /oauth2/auth/requests/consent | Get Consent Request Information |
19
- | [**get_json_web_key**](AdminApi.md#get_json_web_key) | **GET** /keys/{set}/{kid} | Fetch a JSON Web Key |
20
- | [**get_json_web_key_set**](AdminApi.md#get_json_web_key_set) | **GET** /keys/{set} | Retrieve a JSON Web Key Set |
21
- | [**get_login_request**](AdminApi.md#get_login_request) | **GET** /oauth2/auth/requests/login | Get a Login Request |
22
- | [**get_logout_request**](AdminApi.md#get_logout_request) | **GET** /oauth2/auth/requests/logout | Get a Logout Request |
23
- | [**get_o_auth2_client**](AdminApi.md#get_o_auth2_client) | **GET** /clients/{id} | Get an OAuth 2.0 Client |
24
- | [**get_trusted_jwt_grant_issuer**](AdminApi.md#get_trusted_jwt_grant_issuer) | **GET** /trust/grants/jwt-bearer/issuers/{id} | Get a Trusted OAuth2 JWT Bearer Grant Type Issuer |
25
- | [**introspect_o_auth2_token**](AdminApi.md#introspect_o_auth2_token) | **POST** /oauth2/introspect | Introspect OAuth2 Tokens |
26
- | [**list_o_auth2_clients**](AdminApi.md#list_o_auth2_clients) | **GET** /clients | List OAuth 2.0 Clients |
27
- | [**list_subject_consent_sessions**](AdminApi.md#list_subject_consent_sessions) | **GET** /oauth2/auth/sessions/consent | Lists All Consent Sessions of a Subject |
28
- | [**list_trusted_jwt_grant_issuers**](AdminApi.md#list_trusted_jwt_grant_issuers) | **GET** /trust/grants/jwt-bearer/issuers | List Trusted OAuth2 JWT Bearer Grant Type Issuers |
29
- | [**patch_o_auth2_client**](AdminApi.md#patch_o_auth2_client) | **PATCH** /clients/{id} | Patch an OAuth 2.0 Client |
30
- | [**reject_consent_request**](AdminApi.md#reject_consent_request) | **PUT** /oauth2/auth/requests/consent/reject | Reject a Consent Request |
31
- | [**reject_login_request**](AdminApi.md#reject_login_request) | **PUT** /oauth2/auth/requests/login/reject | Reject a Login Request |
32
- | [**reject_logout_request**](AdminApi.md#reject_logout_request) | **PUT** /oauth2/auth/requests/logout/reject | Reject a Logout Request |
33
- | [**revoke_authentication_session**](AdminApi.md#revoke_authentication_session) | **DELETE** /oauth2/auth/sessions/login | Invalidates All Login Sessions of a Certain User Invalidates a Subject's Authentication Session |
34
- | [**revoke_consent_sessions**](AdminApi.md#revoke_consent_sessions) | **DELETE** /oauth2/auth/sessions/consent | Revokes Consent Sessions of a Subject for a Specific OAuth 2.0 Client |
35
- | [**trust_jwt_grant_issuer**](AdminApi.md#trust_jwt_grant_issuer) | **POST** /trust/grants/jwt-bearer/issuers | Trust an OAuth2 JWT Bearer Grant Type Issuer |
36
- | [**update_json_web_key**](AdminApi.md#update_json_web_key) | **PUT** /keys/{set}/{kid} | Update a JSON Web Key |
37
- | [**update_json_web_key_set**](AdminApi.md#update_json_web_key_set) | **PUT** /keys/{set} | Update a JSON Web Key Set |
38
- | [**update_o_auth2_client**](AdminApi.md#update_o_auth2_client) | **PUT** /clients/{id} | Update an OAuth 2.0 Client |
7
+ | [**update_o_auth2_client_lifespans**](AdminApi.md#update_o_auth2_client_lifespans) | **PUT** /admin/clients/{id}/lifespans | |
39
8
 
40
9
 
41
- ## accept_consent_request
10
+ ## update_o_auth2_client_lifespans
42
11
 
43
- > <CompletedRequest> accept_consent_request(consent_challenge, opts)
12
+ > <OAuth2Client> update_o_auth2_client_lifespans(id, opts)
44
13
 
45
- Accept a Consent Request
46
14
 
47
- 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.
48
15
 
49
- ### Examples
50
-
51
- ```ruby
52
- require 'time'
53
- require 'ory-client'
54
-
55
- api_instance = OryClient::AdminApi.new
56
- consent_challenge = 'consent_challenge_example' # String |
57
- opts = {
58
- accept_consent_request: OryClient::AcceptConsentRequest.new # AcceptConsentRequest |
59
- }
60
-
61
- begin
62
- # Accept a Consent Request
63
- result = api_instance.accept_consent_request(consent_challenge, opts)
64
- p result
65
- rescue OryClient::ApiError => e
66
- puts "Error when calling AdminApi->accept_consent_request: #{e}"
67
- end
68
- ```
69
-
70
- #### Using the accept_consent_request_with_http_info variant
71
-
72
- This returns an Array which contains the response data, status code and headers.
73
-
74
- > <Array(<CompletedRequest>, Integer, Hash)> accept_consent_request_with_http_info(consent_challenge, opts)
75
-
76
- ```ruby
77
- begin
78
- # Accept a Consent Request
79
- data, status_code, headers = api_instance.accept_consent_request_with_http_info(consent_challenge, opts)
80
- p status_code # => 2xx
81
- p headers # => { ... }
82
- p data # => <CompletedRequest>
83
- rescue OryClient::ApiError => e
84
- puts "Error when calling AdminApi->accept_consent_request_with_http_info: #{e}"
85
- end
86
- ```
87
-
88
- ### Parameters
89
-
90
- | Name | Type | Description | Notes |
91
- | ---- | ---- | ----------- | ----- |
92
- | **consent_challenge** | **String** | | |
93
- | **accept_consent_request** | [**AcceptConsentRequest**](AcceptConsentRequest.md) | | [optional] |
94
-
95
- ### Return type
96
-
97
- [**CompletedRequest**](CompletedRequest.md)
98
-
99
- ### Authorization
100
-
101
- No authorization required
102
-
103
- ### HTTP request headers
104
-
105
- - **Content-Type**: application/json
106
- - **Accept**: application/json
107
-
108
-
109
- ## accept_login_request
110
-
111
- > <CompletedRequest> accept_login_request(login_challenge, opts)
112
-
113
- Accept a Login Request
114
-
115
- 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.
116
-
117
- ### Examples
118
-
119
- ```ruby
120
- require 'time'
121
- require 'ory-client'
122
-
123
- api_instance = OryClient::AdminApi.new
124
- login_challenge = 'login_challenge_example' # String |
125
- opts = {
126
- accept_login_request: OryClient::AcceptLoginRequest.new({subject: 'subject_example'}) # AcceptLoginRequest |
127
- }
128
-
129
- begin
130
- # Accept a Login Request
131
- result = api_instance.accept_login_request(login_challenge, opts)
132
- p result
133
- rescue OryClient::ApiError => e
134
- puts "Error when calling AdminApi->accept_login_request: #{e}"
135
- end
136
- ```
137
-
138
- #### Using the accept_login_request_with_http_info variant
139
-
140
- This returns an Array which contains the response data, status code and headers.
141
-
142
- > <Array(<CompletedRequest>, Integer, Hash)> accept_login_request_with_http_info(login_challenge, opts)
143
-
144
- ```ruby
145
- begin
146
- # Accept a Login Request
147
- data, status_code, headers = api_instance.accept_login_request_with_http_info(login_challenge, opts)
148
- p status_code # => 2xx
149
- p headers # => { ... }
150
- p data # => <CompletedRequest>
151
- rescue OryClient::ApiError => e
152
- puts "Error when calling AdminApi->accept_login_request_with_http_info: #{e}"
153
- end
154
- ```
155
-
156
- ### Parameters
157
-
158
- | Name | Type | Description | Notes |
159
- | ---- | ---- | ----------- | ----- |
160
- | **login_challenge** | **String** | | |
161
- | **accept_login_request** | [**AcceptLoginRequest**](AcceptLoginRequest.md) | | [optional] |
162
-
163
- ### Return type
164
-
165
- [**CompletedRequest**](CompletedRequest.md)
166
-
167
- ### Authorization
168
-
169
- No authorization required
170
-
171
- ### HTTP request headers
172
-
173
- - **Content-Type**: application/json
174
- - **Accept**: application/json
175
-
176
-
177
- ## accept_logout_request
178
-
179
- > <CompletedRequest> accept_logout_request(logout_challenge)
180
-
181
- Accept a Logout Request
182
-
183
- When a user or an application requests ORY Hydra to log out a user, this endpoint is used to confirm that logout request. No body is required. The response contains a redirect URL which the consent provider should redirect the user-agent to.
184
-
185
- ### Examples
186
-
187
- ```ruby
188
- require 'time'
189
- require 'ory-client'
190
-
191
- api_instance = OryClient::AdminApi.new
192
- logout_challenge = 'logout_challenge_example' # String |
193
-
194
- begin
195
- # Accept a Logout Request
196
- result = api_instance.accept_logout_request(logout_challenge)
197
- p result
198
- rescue OryClient::ApiError => e
199
- puts "Error when calling AdminApi->accept_logout_request: #{e}"
200
- end
201
- ```
202
-
203
- #### Using the accept_logout_request_with_http_info variant
204
-
205
- This returns an Array which contains the response data, status code and headers.
206
-
207
- > <Array(<CompletedRequest>, Integer, Hash)> accept_logout_request_with_http_info(logout_challenge)
208
-
209
- ```ruby
210
- begin
211
- # Accept a Logout Request
212
- data, status_code, headers = api_instance.accept_logout_request_with_http_info(logout_challenge)
213
- p status_code # => 2xx
214
- p headers # => { ... }
215
- p data # => <CompletedRequest>
216
- rescue OryClient::ApiError => e
217
- puts "Error when calling AdminApi->accept_logout_request_with_http_info: #{e}"
218
- end
219
- ```
220
-
221
- ### Parameters
222
-
223
- | Name | Type | Description | Notes |
224
- | ---- | ---- | ----------- | ----- |
225
- | **logout_challenge** | **String** | | |
226
-
227
- ### Return type
228
-
229
- [**CompletedRequest**](CompletedRequest.md)
230
-
231
- ### Authorization
232
-
233
- No authorization required
234
-
235
- ### HTTP request headers
236
-
237
- - **Content-Type**: Not defined
238
- - **Accept**: application/json
239
-
240
-
241
- ## create_json_web_key_set
242
-
243
- > <JSONWebKeySet> create_json_web_key_set(set, opts)
244
-
245
- Generate a New JSON Web Key
246
-
247
- 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.
248
-
249
- ### Examples
250
-
251
- ```ruby
252
- require 'time'
253
- require 'ory-client'
254
-
255
- api_instance = OryClient::AdminApi.new
256
- set = 'set_example' # String | The set
257
- opts = {
258
- json_web_key_set_generator_request: OryClient::JsonWebKeySetGeneratorRequest.new({alg: 'alg_example', kid: 'kid_example', use: 'use_example'}) # JsonWebKeySetGeneratorRequest |
259
- }
260
-
261
- begin
262
- # Generate a New JSON Web Key
263
- result = api_instance.create_json_web_key_set(set, opts)
264
- p result
265
- rescue OryClient::ApiError => e
266
- puts "Error when calling AdminApi->create_json_web_key_set: #{e}"
267
- end
268
- ```
269
-
270
- #### Using the create_json_web_key_set_with_http_info variant
271
-
272
- This returns an Array which contains the response data, status code and headers.
273
-
274
- > <Array(<JSONWebKeySet>, Integer, Hash)> create_json_web_key_set_with_http_info(set, opts)
275
-
276
- ```ruby
277
- begin
278
- # Generate a New JSON Web Key
279
- data, status_code, headers = api_instance.create_json_web_key_set_with_http_info(set, opts)
280
- p status_code # => 2xx
281
- p headers # => { ... }
282
- p data # => <JSONWebKeySet>
283
- rescue OryClient::ApiError => e
284
- puts "Error when calling AdminApi->create_json_web_key_set_with_http_info: #{e}"
285
- end
286
- ```
287
-
288
- ### Parameters
289
-
290
- | Name | Type | Description | Notes |
291
- | ---- | ---- | ----------- | ----- |
292
- | **set** | **String** | The set | |
293
- | **json_web_key_set_generator_request** | [**JsonWebKeySetGeneratorRequest**](JsonWebKeySetGeneratorRequest.md) | | [optional] |
294
-
295
- ### Return type
296
-
297
- [**JSONWebKeySet**](JSONWebKeySet.md)
298
-
299
- ### Authorization
300
-
301
- No authorization required
302
-
303
- ### HTTP request headers
304
-
305
- - **Content-Type**: application/json
306
- - **Accept**: application/json
307
-
308
-
309
- ## create_o_auth2_client
310
-
311
- > <OAuth2Client> create_o_auth2_client(o_auth2_client)
312
-
313
- Create an OAuth 2.0 Client
314
-
315
- Create a new OAuth 2.0 client If you pass `client_secret` the secret will be used, otherwise a random secret will be generated. The 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 somwhere 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.
316
-
317
- ### Examples
318
-
319
- ```ruby
320
- require 'time'
321
- require 'ory-client'
322
-
323
- api_instance = OryClient::AdminApi.new
324
- o_auth2_client = OryClient::OAuth2Client.new # OAuth2Client |
325
-
326
- begin
327
- # Create an OAuth 2.0 Client
328
- result = api_instance.create_o_auth2_client(o_auth2_client)
329
- p result
330
- rescue OryClient::ApiError => e
331
- puts "Error when calling AdminApi->create_o_auth2_client: #{e}"
332
- end
333
- ```
334
-
335
- #### Using the create_o_auth2_client_with_http_info variant
336
-
337
- This returns an Array which contains the response data, status code and headers.
338
-
339
- > <Array(<OAuth2Client>, Integer, Hash)> create_o_auth2_client_with_http_info(o_auth2_client)
340
-
341
- ```ruby
342
- begin
343
- # Create an OAuth 2.0 Client
344
- data, status_code, headers = api_instance.create_o_auth2_client_with_http_info(o_auth2_client)
345
- p status_code # => 2xx
346
- p headers # => { ... }
347
- p data # => <OAuth2Client>
348
- rescue OryClient::ApiError => e
349
- puts "Error when calling AdminApi->create_o_auth2_client_with_http_info: #{e}"
350
- end
351
- ```
352
-
353
- ### Parameters
354
-
355
- | Name | Type | Description | Notes |
356
- | ---- | ---- | ----------- | ----- |
357
- | **o_auth2_client** | [**OAuth2Client**](OAuth2Client.md) | | |
358
-
359
- ### Return type
360
-
361
- [**OAuth2Client**](OAuth2Client.md)
362
-
363
- ### Authorization
364
-
365
- No authorization required
366
-
367
- ### HTTP request headers
368
-
369
- - **Content-Type**: application/json
370
- - **Accept**: application/json
371
-
372
-
373
- ## delete_json_web_key
374
-
375
- > delete_json_web_key(kid, set)
376
-
377
- Delete a JSON Web Key
378
-
379
- 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.
380
-
381
- ### Examples
382
-
383
- ```ruby
384
- require 'time'
385
- require 'ory-client'
386
-
387
- api_instance = OryClient::AdminApi.new
388
- kid = 'kid_example' # String | The kid of the desired key
389
- set = 'set_example' # String | The set
390
-
391
- begin
392
- # Delete a JSON Web Key
393
- api_instance.delete_json_web_key(kid, set)
394
- rescue OryClient::ApiError => e
395
- puts "Error when calling AdminApi->delete_json_web_key: #{e}"
396
- end
397
- ```
398
-
399
- #### Using the delete_json_web_key_with_http_info variant
400
-
401
- This returns an Array which contains the response data (`nil` in this case), status code and headers.
402
-
403
- > <Array(nil, Integer, Hash)> delete_json_web_key_with_http_info(kid, set)
404
-
405
- ```ruby
406
- begin
407
- # Delete a JSON Web Key
408
- data, status_code, headers = api_instance.delete_json_web_key_with_http_info(kid, set)
409
- p status_code # => 2xx
410
- p headers # => { ... }
411
- p data # => nil
412
- rescue OryClient::ApiError => e
413
- puts "Error when calling AdminApi->delete_json_web_key_with_http_info: #{e}"
414
- end
415
- ```
416
-
417
- ### Parameters
418
-
419
- | Name | Type | Description | Notes |
420
- | ---- | ---- | ----------- | ----- |
421
- | **kid** | **String** | The kid of the desired key | |
422
- | **set** | **String** | The set | |
423
-
424
- ### Return type
425
-
426
- nil (empty response body)
427
-
428
- ### Authorization
429
-
430
- No authorization required
431
-
432
- ### HTTP request headers
433
-
434
- - **Content-Type**: Not defined
435
- - **Accept**: application/json
436
-
437
-
438
- ## delete_json_web_key_set
439
-
440
- > delete_json_web_key_set(set)
441
-
442
- Delete a JSON Web Key Set
443
-
444
- 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.
445
-
446
- ### Examples
447
-
448
- ```ruby
449
- require 'time'
450
- require 'ory-client'
451
-
452
- api_instance = OryClient::AdminApi.new
453
- set = 'set_example' # String | The set
454
-
455
- begin
456
- # Delete a JSON Web Key Set
457
- api_instance.delete_json_web_key_set(set)
458
- rescue OryClient::ApiError => e
459
- puts "Error when calling AdminApi->delete_json_web_key_set: #{e}"
460
- end
461
- ```
462
-
463
- #### Using the delete_json_web_key_set_with_http_info variant
464
-
465
- This returns an Array which contains the response data (`nil` in this case), status code and headers.
466
-
467
- > <Array(nil, Integer, Hash)> delete_json_web_key_set_with_http_info(set)
468
-
469
- ```ruby
470
- begin
471
- # Delete a JSON Web Key Set
472
- data, status_code, headers = api_instance.delete_json_web_key_set_with_http_info(set)
473
- p status_code # => 2xx
474
- p headers # => { ... }
475
- p data # => nil
476
- rescue OryClient::ApiError => e
477
- puts "Error when calling AdminApi->delete_json_web_key_set_with_http_info: #{e}"
478
- end
479
- ```
480
-
481
- ### Parameters
482
-
483
- | Name | Type | Description | Notes |
484
- | ---- | ---- | ----------- | ----- |
485
- | **set** | **String** | The set | |
486
-
487
- ### Return type
488
-
489
- nil (empty response body)
490
-
491
- ### Authorization
492
-
493
- No authorization required
494
-
495
- ### HTTP request headers
496
-
497
- - **Content-Type**: Not defined
498
- - **Accept**: application/json
499
-
500
-
501
- ## delete_o_auth2_client
502
-
503
- > delete_o_auth2_client(id)
504
-
505
- Deletes an OAuth 2.0 Client
506
-
507
- 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.
508
-
509
- ### Examples
510
-
511
- ```ruby
512
- require 'time'
513
- require 'ory-client'
514
-
515
- api_instance = OryClient::AdminApi.new
516
- id = 'id_example' # String | The id of the OAuth 2.0 Client.
517
-
518
- begin
519
- # Deletes an OAuth 2.0 Client
520
- api_instance.delete_o_auth2_client(id)
521
- rescue OryClient::ApiError => e
522
- puts "Error when calling AdminApi->delete_o_auth2_client: #{e}"
523
- end
524
- ```
525
-
526
- #### Using the delete_o_auth2_client_with_http_info variant
527
-
528
- This returns an Array which contains the response data (`nil` in this case), status code and headers.
529
-
530
- > <Array(nil, Integer, Hash)> delete_o_auth2_client_with_http_info(id)
531
-
532
- ```ruby
533
- begin
534
- # Deletes an OAuth 2.0 Client
535
- data, status_code, headers = api_instance.delete_o_auth2_client_with_http_info(id)
536
- p status_code # => 2xx
537
- p headers # => { ... }
538
- p data # => nil
539
- rescue OryClient::ApiError => e
540
- puts "Error when calling AdminApi->delete_o_auth2_client_with_http_info: #{e}"
541
- end
542
- ```
543
-
544
- ### Parameters
545
-
546
- | Name | Type | Description | Notes |
547
- | ---- | ---- | ----------- | ----- |
548
- | **id** | **String** | The id of the OAuth 2.0 Client. | |
549
-
550
- ### Return type
551
-
552
- nil (empty response body)
553
-
554
- ### Authorization
555
-
556
- No authorization required
557
-
558
- ### HTTP request headers
559
-
560
- - **Content-Type**: Not defined
561
- - **Accept**: application/json
562
-
563
-
564
- ## delete_o_auth2_token
565
-
566
- > delete_o_auth2_token(client_id)
567
-
568
- Delete OAuth2 Access Tokens from a Client
569
-
570
- This endpoint deletes OAuth2 access tokens issued for a client from the database
571
-
572
- ### Examples
573
-
574
- ```ruby
575
- require 'time'
576
- require 'ory-client'
577
-
578
- api_instance = OryClient::AdminApi.new
579
- client_id = 'client_id_example' # String |
580
-
581
- begin
582
- # Delete OAuth2 Access Tokens from a Client
583
- api_instance.delete_o_auth2_token(client_id)
584
- rescue OryClient::ApiError => e
585
- puts "Error when calling AdminApi->delete_o_auth2_token: #{e}"
586
- end
587
- ```
588
-
589
- #### Using the delete_o_auth2_token_with_http_info variant
590
-
591
- This returns an Array which contains the response data (`nil` in this case), status code and headers.
592
-
593
- > <Array(nil, Integer, Hash)> delete_o_auth2_token_with_http_info(client_id)
594
-
595
- ```ruby
596
- begin
597
- # Delete OAuth2 Access Tokens from a Client
598
- data, status_code, headers = api_instance.delete_o_auth2_token_with_http_info(client_id)
599
- p status_code # => 2xx
600
- p headers # => { ... }
601
- p data # => nil
602
- rescue OryClient::ApiError => e
603
- puts "Error when calling AdminApi->delete_o_auth2_token_with_http_info: #{e}"
604
- end
605
- ```
606
-
607
- ### Parameters
608
-
609
- | Name | Type | Description | Notes |
610
- | ---- | ---- | ----------- | ----- |
611
- | **client_id** | **String** | | |
612
-
613
- ### Return type
614
-
615
- nil (empty response body)
616
-
617
- ### Authorization
618
-
619
- No authorization required
620
-
621
- ### HTTP request headers
622
-
623
- - **Content-Type**: Not defined
624
- - **Accept**: application/json
625
-
626
-
627
- ## delete_trusted_jwt_grant_issuer
628
-
629
- > delete_trusted_jwt_grant_issuer(id)
630
-
631
- Delete a Trusted OAuth2 JWT Bearer Grant Type Issuer
632
-
633
- 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.
634
-
635
- ### Examples
636
-
637
- ```ruby
638
- require 'time'
639
- require 'ory-client'
640
-
641
- api_instance = OryClient::AdminApi.new
642
- id = 'id_example' # String | The id of the desired grant
643
-
644
- begin
645
- # Delete a Trusted OAuth2 JWT Bearer Grant Type Issuer
646
- api_instance.delete_trusted_jwt_grant_issuer(id)
647
- rescue OryClient::ApiError => e
648
- puts "Error when calling AdminApi->delete_trusted_jwt_grant_issuer: #{e}"
649
- end
650
- ```
651
-
652
- #### Using the delete_trusted_jwt_grant_issuer_with_http_info variant
653
-
654
- This returns an Array which contains the response data (`nil` in this case), status code and headers.
655
-
656
- > <Array(nil, Integer, Hash)> delete_trusted_jwt_grant_issuer_with_http_info(id)
657
-
658
- ```ruby
659
- begin
660
- # Delete a Trusted OAuth2 JWT Bearer Grant Type Issuer
661
- data, status_code, headers = api_instance.delete_trusted_jwt_grant_issuer_with_http_info(id)
662
- p status_code # => 2xx
663
- p headers # => { ... }
664
- p data # => nil
665
- rescue OryClient::ApiError => e
666
- puts "Error when calling AdminApi->delete_trusted_jwt_grant_issuer_with_http_info: #{e}"
667
- end
668
- ```
669
-
670
- ### Parameters
671
-
672
- | Name | Type | Description | Notes |
673
- | ---- | ---- | ----------- | ----- |
674
- | **id** | **String** | The id of the desired grant | |
675
-
676
- ### Return type
677
-
678
- nil (empty response body)
679
-
680
- ### Authorization
681
-
682
- No authorization required
683
-
684
- ### HTTP request headers
685
-
686
- - **Content-Type**: Not defined
687
- - **Accept**: application/json
688
-
689
-
690
- ## flush_inactive_o_auth2_tokens
691
-
692
- > flush_inactive_o_auth2_tokens(opts)
693
-
694
- Flush Expired OAuth2 Access Tokens
695
-
696
- This endpoint flushes expired OAuth2 access tokens from the database. You can set a time after which no tokens will be not be touched, in case you want to keep recent tokens for auditing. Refresh tokens can not be flushed as they are deleted automatically when performing the refresh flow.
697
-
698
- ### Examples
699
-
700
- ```ruby
701
- require 'time'
702
- require 'ory-client'
703
-
704
- api_instance = OryClient::AdminApi.new
705
- opts = {
706
- flush_inactive_o_auth2_tokens_request: OryClient::FlushInactiveOAuth2TokensRequest.new # FlushInactiveOAuth2TokensRequest |
707
- }
708
-
709
- begin
710
- # Flush Expired OAuth2 Access Tokens
711
- api_instance.flush_inactive_o_auth2_tokens(opts)
712
- rescue OryClient::ApiError => e
713
- puts "Error when calling AdminApi->flush_inactive_o_auth2_tokens: #{e}"
714
- end
715
- ```
716
-
717
- #### Using the flush_inactive_o_auth2_tokens_with_http_info variant
718
-
719
- This returns an Array which contains the response data (`nil` in this case), status code and headers.
720
-
721
- > <Array(nil, Integer, Hash)> flush_inactive_o_auth2_tokens_with_http_info(opts)
722
-
723
- ```ruby
724
- begin
725
- # Flush Expired OAuth2 Access Tokens
726
- data, status_code, headers = api_instance.flush_inactive_o_auth2_tokens_with_http_info(opts)
727
- p status_code # => 2xx
728
- p headers # => { ... }
729
- p data # => nil
730
- rescue OryClient::ApiError => e
731
- puts "Error when calling AdminApi->flush_inactive_o_auth2_tokens_with_http_info: #{e}"
732
- end
733
- ```
734
-
735
- ### Parameters
736
-
737
- | Name | Type | Description | Notes |
738
- | ---- | ---- | ----------- | ----- |
739
- | **flush_inactive_o_auth2_tokens_request** | [**FlushInactiveOAuth2TokensRequest**](FlushInactiveOAuth2TokensRequest.md) | | [optional] |
740
-
741
- ### Return type
742
-
743
- nil (empty response body)
744
-
745
- ### Authorization
746
-
747
- No authorization required
748
-
749
- ### HTTP request headers
750
-
751
- - **Content-Type**: application/json
752
- - **Accept**: application/json
753
-
754
-
755
- ## get_consent_request
756
-
757
- > <ConsentRequest> get_consent_request(consent_challenge)
758
-
759
- Get Consent Request Information
760
-
761
- 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.
762
-
763
- ### Examples
764
-
765
- ```ruby
766
- require 'time'
767
- require 'ory-client'
768
-
769
- api_instance = OryClient::AdminApi.new
770
- consent_challenge = 'consent_challenge_example' # String |
771
-
772
- begin
773
- # Get Consent Request Information
774
- result = api_instance.get_consent_request(consent_challenge)
775
- p result
776
- rescue OryClient::ApiError => e
777
- puts "Error when calling AdminApi->get_consent_request: #{e}"
778
- end
779
- ```
780
-
781
- #### Using the get_consent_request_with_http_info variant
782
-
783
- This returns an Array which contains the response data, status code and headers.
784
-
785
- > <Array(<ConsentRequest>, Integer, Hash)> get_consent_request_with_http_info(consent_challenge)
786
-
787
- ```ruby
788
- begin
789
- # Get Consent Request Information
790
- data, status_code, headers = api_instance.get_consent_request_with_http_info(consent_challenge)
791
- p status_code # => 2xx
792
- p headers # => { ... }
793
- p data # => <ConsentRequest>
794
- rescue OryClient::ApiError => e
795
- puts "Error when calling AdminApi->get_consent_request_with_http_info: #{e}"
796
- end
797
- ```
798
-
799
- ### Parameters
800
-
801
- | Name | Type | Description | Notes |
802
- | ---- | ---- | ----------- | ----- |
803
- | **consent_challenge** | **String** | | |
804
-
805
- ### Return type
806
-
807
- [**ConsentRequest**](ConsentRequest.md)
808
-
809
- ### Authorization
810
-
811
- No authorization required
812
-
813
- ### HTTP request headers
814
-
815
- - **Content-Type**: Not defined
816
- - **Accept**: application/json
817
-
818
-
819
- ## get_json_web_key
820
-
821
- > <JSONWebKeySet> get_json_web_key(kid, set)
822
-
823
- Fetch a JSON Web Key
824
-
825
- This endpoint returns a singular JSON Web Key, identified by the set and the specific key ID (kid).
826
-
827
- ### Examples
828
-
829
- ```ruby
830
- require 'time'
831
- require 'ory-client'
832
-
833
- api_instance = OryClient::AdminApi.new
834
- kid = 'kid_example' # String | The kid of the desired key
835
- set = 'set_example' # String | The set
836
-
837
- begin
838
- # Fetch a JSON Web Key
839
- result = api_instance.get_json_web_key(kid, set)
840
- p result
841
- rescue OryClient::ApiError => e
842
- puts "Error when calling AdminApi->get_json_web_key: #{e}"
843
- end
844
- ```
845
-
846
- #### Using the get_json_web_key_with_http_info variant
847
-
848
- This returns an Array which contains the response data, status code and headers.
849
-
850
- > <Array(<JSONWebKeySet>, Integer, Hash)> get_json_web_key_with_http_info(kid, set)
851
-
852
- ```ruby
853
- begin
854
- # Fetch a JSON Web Key
855
- data, status_code, headers = api_instance.get_json_web_key_with_http_info(kid, set)
856
- p status_code # => 2xx
857
- p headers # => { ... }
858
- p data # => <JSONWebKeySet>
859
- rescue OryClient::ApiError => e
860
- puts "Error when calling AdminApi->get_json_web_key_with_http_info: #{e}"
861
- end
862
- ```
863
-
864
- ### Parameters
865
-
866
- | Name | Type | Description | Notes |
867
- | ---- | ---- | ----------- | ----- |
868
- | **kid** | **String** | The kid of the desired key | |
869
- | **set** | **String** | The set | |
870
-
871
- ### Return type
872
-
873
- [**JSONWebKeySet**](JSONWebKeySet.md)
874
-
875
- ### Authorization
876
-
877
- No authorization required
878
-
879
- ### HTTP request headers
880
-
881
- - **Content-Type**: Not defined
882
- - **Accept**: application/json
883
-
884
-
885
- ## get_json_web_key_set
886
-
887
- > <JSONWebKeySet> get_json_web_key_set(set)
888
-
889
- Retrieve a JSON Web Key Set
890
-
891
- 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.
892
-
893
- ### Examples
894
-
895
- ```ruby
896
- require 'time'
897
- require 'ory-client'
898
-
899
- api_instance = OryClient::AdminApi.new
900
- set = 'set_example' # String | The set
901
-
902
- begin
903
- # Retrieve a JSON Web Key Set
904
- result = api_instance.get_json_web_key_set(set)
905
- p result
906
- rescue OryClient::ApiError => e
907
- puts "Error when calling AdminApi->get_json_web_key_set: #{e}"
908
- end
909
- ```
910
-
911
- #### Using the get_json_web_key_set_with_http_info variant
912
-
913
- This returns an Array which contains the response data, status code and headers.
914
-
915
- > <Array(<JSONWebKeySet>, Integer, Hash)> get_json_web_key_set_with_http_info(set)
916
-
917
- ```ruby
918
- begin
919
- # Retrieve a JSON Web Key Set
920
- data, status_code, headers = api_instance.get_json_web_key_set_with_http_info(set)
921
- p status_code # => 2xx
922
- p headers # => { ... }
923
- p data # => <JSONWebKeySet>
924
- rescue OryClient::ApiError => e
925
- puts "Error when calling AdminApi->get_json_web_key_set_with_http_info: #{e}"
926
- end
927
- ```
928
-
929
- ### Parameters
930
-
931
- | Name | Type | Description | Notes |
932
- | ---- | ---- | ----------- | ----- |
933
- | **set** | **String** | The set | |
934
-
935
- ### Return type
936
-
937
- [**JSONWebKeySet**](JSONWebKeySet.md)
938
-
939
- ### Authorization
940
-
941
- No authorization required
942
-
943
- ### HTTP request headers
944
-
945
- - **Content-Type**: Not defined
946
- - **Accept**: application/json
947
-
948
-
949
- ## get_login_request
950
-
951
- > <LoginRequest> get_login_request(login_challenge)
952
-
953
- Get a Login Request
954
-
955
- 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.
956
-
957
- ### Examples
958
-
959
- ```ruby
960
- require 'time'
961
- require 'ory-client'
962
-
963
- api_instance = OryClient::AdminApi.new
964
- login_challenge = 'login_challenge_example' # String |
965
-
966
- begin
967
- # Get a Login Request
968
- result = api_instance.get_login_request(login_challenge)
969
- p result
970
- rescue OryClient::ApiError => e
971
- puts "Error when calling AdminApi->get_login_request: #{e}"
972
- end
973
- ```
974
-
975
- #### Using the get_login_request_with_http_info variant
976
-
977
- This returns an Array which contains the response data, status code and headers.
978
-
979
- > <Array(<LoginRequest>, Integer, Hash)> get_login_request_with_http_info(login_challenge)
980
-
981
- ```ruby
982
- begin
983
- # Get a Login Request
984
- data, status_code, headers = api_instance.get_login_request_with_http_info(login_challenge)
985
- p status_code # => 2xx
986
- p headers # => { ... }
987
- p data # => <LoginRequest>
988
- rescue OryClient::ApiError => e
989
- puts "Error when calling AdminApi->get_login_request_with_http_info: #{e}"
990
- end
991
- ```
992
-
993
- ### Parameters
994
-
995
- | Name | Type | Description | Notes |
996
- | ---- | ---- | ----------- | ----- |
997
- | **login_challenge** | **String** | | |
998
-
999
- ### Return type
1000
-
1001
- [**LoginRequest**](LoginRequest.md)
1002
-
1003
- ### Authorization
1004
-
1005
- No authorization required
1006
-
1007
- ### HTTP request headers
1008
-
1009
- - **Content-Type**: Not defined
1010
- - **Accept**: application/json
1011
-
1012
-
1013
- ## get_logout_request
1014
-
1015
- > <LogoutRequest> get_logout_request(logout_challenge)
1016
-
1017
- Get a Logout Request
1018
-
1019
- Use this endpoint to fetch a logout request.
1020
-
1021
- ### Examples
1022
-
1023
- ```ruby
1024
- require 'time'
1025
- require 'ory-client'
1026
-
1027
- api_instance = OryClient::AdminApi.new
1028
- logout_challenge = 'logout_challenge_example' # String |
1029
-
1030
- begin
1031
- # Get a Logout Request
1032
- result = api_instance.get_logout_request(logout_challenge)
1033
- p result
1034
- rescue OryClient::ApiError => e
1035
- puts "Error when calling AdminApi->get_logout_request: #{e}"
1036
- end
1037
- ```
1038
-
1039
- #### Using the get_logout_request_with_http_info variant
1040
-
1041
- This returns an Array which contains the response data, status code and headers.
1042
-
1043
- > <Array(<LogoutRequest>, Integer, Hash)> get_logout_request_with_http_info(logout_challenge)
1044
-
1045
- ```ruby
1046
- begin
1047
- # Get a Logout Request
1048
- data, status_code, headers = api_instance.get_logout_request_with_http_info(logout_challenge)
1049
- p status_code # => 2xx
1050
- p headers # => { ... }
1051
- p data # => <LogoutRequest>
1052
- rescue OryClient::ApiError => e
1053
- puts "Error when calling AdminApi->get_logout_request_with_http_info: #{e}"
1054
- end
1055
- ```
1056
-
1057
- ### Parameters
1058
-
1059
- | Name | Type | Description | Notes |
1060
- | ---- | ---- | ----------- | ----- |
1061
- | **logout_challenge** | **String** | | |
1062
-
1063
- ### Return type
1064
-
1065
- [**LogoutRequest**](LogoutRequest.md)
1066
-
1067
- ### Authorization
1068
-
1069
- No authorization required
1070
-
1071
- ### HTTP request headers
1072
-
1073
- - **Content-Type**: Not defined
1074
- - **Accept**: application/json
1075
-
1076
-
1077
- ## get_o_auth2_client
1078
-
1079
- > <OAuth2Client> get_o_auth2_client(id)
1080
-
1081
- Get an OAuth 2.0 Client
1082
-
1083
- 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.
1084
-
1085
- ### Examples
1086
-
1087
- ```ruby
1088
- require 'time'
1089
- require 'ory-client'
1090
-
1091
- api_instance = OryClient::AdminApi.new
1092
- id = 'id_example' # String | The id of the OAuth 2.0 Client.
1093
-
1094
- begin
1095
- # Get an OAuth 2.0 Client
1096
- result = api_instance.get_o_auth2_client(id)
1097
- p result
1098
- rescue OryClient::ApiError => e
1099
- puts "Error when calling AdminApi->get_o_auth2_client: #{e}"
1100
- end
1101
- ```
1102
-
1103
- #### Using the get_o_auth2_client_with_http_info variant
1104
-
1105
- This returns an Array which contains the response data, status code and headers.
1106
-
1107
- > <Array(<OAuth2Client>, Integer, Hash)> get_o_auth2_client_with_http_info(id)
1108
-
1109
- ```ruby
1110
- begin
1111
- # Get an OAuth 2.0 Client
1112
- data, status_code, headers = api_instance.get_o_auth2_client_with_http_info(id)
1113
- p status_code # => 2xx
1114
- p headers # => { ... }
1115
- p data # => <OAuth2Client>
1116
- rescue OryClient::ApiError => e
1117
- puts "Error when calling AdminApi->get_o_auth2_client_with_http_info: #{e}"
1118
- end
1119
- ```
1120
-
1121
- ### Parameters
1122
-
1123
- | Name | Type | Description | Notes |
1124
- | ---- | ---- | ----------- | ----- |
1125
- | **id** | **String** | The id of the OAuth 2.0 Client. | |
1126
-
1127
- ### Return type
1128
-
1129
- [**OAuth2Client**](OAuth2Client.md)
1130
-
1131
- ### Authorization
1132
-
1133
- No authorization required
1134
-
1135
- ### HTTP request headers
1136
-
1137
- - **Content-Type**: Not defined
1138
- - **Accept**: application/json
1139
-
1140
-
1141
- ## get_trusted_jwt_grant_issuer
1142
-
1143
- > <TrustedJwtGrantIssuer> get_trusted_jwt_grant_issuer(id)
1144
-
1145
- Get a Trusted OAuth2 JWT Bearer Grant Type Issuer
1146
-
1147
- Use this endpoint to get a trusted JWT Bearer Grant Type Issuer. The ID is the one returned when you created the trust relationship.
1148
-
1149
- ### Examples
1150
-
1151
- ```ruby
1152
- require 'time'
1153
- require 'ory-client'
1154
-
1155
- api_instance = OryClient::AdminApi.new
1156
- id = 'id_example' # String | The id of the desired grant
1157
-
1158
- begin
1159
- # Get a Trusted OAuth2 JWT Bearer Grant Type Issuer
1160
- result = api_instance.get_trusted_jwt_grant_issuer(id)
1161
- p result
1162
- rescue OryClient::ApiError => e
1163
- puts "Error when calling AdminApi->get_trusted_jwt_grant_issuer: #{e}"
1164
- end
1165
- ```
1166
-
1167
- #### Using the get_trusted_jwt_grant_issuer_with_http_info variant
1168
-
1169
- This returns an Array which contains the response data, status code and headers.
1170
-
1171
- > <Array(<TrustedJwtGrantIssuer>, Integer, Hash)> get_trusted_jwt_grant_issuer_with_http_info(id)
1172
-
1173
- ```ruby
1174
- begin
1175
- # Get a Trusted OAuth2 JWT Bearer Grant Type Issuer
1176
- data, status_code, headers = api_instance.get_trusted_jwt_grant_issuer_with_http_info(id)
1177
- p status_code # => 2xx
1178
- p headers # => { ... }
1179
- p data # => <TrustedJwtGrantIssuer>
1180
- rescue OryClient::ApiError => e
1181
- puts "Error when calling AdminApi->get_trusted_jwt_grant_issuer_with_http_info: #{e}"
1182
- end
1183
- ```
1184
-
1185
- ### Parameters
1186
-
1187
- | Name | Type | Description | Notes |
1188
- | ---- | ---- | ----------- | ----- |
1189
- | **id** | **String** | The id of the desired grant | |
1190
-
1191
- ### Return type
1192
-
1193
- [**TrustedJwtGrantIssuer**](TrustedJwtGrantIssuer.md)
1194
-
1195
- ### Authorization
1196
-
1197
- No authorization required
1198
-
1199
- ### HTTP request headers
1200
-
1201
- - **Content-Type**: Not defined
1202
- - **Accept**: application/json
1203
-
1204
-
1205
- ## introspect_o_auth2_token
1206
-
1207
- > <OAuth2TokenIntrospection> introspect_o_auth2_token(token, opts)
1208
-
1209
- Introspect OAuth2 Tokens
1210
-
1211
- 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/).
1212
-
1213
- ### Examples
1214
-
1215
- ```ruby
1216
- require 'time'
1217
- require 'ory-client'
1218
-
1219
- api_instance = OryClient::AdminApi.new
1220
- 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.
1221
- opts = {
1222
- 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.
1223
- }
1224
-
1225
- begin
1226
- # Introspect OAuth2 Tokens
1227
- result = api_instance.introspect_o_auth2_token(token, opts)
1228
- p result
1229
- rescue OryClient::ApiError => e
1230
- puts "Error when calling AdminApi->introspect_o_auth2_token: #{e}"
1231
- end
1232
- ```
1233
-
1234
- #### Using the introspect_o_auth2_token_with_http_info variant
1235
-
1236
- This returns an Array which contains the response data, status code and headers.
1237
-
1238
- > <Array(<OAuth2TokenIntrospection>, Integer, Hash)> introspect_o_auth2_token_with_http_info(token, opts)
1239
-
1240
- ```ruby
1241
- begin
1242
- # Introspect OAuth2 Tokens
1243
- data, status_code, headers = api_instance.introspect_o_auth2_token_with_http_info(token, opts)
1244
- p status_code # => 2xx
1245
- p headers # => { ... }
1246
- p data # => <OAuth2TokenIntrospection>
1247
- rescue OryClient::ApiError => e
1248
- puts "Error when calling AdminApi->introspect_o_auth2_token_with_http_info: #{e}"
1249
- end
1250
- ```
1251
-
1252
- ### Parameters
1253
-
1254
- | Name | Type | Description | Notes |
1255
- | ---- | ---- | ----------- | ----- |
1256
- | **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. | |
1257
- | **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] |
1258
-
1259
- ### Return type
1260
-
1261
- [**OAuth2TokenIntrospection**](OAuth2TokenIntrospection.md)
1262
-
1263
- ### Authorization
1264
-
1265
- No authorization required
1266
-
1267
- ### HTTP request headers
1268
-
1269
- - **Content-Type**: application/x-www-form-urlencoded
1270
- - **Accept**: application/json
1271
-
1272
-
1273
- ## list_o_auth2_clients
1274
-
1275
- > <Array<OAuth2Client>> list_o_auth2_clients(opts)
1276
-
1277
- List OAuth 2.0 Clients
1278
-
1279
- 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://hydra-url/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.
1280
-
1281
- ### Examples
1282
-
1283
- ```ruby
1284
- require 'time'
1285
- require 'ory-client'
1286
-
1287
- api_instance = OryClient::AdminApi.new
1288
- opts = {
1289
- limit: 789, # Integer | The maximum amount of clients to returned, upper bound is 500 clients.
1290
- offset: 789, # Integer | The offset from where to start looking.
1291
- client_name: 'client_name_example', # String | The name of the clients to filter by.
1292
- owner: 'owner_example' # String | The owner of the clients to filter by.
1293
- }
1294
-
1295
- begin
1296
- # List OAuth 2.0 Clients
1297
- result = api_instance.list_o_auth2_clients(opts)
1298
- p result
1299
- rescue OryClient::ApiError => e
1300
- puts "Error when calling AdminApi->list_o_auth2_clients: #{e}"
1301
- end
1302
- ```
1303
-
1304
- #### Using the list_o_auth2_clients_with_http_info variant
1305
-
1306
- This returns an Array which contains the response data, status code and headers.
1307
-
1308
- > <Array(<Array<OAuth2Client>>, Integer, Hash)> list_o_auth2_clients_with_http_info(opts)
1309
-
1310
- ```ruby
1311
- begin
1312
- # List OAuth 2.0 Clients
1313
- data, status_code, headers = api_instance.list_o_auth2_clients_with_http_info(opts)
1314
- p status_code # => 2xx
1315
- p headers # => { ... }
1316
- p data # => <Array<OAuth2Client>>
1317
- rescue OryClient::ApiError => e
1318
- puts "Error when calling AdminApi->list_o_auth2_clients_with_http_info: #{e}"
1319
- end
1320
- ```
1321
-
1322
- ### Parameters
1323
-
1324
- | Name | Type | Description | Notes |
1325
- | ---- | ---- | ----------- | ----- |
1326
- | **limit** | **Integer** | The maximum amount of clients to returned, upper bound is 500 clients. | [optional] |
1327
- | **offset** | **Integer** | The offset from where to start looking. | [optional] |
1328
- | **client_name** | **String** | The name of the clients to filter by. | [optional] |
1329
- | **owner** | **String** | The owner of the clients to filter by. | [optional] |
1330
-
1331
- ### Return type
1332
-
1333
- [**Array&lt;OAuth2Client&gt;**](OAuth2Client.md)
1334
-
1335
- ### Authorization
1336
-
1337
- No authorization required
1338
-
1339
- ### HTTP request headers
1340
-
1341
- - **Content-Type**: Not defined
1342
- - **Accept**: application/json
1343
-
1344
-
1345
- ## list_subject_consent_sessions
1346
-
1347
- > <Array<PreviousConsentSession>> list_subject_consent_sessions(subject, opts)
1348
-
1349
- Lists All Consent Sessions of a Subject
1350
-
1351
- 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.
1352
-
1353
- ### Examples
1354
-
1355
- ```ruby
1356
- require 'time'
1357
- require 'ory-client'
1358
-
1359
- api_instance = OryClient::AdminApi.new
1360
- subject = 'subject_example' # String |
1361
- opts = {
1362
- limit: 789, # Integer | The maximum amount of consent sessions to be returned, upper bound is 500 sessions.
1363
- offset: 789 # Integer | The offset from where to start looking.
1364
- }
1365
-
1366
- begin
1367
- # Lists All Consent Sessions of a Subject
1368
- result = api_instance.list_subject_consent_sessions(subject, opts)
1369
- p result
1370
- rescue OryClient::ApiError => e
1371
- puts "Error when calling AdminApi->list_subject_consent_sessions: #{e}"
1372
- end
1373
- ```
1374
-
1375
- #### Using the list_subject_consent_sessions_with_http_info variant
1376
-
1377
- This returns an Array which contains the response data, status code and headers.
1378
-
1379
- > <Array(<Array<PreviousConsentSession>>, Integer, Hash)> list_subject_consent_sessions_with_http_info(subject, opts)
1380
-
1381
- ```ruby
1382
- begin
1383
- # Lists All Consent Sessions of a Subject
1384
- data, status_code, headers = api_instance.list_subject_consent_sessions_with_http_info(subject, opts)
1385
- p status_code # => 2xx
1386
- p headers # => { ... }
1387
- p data # => <Array<PreviousConsentSession>>
1388
- rescue OryClient::ApiError => e
1389
- puts "Error when calling AdminApi->list_subject_consent_sessions_with_http_info: #{e}"
1390
- end
1391
- ```
1392
-
1393
- ### Parameters
1394
-
1395
- | Name | Type | Description | Notes |
1396
- | ---- | ---- | ----------- | ----- |
1397
- | **subject** | **String** | | |
1398
- | **limit** | **Integer** | The maximum amount of consent sessions to be returned, upper bound is 500 sessions. | [optional] |
1399
- | **offset** | **Integer** | The offset from where to start looking. | [optional] |
1400
-
1401
- ### Return type
1402
-
1403
- [**Array&lt;PreviousConsentSession&gt;**](PreviousConsentSession.md)
1404
-
1405
- ### Authorization
1406
-
1407
- No authorization required
1408
-
1409
- ### HTTP request headers
1410
-
1411
- - **Content-Type**: Not defined
1412
- - **Accept**: application/json
1413
-
1414
-
1415
- ## list_trusted_jwt_grant_issuers
1416
-
1417
- > <Array<TrustedJwtGrantIssuer>> list_trusted_jwt_grant_issuers(opts)
1418
-
1419
- List Trusted OAuth2 JWT Bearer Grant Type Issuers
1420
-
1421
- Use this endpoint to list all trusted JWT Bearer Grant Type Issuers.
1422
-
1423
- ### Examples
1424
-
1425
- ```ruby
1426
- require 'time'
1427
- require 'ory-client'
1428
-
1429
- api_instance = OryClient::AdminApi.new
1430
- opts = {
1431
- issuer: 'issuer_example', # String | If optional \"issuer\" is supplied, only jwt-bearer grants with this issuer will be returned.
1432
- limit: 789, # Integer | The maximum amount of policies returned, upper bound is 500 policies
1433
- offset: 789 # Integer | The offset from where to start looking.
1434
- }
1435
-
1436
- begin
1437
- # List Trusted OAuth2 JWT Bearer Grant Type Issuers
1438
- result = api_instance.list_trusted_jwt_grant_issuers(opts)
1439
- p result
1440
- rescue OryClient::ApiError => e
1441
- puts "Error when calling AdminApi->list_trusted_jwt_grant_issuers: #{e}"
1442
- end
1443
- ```
1444
-
1445
- #### Using the list_trusted_jwt_grant_issuers_with_http_info variant
1446
-
1447
- This returns an Array which contains the response data, status code and headers.
1448
-
1449
- > <Array(<Array<TrustedJwtGrantIssuer>>, Integer, Hash)> list_trusted_jwt_grant_issuers_with_http_info(opts)
1450
-
1451
- ```ruby
1452
- begin
1453
- # List Trusted OAuth2 JWT Bearer Grant Type Issuers
1454
- data, status_code, headers = api_instance.list_trusted_jwt_grant_issuers_with_http_info(opts)
1455
- p status_code # => 2xx
1456
- p headers # => { ... }
1457
- p data # => <Array<TrustedJwtGrantIssuer>>
1458
- rescue OryClient::ApiError => e
1459
- puts "Error when calling AdminApi->list_trusted_jwt_grant_issuers_with_http_info: #{e}"
1460
- end
1461
- ```
1462
-
1463
- ### Parameters
1464
-
1465
- | Name | Type | Description | Notes |
1466
- | ---- | ---- | ----------- | ----- |
1467
- | **issuer** | **String** | If optional \&quot;issuer\&quot; is supplied, only jwt-bearer grants with this issuer will be returned. | [optional] |
1468
- | **limit** | **Integer** | The maximum amount of policies returned, upper bound is 500 policies | [optional] |
1469
- | **offset** | **Integer** | The offset from where to start looking. | [optional] |
1470
-
1471
- ### Return type
1472
-
1473
- [**Array&lt;TrustedJwtGrantIssuer&gt;**](TrustedJwtGrantIssuer.md)
1474
-
1475
- ### Authorization
1476
-
1477
- No authorization required
1478
-
1479
- ### HTTP request headers
1480
-
1481
- - **Content-Type**: Not defined
1482
- - **Accept**: application/json
1483
-
1484
-
1485
- ## patch_o_auth2_client
1486
-
1487
- > <OAuth2Client> patch_o_auth2_client(id, patch_document)
1488
-
1489
- Patch an OAuth 2.0 Client
1490
-
1491
- 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.
1492
-
1493
- ### Examples
1494
-
1495
- ```ruby
1496
- require 'time'
1497
- require 'ory-client'
1498
-
1499
- api_instance = OryClient::AdminApi.new
1500
- id = 'id_example' # String | The id of the OAuth 2.0 Client.
1501
- patch_document = [OryClient::PatchDocument.new({op: '"replace"', path: '"/name"'})] # Array<PatchDocument> |
1502
-
1503
- begin
1504
- # Patch an OAuth 2.0 Client
1505
- result = api_instance.patch_o_auth2_client(id, patch_document)
1506
- p result
1507
- rescue OryClient::ApiError => e
1508
- puts "Error when calling AdminApi->patch_o_auth2_client: #{e}"
1509
- end
1510
- ```
1511
-
1512
- #### Using the patch_o_auth2_client_with_http_info variant
1513
-
1514
- This returns an Array which contains the response data, status code and headers.
1515
-
1516
- > <Array(<OAuth2Client>, Integer, Hash)> patch_o_auth2_client_with_http_info(id, patch_document)
1517
-
1518
- ```ruby
1519
- begin
1520
- # Patch an OAuth 2.0 Client
1521
- data, status_code, headers = api_instance.patch_o_auth2_client_with_http_info(id, patch_document)
1522
- p status_code # => 2xx
1523
- p headers # => { ... }
1524
- p data # => <OAuth2Client>
1525
- rescue OryClient::ApiError => e
1526
- puts "Error when calling AdminApi->patch_o_auth2_client_with_http_info: #{e}"
1527
- end
1528
- ```
1529
-
1530
- ### Parameters
1531
-
1532
- | Name | Type | Description | Notes |
1533
- | ---- | ---- | ----------- | ----- |
1534
- | **id** | **String** | The id of the OAuth 2.0 Client. | |
1535
- | **patch_document** | [**Array&lt;PatchDocument&gt;**](PatchDocument.md) | | |
1536
-
1537
- ### Return type
1538
-
1539
- [**OAuth2Client**](OAuth2Client.md)
1540
-
1541
- ### Authorization
1542
-
1543
- No authorization required
1544
-
1545
- ### HTTP request headers
1546
-
1547
- - **Content-Type**: application/json
1548
- - **Accept**: application/json
1549
-
1550
-
1551
- ## reject_consent_request
1552
-
1553
- > <CompletedRequest> reject_consent_request(consent_challenge, opts)
1554
-
1555
- Reject a Consent Request
1556
-
1557
- 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.
1558
-
1559
- ### Examples
1560
-
1561
- ```ruby
1562
- require 'time'
1563
- require 'ory-client'
1564
-
1565
- api_instance = OryClient::AdminApi.new
1566
- consent_challenge = 'consent_challenge_example' # String |
1567
- opts = {
1568
- reject_request: OryClient::RejectRequest.new # RejectRequest |
1569
- }
1570
-
1571
- begin
1572
- # Reject a Consent Request
1573
- result = api_instance.reject_consent_request(consent_challenge, opts)
1574
- p result
1575
- rescue OryClient::ApiError => e
1576
- puts "Error when calling AdminApi->reject_consent_request: #{e}"
1577
- end
1578
- ```
1579
-
1580
- #### Using the reject_consent_request_with_http_info variant
1581
-
1582
- This returns an Array which contains the response data, status code and headers.
1583
-
1584
- > <Array(<CompletedRequest>, Integer, Hash)> reject_consent_request_with_http_info(consent_challenge, opts)
1585
-
1586
- ```ruby
1587
- begin
1588
- # Reject a Consent Request
1589
- data, status_code, headers = api_instance.reject_consent_request_with_http_info(consent_challenge, opts)
1590
- p status_code # => 2xx
1591
- p headers # => { ... }
1592
- p data # => <CompletedRequest>
1593
- rescue OryClient::ApiError => e
1594
- puts "Error when calling AdminApi->reject_consent_request_with_http_info: #{e}"
1595
- end
1596
- ```
1597
-
1598
- ### Parameters
1599
-
1600
- | Name | Type | Description | Notes |
1601
- | ---- | ---- | ----------- | ----- |
1602
- | **consent_challenge** | **String** | | |
1603
- | **reject_request** | [**RejectRequest**](RejectRequest.md) | | [optional] |
1604
-
1605
- ### Return type
1606
-
1607
- [**CompletedRequest**](CompletedRequest.md)
1608
-
1609
- ### Authorization
1610
-
1611
- No authorization required
1612
-
1613
- ### HTTP request headers
1614
-
1615
- - **Content-Type**: application/json
1616
- - **Accept**: application/json
1617
-
1618
-
1619
- ## reject_login_request
1620
-
1621
- > <CompletedRequest> reject_login_request(login_challenge, opts)
1622
-
1623
- Reject a Login Request
1624
-
1625
- 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 be denied. The response contains a redirect URL which the login provider should redirect the user-agent to.
1626
-
1627
- ### Examples
1628
-
1629
- ```ruby
1630
- require 'time'
1631
- require 'ory-client'
1632
-
1633
- api_instance = OryClient::AdminApi.new
1634
- login_challenge = 'login_challenge_example' # String |
1635
- opts = {
1636
- reject_request: OryClient::RejectRequest.new # RejectRequest |
1637
- }
1638
-
1639
- begin
1640
- # Reject a Login Request
1641
- result = api_instance.reject_login_request(login_challenge, opts)
1642
- p result
1643
- rescue OryClient::ApiError => e
1644
- puts "Error when calling AdminApi->reject_login_request: #{e}"
1645
- end
1646
- ```
1647
-
1648
- #### Using the reject_login_request_with_http_info variant
1649
-
1650
- This returns an Array which contains the response data, status code and headers.
1651
-
1652
- > <Array(<CompletedRequest>, Integer, Hash)> reject_login_request_with_http_info(login_challenge, opts)
1653
-
1654
- ```ruby
1655
- begin
1656
- # Reject a Login Request
1657
- data, status_code, headers = api_instance.reject_login_request_with_http_info(login_challenge, opts)
1658
- p status_code # => 2xx
1659
- p headers # => { ... }
1660
- p data # => <CompletedRequest>
1661
- rescue OryClient::ApiError => e
1662
- puts "Error when calling AdminApi->reject_login_request_with_http_info: #{e}"
1663
- end
1664
- ```
1665
-
1666
- ### Parameters
1667
-
1668
- | Name | Type | Description | Notes |
1669
- | ---- | ---- | ----------- | ----- |
1670
- | **login_challenge** | **String** | | |
1671
- | **reject_request** | [**RejectRequest**](RejectRequest.md) | | [optional] |
1672
-
1673
- ### Return type
1674
-
1675
- [**CompletedRequest**](CompletedRequest.md)
1676
-
1677
- ### Authorization
1678
-
1679
- No authorization required
1680
-
1681
- ### HTTP request headers
1682
-
1683
- - **Content-Type**: application/json
1684
- - **Accept**: application/json
1685
-
1686
-
1687
- ## reject_logout_request
1688
-
1689
- > reject_logout_request(logout_challenge, opts)
1690
-
1691
- Reject a Logout Request
1692
-
1693
- 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.
1694
-
1695
- ### Examples
1696
-
1697
- ```ruby
1698
- require 'time'
1699
- require 'ory-client'
1700
-
1701
- api_instance = OryClient::AdminApi.new
1702
- logout_challenge = 'logout_challenge_example' # String |
1703
- opts = {
1704
- reject_request: OryClient::RejectRequest.new # RejectRequest |
1705
- }
1706
-
1707
- begin
1708
- # Reject a Logout Request
1709
- api_instance.reject_logout_request(logout_challenge, opts)
1710
- rescue OryClient::ApiError => e
1711
- puts "Error when calling AdminApi->reject_logout_request: #{e}"
1712
- end
1713
- ```
1714
-
1715
- #### Using the reject_logout_request_with_http_info variant
1716
-
1717
- This returns an Array which contains the response data (`nil` in this case), status code and headers.
1718
-
1719
- > <Array(nil, Integer, Hash)> reject_logout_request_with_http_info(logout_challenge, opts)
1720
-
1721
- ```ruby
1722
- begin
1723
- # Reject a Logout Request
1724
- data, status_code, headers = api_instance.reject_logout_request_with_http_info(logout_challenge, opts)
1725
- p status_code # => 2xx
1726
- p headers # => { ... }
1727
- p data # => nil
1728
- rescue OryClient::ApiError => e
1729
- puts "Error when calling AdminApi->reject_logout_request_with_http_info: #{e}"
1730
- end
1731
- ```
1732
-
1733
- ### Parameters
1734
-
1735
- | Name | Type | Description | Notes |
1736
- | ---- | ---- | ----------- | ----- |
1737
- | **logout_challenge** | **String** | | |
1738
- | **reject_request** | [**RejectRequest**](RejectRequest.md) | | [optional] |
1739
-
1740
- ### Return type
1741
-
1742
- nil (empty response body)
1743
-
1744
- ### Authorization
1745
-
1746
- No authorization required
1747
-
1748
- ### HTTP request headers
1749
-
1750
- - **Content-Type**: application/json, application/x-www-form-urlencoded
1751
- - **Accept**: application/json
1752
-
1753
-
1754
- ## revoke_authentication_session
1755
-
1756
- > revoke_authentication_session(subject)
1757
-
1758
- Invalidates All Login Sessions of a Certain User Invalidates a Subject's Authentication Session
1759
-
1760
- 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.
1761
-
1762
- ### Examples
1763
-
1764
- ```ruby
1765
- require 'time'
1766
- require 'ory-client'
1767
-
1768
- api_instance = OryClient::AdminApi.new
1769
- subject = 'subject_example' # String |
1770
-
1771
- begin
1772
- # Invalidates All Login Sessions of a Certain User Invalidates a Subject's Authentication Session
1773
- api_instance.revoke_authentication_session(subject)
1774
- rescue OryClient::ApiError => e
1775
- puts "Error when calling AdminApi->revoke_authentication_session: #{e}"
1776
- end
1777
- ```
1778
-
1779
- #### Using the revoke_authentication_session_with_http_info variant
1780
-
1781
- This returns an Array which contains the response data (`nil` in this case), status code and headers.
1782
-
1783
- > <Array(nil, Integer, Hash)> revoke_authentication_session_with_http_info(subject)
1784
-
1785
- ```ruby
1786
- begin
1787
- # Invalidates All Login Sessions of a Certain User Invalidates a Subject's Authentication Session
1788
- data, status_code, headers = api_instance.revoke_authentication_session_with_http_info(subject)
1789
- p status_code # => 2xx
1790
- p headers # => { ... }
1791
- p data # => nil
1792
- rescue OryClient::ApiError => e
1793
- puts "Error when calling AdminApi->revoke_authentication_session_with_http_info: #{e}"
1794
- end
1795
- ```
1796
-
1797
- ### Parameters
1798
-
1799
- | Name | Type | Description | Notes |
1800
- | ---- | ---- | ----------- | ----- |
1801
- | **subject** | **String** | | |
1802
-
1803
- ### Return type
1804
-
1805
- nil (empty response body)
1806
-
1807
- ### Authorization
1808
-
1809
- No authorization required
1810
-
1811
- ### HTTP request headers
1812
-
1813
- - **Content-Type**: Not defined
1814
- - **Accept**: application/json
1815
-
1816
-
1817
- ## revoke_consent_sessions
1818
-
1819
- > revoke_consent_sessions(subject, opts)
1820
-
1821
- Revokes Consent Sessions of a Subject for a Specific OAuth 2.0 Client
1822
-
1823
- 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.
1824
-
1825
- ### Examples
1826
-
1827
- ```ruby
1828
- require 'time'
1829
- require 'ory-client'
1830
-
1831
- api_instance = OryClient::AdminApi.new
1832
- subject = 'subject_example' # String | The subject (Subject) who's consent sessions should be deleted.
1833
- opts = {
1834
- 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
1835
- all: true # Boolean | If set to `?all=true`, deletes all consent sessions by the Subject that have been granted.
1836
- }
1837
-
1838
- begin
1839
- # Revokes Consent Sessions of a Subject for a Specific OAuth 2.0 Client
1840
- api_instance.revoke_consent_sessions(subject, opts)
1841
- rescue OryClient::ApiError => e
1842
- puts "Error when calling AdminApi->revoke_consent_sessions: #{e}"
1843
- end
1844
- ```
1845
-
1846
- #### Using the revoke_consent_sessions_with_http_info variant
1847
-
1848
- This returns an Array which contains the response data (`nil` in this case), status code and headers.
1849
-
1850
- > <Array(nil, Integer, Hash)> revoke_consent_sessions_with_http_info(subject, opts)
1851
-
1852
- ```ruby
1853
- begin
1854
- # Revokes Consent Sessions of a Subject for a Specific OAuth 2.0 Client
1855
- data, status_code, headers = api_instance.revoke_consent_sessions_with_http_info(subject, opts)
1856
- p status_code # => 2xx
1857
- p headers # => { ... }
1858
- p data # => nil
1859
- rescue OryClient::ApiError => e
1860
- puts "Error when calling AdminApi->revoke_consent_sessions_with_http_info: #{e}"
1861
- end
1862
- ```
1863
-
1864
- ### Parameters
1865
-
1866
- | Name | Type | Description | Notes |
1867
- | ---- | ---- | ----------- | ----- |
1868
- | **subject** | **String** | The subject (Subject) who&#39;s consent sessions should be deleted. | |
1869
- | **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] |
1870
- | **all** | **Boolean** | If set to &#x60;?all&#x3D;true&#x60;, deletes all consent sessions by the Subject that have been granted. | [optional] |
1871
-
1872
- ### Return type
1873
-
1874
- nil (empty response body)
1875
-
1876
- ### Authorization
1877
-
1878
- No authorization required
1879
-
1880
- ### HTTP request headers
1881
-
1882
- - **Content-Type**: Not defined
1883
- - **Accept**: application/json
1884
-
1885
-
1886
- ## trust_jwt_grant_issuer
1887
-
1888
- > <TrustedJwtGrantIssuer> trust_jwt_grant_issuer(opts)
1889
-
1890
- Trust an OAuth2 JWT Bearer Grant Type Issuer
1891
-
1892
- 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).
1893
-
1894
- ### Examples
1895
-
1896
- ```ruby
1897
- require 'time'
1898
- require 'ory-client'
1899
-
1900
- api_instance = OryClient::AdminApi.new
1901
- opts = {
1902
- trust_jwt_grant_issuer_body: OryClient::TrustJwtGrantIssuerBody.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"]}) # TrustJwtGrantIssuerBody |
1903
- }
1904
-
1905
- begin
1906
- # Trust an OAuth2 JWT Bearer Grant Type Issuer
1907
- result = api_instance.trust_jwt_grant_issuer(opts)
1908
- p result
1909
- rescue OryClient::ApiError => e
1910
- puts "Error when calling AdminApi->trust_jwt_grant_issuer: #{e}"
1911
- end
1912
- ```
1913
-
1914
- #### Using the trust_jwt_grant_issuer_with_http_info variant
1915
-
1916
- This returns an Array which contains the response data, status code and headers.
1917
-
1918
- > <Array(<TrustedJwtGrantIssuer>, Integer, Hash)> trust_jwt_grant_issuer_with_http_info(opts)
1919
-
1920
- ```ruby
1921
- begin
1922
- # Trust an OAuth2 JWT Bearer Grant Type Issuer
1923
- data, status_code, headers = api_instance.trust_jwt_grant_issuer_with_http_info(opts)
1924
- p status_code # => 2xx
1925
- p headers # => { ... }
1926
- p data # => <TrustedJwtGrantIssuer>
1927
- rescue OryClient::ApiError => e
1928
- puts "Error when calling AdminApi->trust_jwt_grant_issuer_with_http_info: #{e}"
1929
- end
1930
- ```
1931
-
1932
- ### Parameters
1933
-
1934
- | Name | Type | Description | Notes |
1935
- | ---- | ---- | ----------- | ----- |
1936
- | **trust_jwt_grant_issuer_body** | [**TrustJwtGrantIssuerBody**](TrustJwtGrantIssuerBody.md) | | [optional] |
1937
-
1938
- ### Return type
1939
-
1940
- [**TrustedJwtGrantIssuer**](TrustedJwtGrantIssuer.md)
1941
-
1942
- ### Authorization
1943
-
1944
- No authorization required
1945
-
1946
- ### HTTP request headers
1947
-
1948
- - **Content-Type**: application/json
1949
- - **Accept**: application/json
1950
-
1951
-
1952
- ## update_json_web_key
1953
-
1954
- > <JSONWebKey> update_json_web_key(kid, set, opts)
1955
-
1956
- Update a JSON Web Key
1957
-
1958
- 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.
1959
-
1960
- ### Examples
1961
-
1962
- ```ruby
1963
- require 'time'
1964
- require 'ory-client'
1965
-
1966
- api_instance = OryClient::AdminApi.new
1967
- kid = 'kid_example' # String | The kid of the desired key
1968
- set = 'set_example' # String | The set
1969
- opts = {
1970
- json_web_key: OryClient::JSONWebKey.new({alg: 'RS256', kid: '1603dfe0af8f4596', kty: 'RSA', use: 'sig'}) # JSONWebKey |
1971
- }
1972
-
1973
- begin
1974
- # Update a JSON Web Key
1975
- result = api_instance.update_json_web_key(kid, set, opts)
1976
- p result
1977
- rescue OryClient::ApiError => e
1978
- puts "Error when calling AdminApi->update_json_web_key: #{e}"
1979
- end
1980
- ```
1981
-
1982
- #### Using the update_json_web_key_with_http_info variant
1983
-
1984
- This returns an Array which contains the response data, status code and headers.
1985
-
1986
- > <Array(<JSONWebKey>, Integer, Hash)> update_json_web_key_with_http_info(kid, set, opts)
1987
-
1988
- ```ruby
1989
- begin
1990
- # Update a JSON Web Key
1991
- data, status_code, headers = api_instance.update_json_web_key_with_http_info(kid, set, opts)
1992
- p status_code # => 2xx
1993
- p headers # => { ... }
1994
- p data # => <JSONWebKey>
1995
- rescue OryClient::ApiError => e
1996
- puts "Error when calling AdminApi->update_json_web_key_with_http_info: #{e}"
1997
- end
1998
- ```
1999
-
2000
- ### Parameters
2001
-
2002
- | Name | Type | Description | Notes |
2003
- | ---- | ---- | ----------- | ----- |
2004
- | **kid** | **String** | The kid of the desired key | |
2005
- | **set** | **String** | The set | |
2006
- | **json_web_key** | [**JSONWebKey**](JSONWebKey.md) | | [optional] |
2007
-
2008
- ### Return type
2009
-
2010
- [**JSONWebKey**](JSONWebKey.md)
2011
-
2012
- ### Authorization
2013
-
2014
- No authorization required
2015
-
2016
- ### HTTP request headers
2017
-
2018
- - **Content-Type**: application/json
2019
- - **Accept**: application/json
2020
-
2021
-
2022
- ## update_json_web_key_set
2023
-
2024
- > <JSONWebKeySet> update_json_web_key_set(set, opts)
2025
-
2026
- Update a JSON Web Key Set
2027
-
2028
- 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.
16
+ UpdateLifespans an existing OAuth 2.0 client's token lifespan configuration. This client configuration takes precedence over the instance-wide token lifespan configuration.
2029
17
 
2030
18
  ### Examples
2031
19
 
@@ -2034,101 +22,35 @@ require 'time'
2034
22
  require 'ory-client'
2035
23
 
2036
24
  api_instance = OryClient::AdminApi.new
2037
- set = 'set_example' # String | The set
25
+ id = 'id_example' # String | The id of the OAuth 2.0 Client.
2038
26
  opts = {
2039
- json_web_key_set: OryClient::JSONWebKeySet.new # JSONWebKeySet |
27
+ update_o_auth2_client_lifespans: OryClient::UpdateOAuth2ClientLifespans.new # UpdateOAuth2ClientLifespans |
2040
28
  }
2041
29
 
2042
30
  begin
2043
- # Update a JSON Web Key Set
2044
- result = api_instance.update_json_web_key_set(set, opts)
2045
- p result
2046
- rescue OryClient::ApiError => e
2047
- puts "Error when calling AdminApi->update_json_web_key_set: #{e}"
2048
- end
2049
- ```
2050
-
2051
- #### Using the update_json_web_key_set_with_http_info variant
2052
-
2053
- This returns an Array which contains the response data, status code and headers.
2054
-
2055
- > <Array(<JSONWebKeySet>, Integer, Hash)> update_json_web_key_set_with_http_info(set, opts)
2056
-
2057
- ```ruby
2058
- begin
2059
- # Update a JSON Web Key Set
2060
- data, status_code, headers = api_instance.update_json_web_key_set_with_http_info(set, opts)
2061
- p status_code # => 2xx
2062
- p headers # => { ... }
2063
- p data # => <JSONWebKeySet>
2064
- rescue OryClient::ApiError => e
2065
- puts "Error when calling AdminApi->update_json_web_key_set_with_http_info: #{e}"
2066
- end
2067
- ```
2068
-
2069
- ### Parameters
2070
-
2071
- | Name | Type | Description | Notes |
2072
- | ---- | ---- | ----------- | ----- |
2073
- | **set** | **String** | The set | |
2074
- | **json_web_key_set** | [**JSONWebKeySet**](JSONWebKeySet.md) | | [optional] |
2075
-
2076
- ### Return type
2077
-
2078
- [**JSONWebKeySet**](JSONWebKeySet.md)
2079
-
2080
- ### Authorization
2081
-
2082
- No authorization required
2083
-
2084
- ### HTTP request headers
2085
-
2086
- - **Content-Type**: application/json
2087
- - **Accept**: application/json
2088
-
2089
-
2090
- ## update_o_auth2_client
2091
-
2092
- > <OAuth2Client> update_o_auth2_client(id, o_auth2_client)
2093
-
2094
- Update an OAuth 2.0 Client
2095
-
2096
- Update 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.
2097
-
2098
- ### Examples
2099
-
2100
- ```ruby
2101
- require 'time'
2102
- require 'ory-client'
2103
-
2104
- api_instance = OryClient::AdminApi.new
2105
- id = 'id_example' # String | The id of the OAuth 2.0 Client.
2106
- o_auth2_client = OryClient::OAuth2Client.new # OAuth2Client |
2107
-
2108
- begin
2109
- # Update an OAuth 2.0 Client
2110
- result = api_instance.update_o_auth2_client(id, o_auth2_client)
31
+
32
+ result = api_instance.update_o_auth2_client_lifespans(id, opts)
2111
33
  p result
2112
34
  rescue OryClient::ApiError => e
2113
- puts "Error when calling AdminApi->update_o_auth2_client: #{e}"
35
+ puts "Error when calling AdminApi->update_o_auth2_client_lifespans: #{e}"
2114
36
  end
2115
37
  ```
2116
38
 
2117
- #### Using the update_o_auth2_client_with_http_info variant
39
+ #### Using the update_o_auth2_client_lifespans_with_http_info variant
2118
40
 
2119
41
  This returns an Array which contains the response data, status code and headers.
2120
42
 
2121
- > <Array(<OAuth2Client>, Integer, Hash)> update_o_auth2_client_with_http_info(id, o_auth2_client)
43
+ > <Array(<OAuth2Client>, Integer, Hash)> update_o_auth2_client_lifespans_with_http_info(id, opts)
2122
44
 
2123
45
  ```ruby
2124
46
  begin
2125
- # Update an OAuth 2.0 Client
2126
- data, status_code, headers = api_instance.update_o_auth2_client_with_http_info(id, o_auth2_client)
47
+
48
+ data, status_code, headers = api_instance.update_o_auth2_client_lifespans_with_http_info(id, opts)
2127
49
  p status_code # => 2xx
2128
50
  p headers # => { ... }
2129
51
  p data # => <OAuth2Client>
2130
52
  rescue OryClient::ApiError => e
2131
- puts "Error when calling AdminApi->update_o_auth2_client_with_http_info: #{e}"
53
+ puts "Error when calling AdminApi->update_o_auth2_client_lifespans_with_http_info: #{e}"
2132
54
  end
2133
55
  ```
2134
56
 
@@ -2137,7 +59,7 @@ end
2137
59
  | Name | Type | Description | Notes |
2138
60
  | ---- | ---- | ----------- | ----- |
2139
61
  | **id** | **String** | The id of the OAuth 2.0 Client. | |
2140
- | **o_auth2_client** | [**OAuth2Client**](OAuth2Client.md) | | |
62
+ | **update_o_auth2_client_lifespans** | [**UpdateOAuth2ClientLifespans**](UpdateOAuth2ClientLifespans.md) | | [optional] |
2141
63
 
2142
64
  ### Return type
2143
65