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