ory-client 0.0.1.alpha133 → 0.0.1.alpha139
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/README.md +14 -5
- data/docs/ProjectMetadata.md +32 -0
- data/docs/V0alpha2Api.md +567 -0
- data/lib/ory-client/api/metadata_api.rb +1 -1
- data/lib/ory-client/api/v0alpha2_api.rb +520 -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 +1 -1
- 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_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_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/generic_error.rb +1 -1
- data/lib/ory-client/models/generic_error_content.rb +1 -1
- 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/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.rb +1 -1
- data/lib/ory-client/models/identity_schema_location.rb +1 -1
- data/lib/ory-client/models/identity_schema_preset.rb +1 -1
- data/lib/ory-client/models/identity_schema_validation_result.rb +1 -1
- data/lib/ory-client/models/identity_state.rb +1 -1
- data/lib/ory-client/models/inline_response200.rb +1 -1
- data/lib/ory-client/models/inline_response2001.rb +1 -1
- data/lib/ory-client/models/inline_response503.rb +1 -1
- 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/json_error.rb +1 -1
- data/lib/ory-client/models/json_patch.rb +1 -1
- 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 +1 -1
- data/lib/ory-client/models/normalized_project_revision_hook.rb +1 -1
- data/lib/ory-client/models/normalized_project_revision_identity_schema.rb +1 -1
- data/lib/ory-client/models/normalized_project_revision_third_party_provider.rb +1 -3
- data/lib/ory-client/models/null_plan.rb +1 -1
- data/lib/ory-client/models/pagination.rb +1 -1
- 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 +352 -0
- data/lib/ory-client/models/project_service_identity.rb +1 -1
- data/lib/ory-client/models/project_services.rb +1 -1
- data/lib/ory-client/models/project_slug.rb +1 -1
- data/lib/ory-client/models/provision_mock_subscription_payload.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/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/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 +1 -1
- 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/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 +1 -1
- 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_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 +2 -1
- data/ory-client.gemspec +1 -1
- data/spec/api/metadata_api_spec.rb +1 -1
- data/spec/api/v0alpha2_api_spec.rb +99 -1
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- 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_self_service_recovery_link_body_spec.rb +1 -1
- data/spec/models/admin_identity_import_credentials_spec.rb +1 -1
- 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/generic_error_content_spec.rb +1 -1
- data/spec/models/generic_error_spec.rb +1 -1
- data/spec/models/health_not_ready_status_spec.rb +1 -1
- data/spec/models/health_status_spec.rb +1 -1
- 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_location_spec.rb +1 -1
- data/spec/models/identity_schema_preset_spec.rb +1 -1
- data/spec/models/identity_schema_spec.rb +1 -1
- data/spec/models/identity_schema_validation_result_spec.rb +1 -1
- data/spec/models/identity_spec.rb +1 -1
- data/spec/models/identity_state_spec.rb +1 -1
- data/spec/models/inline_response2001_spec.rb +1 -1
- data/spec/models/inline_response200_spec.rb +1 -1
- data/spec/models/inline_response503_spec.rb +1 -1
- 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/json_error_spec.rb +1 -1
- data/spec/models/json_patch_spec.rb +1 -1
- 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 +1 -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/pagination_spec.rb +1 -1
- 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 +80 -0
- data/spec/models/project_service_identity_spec.rb +1 -1
- data/spec/models/project_services_spec.rb +1 -1
- data/spec/models/project_slug_spec.rb +1 -1
- data/spec/models/project_spec.rb +1 -1
- data/spec/models/provision_mock_subscription_payload_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/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/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 +1 -1
- 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/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 +1 -1
- 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_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/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.3/gem_make.out +2 -2
- data/vendor/bundle/ruby/2.5.0/extensions/x86_64-linux/2.5.0/stringio-3.0.1/gem_make.out +2 -2
- data/vendor/bundle/ruby/2.5.0/extensions/x86_64-linux/2.5.0/stringio-3.0.1/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/psych-4.0.3/ext/psych/Makefile +2 -2
- data/vendor/bundle/ruby/2.5.0/gems/stringio-3.0.1/ext/stringio/Makefile +2 -2
- metadata +7 -3
data/docs/V0alpha2Api.md
CHANGED
@@ -12,8 +12,11 @@ All URIs are relative to *https://playground.projects.oryapis.com*
|
|
12
12
|
| [**admin_list_identities**](V0alpha2Api.md#admin_list_identities) | **GET** /admin/identities | List Identities |
|
13
13
|
| [**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. |
|
14
14
|
| [**admin_update_identity**](V0alpha2Api.md#admin_update_identity) | **PUT** /admin/identities/{id} | Update an Identity |
|
15
|
+
| [**create_project**](V0alpha2Api.md#create_project) | **POST** /projects | Create a Project |
|
15
16
|
| [**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 |
|
16
17
|
| [**get_json_schema**](V0alpha2Api.md#get_json_schema) | **GET** /schemas/{id} | |
|
18
|
+
| [**get_project**](V0alpha2Api.md#get_project) | **GET** /projects/{project_id} | Get a Project |
|
19
|
+
| [**get_project_members**](V0alpha2Api.md#get_project_members) | **GET** /projects/{project_id}/members | Get all members associated with this project. |
|
17
20
|
| [**get_self_service_error**](V0alpha2Api.md#get_self_service_error) | **GET** /self-service/errors | Get Self-Service Errors |
|
18
21
|
| [**get_self_service_login_flow**](V0alpha2Api.md#get_self_service_login_flow) | **GET** /self-service/login/flows | Get Login Flow |
|
19
22
|
| [**get_self_service_recovery_flow**](V0alpha2Api.md#get_self_service_recovery_flow) | **GET** /self-service/recovery/flows | Get Recovery Flow |
|
@@ -32,7 +35,11 @@ All URIs are relative to *https://playground.projects.oryapis.com*
|
|
32
35
|
| [**initialize_self_service_verification_flow_for_browsers**](V0alpha2Api.md#initialize_self_service_verification_flow_for_browsers) | **GET** /self-service/verification/browser | Initialize Verification Flow for Browser Clients |
|
33
36
|
| [**initialize_self_service_verification_flow_without_browser**](V0alpha2Api.md#initialize_self_service_verification_flow_without_browser) | **GET** /self-service/verification/api | Initialize Verification Flow for APIs, Services, Apps, ... |
|
34
37
|
| [**list_identity_schemas**](V0alpha2Api.md#list_identity_schemas) | **GET** /schemas | |
|
38
|
+
| [**list_projects**](V0alpha2Api.md#list_projects) | **GET** /projects | List All Projects |
|
35
39
|
| [**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. |
|
40
|
+
| [**patch_project**](V0alpha2Api.md#patch_project) | **PATCH** /projects/{project_id} | Patch an Ory Cloud Project Configuration |
|
41
|
+
| [**purge_project**](V0alpha2Api.md#purge_project) | **DELETE** /projects/{project_id} | Irrecoverably Purge a Project |
|
42
|
+
| [**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`. |
|
36
43
|
| [**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. |
|
37
44
|
| [**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. |
|
38
45
|
| [**submit_self_service_login_flow**](V0alpha2Api.md#submit_self_service_login_flow) | **POST** /self-service/login | Submit a Login Flow |
|
@@ -43,6 +50,7 @@ All URIs are relative to *https://playground.projects.oryapis.com*
|
|
43
50
|
| [**submit_self_service_settings_flow**](V0alpha2Api.md#submit_self_service_settings_flow) | **POST** /self-service/settings | Complete Settings Flow |
|
44
51
|
| [**submit_self_service_verification_flow**](V0alpha2Api.md#submit_self_service_verification_flow) | **POST** /self-service/verification | Complete Verification Flow |
|
45
52
|
| [**to_session**](V0alpha2Api.md#to_session) | **GET** /sessions/whoami | Check Who the Current HTTP Session Belongs To |
|
53
|
+
| [**update_project**](V0alpha2Api.md#update_project) | **PUT** /projects/{project_id} | Update an Ory Cloud Project Configuration |
|
46
54
|
|
47
55
|
|
48
56
|
## admin_create_identity
|
@@ -619,6 +627,77 @@ end
|
|
619
627
|
- **Accept**: application/json
|
620
628
|
|
621
629
|
|
630
|
+
## create_project
|
631
|
+
|
632
|
+
> <Project> create_project(opts)
|
633
|
+
|
634
|
+
Create a Project
|
635
|
+
|
636
|
+
Creates a new project.
|
637
|
+
|
638
|
+
### Examples
|
639
|
+
|
640
|
+
```ruby
|
641
|
+
require 'time'
|
642
|
+
require 'ory-client'
|
643
|
+
# setup authorization
|
644
|
+
OryClient.configure do |config|
|
645
|
+
# Configure Bearer authorization: oryAccessToken
|
646
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
647
|
+
end
|
648
|
+
|
649
|
+
api_instance = OryClient::V0alpha2Api.new
|
650
|
+
opts = {
|
651
|
+
create_project_body: OryClient::CreateProjectBody.new({name: 'name_example'}) # CreateProjectBody |
|
652
|
+
}
|
653
|
+
|
654
|
+
begin
|
655
|
+
# Create a Project
|
656
|
+
result = api_instance.create_project(opts)
|
657
|
+
p result
|
658
|
+
rescue OryClient::ApiError => e
|
659
|
+
puts "Error when calling V0alpha2Api->create_project: #{e}"
|
660
|
+
end
|
661
|
+
```
|
662
|
+
|
663
|
+
#### Using the create_project_with_http_info variant
|
664
|
+
|
665
|
+
This returns an Array which contains the response data, status code and headers.
|
666
|
+
|
667
|
+
> <Array(<Project>, Integer, Hash)> create_project_with_http_info(opts)
|
668
|
+
|
669
|
+
```ruby
|
670
|
+
begin
|
671
|
+
# Create a Project
|
672
|
+
data, status_code, headers = api_instance.create_project_with_http_info(opts)
|
673
|
+
p status_code # => 2xx
|
674
|
+
p headers # => { ... }
|
675
|
+
p data # => <Project>
|
676
|
+
rescue OryClient::ApiError => e
|
677
|
+
puts "Error when calling V0alpha2Api->create_project_with_http_info: #{e}"
|
678
|
+
end
|
679
|
+
```
|
680
|
+
|
681
|
+
### Parameters
|
682
|
+
|
683
|
+
| Name | Type | Description | Notes |
|
684
|
+
| ---- | ---- | ----------- | ----- |
|
685
|
+
| **create_project_body** | [**CreateProjectBody**](CreateProjectBody.md) | | [optional] |
|
686
|
+
|
687
|
+
### Return type
|
688
|
+
|
689
|
+
[**Project**](Project.md)
|
690
|
+
|
691
|
+
### Authorization
|
692
|
+
|
693
|
+
[oryAccessToken](../README.md#oryAccessToken)
|
694
|
+
|
695
|
+
### HTTP request headers
|
696
|
+
|
697
|
+
- **Content-Type**: application/json
|
698
|
+
- **Accept**: application/json
|
699
|
+
|
700
|
+
|
622
701
|
## create_self_service_logout_flow_url_for_browsers
|
623
702
|
|
624
703
|
> <SelfServiceLogoutUrl> create_self_service_logout_flow_url_for_browsers(opts)
|
@@ -749,6 +828,144 @@ No authorization required
|
|
749
828
|
- **Accept**: application/json
|
750
829
|
|
751
830
|
|
831
|
+
## get_project
|
832
|
+
|
833
|
+
> <Project> get_project(project_id)
|
834
|
+
|
835
|
+
Get a Project
|
836
|
+
|
837
|
+
Get a projects you have access to by its ID.
|
838
|
+
|
839
|
+
### Examples
|
840
|
+
|
841
|
+
```ruby
|
842
|
+
require 'time'
|
843
|
+
require 'ory-client'
|
844
|
+
# setup authorization
|
845
|
+
OryClient.configure do |config|
|
846
|
+
# Configure Bearer authorization: oryAccessToken
|
847
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
848
|
+
end
|
849
|
+
|
850
|
+
api_instance = OryClient::V0alpha2Api.new
|
851
|
+
project_id = 'project_id_example' # String | Project ID The project's ID.
|
852
|
+
|
853
|
+
begin
|
854
|
+
# Get a Project
|
855
|
+
result = api_instance.get_project(project_id)
|
856
|
+
p result
|
857
|
+
rescue OryClient::ApiError => e
|
858
|
+
puts "Error when calling V0alpha2Api->get_project: #{e}"
|
859
|
+
end
|
860
|
+
```
|
861
|
+
|
862
|
+
#### Using the get_project_with_http_info variant
|
863
|
+
|
864
|
+
This returns an Array which contains the response data, status code and headers.
|
865
|
+
|
866
|
+
> <Array(<Project>, Integer, Hash)> get_project_with_http_info(project_id)
|
867
|
+
|
868
|
+
```ruby
|
869
|
+
begin
|
870
|
+
# Get a Project
|
871
|
+
data, status_code, headers = api_instance.get_project_with_http_info(project_id)
|
872
|
+
p status_code # => 2xx
|
873
|
+
p headers # => { ... }
|
874
|
+
p data # => <Project>
|
875
|
+
rescue OryClient::ApiError => e
|
876
|
+
puts "Error when calling V0alpha2Api->get_project_with_http_info: #{e}"
|
877
|
+
end
|
878
|
+
```
|
879
|
+
|
880
|
+
### Parameters
|
881
|
+
|
882
|
+
| Name | Type | Description | Notes |
|
883
|
+
| ---- | ---- | ----------- | ----- |
|
884
|
+
| **project_id** | **String** | Project ID The project's ID. | |
|
885
|
+
|
886
|
+
### Return type
|
887
|
+
|
888
|
+
[**Project**](Project.md)
|
889
|
+
|
890
|
+
### Authorization
|
891
|
+
|
892
|
+
[oryAccessToken](../README.md#oryAccessToken)
|
893
|
+
|
894
|
+
### HTTP request headers
|
895
|
+
|
896
|
+
- **Content-Type**: Not defined
|
897
|
+
- **Accept**: application/json
|
898
|
+
|
899
|
+
|
900
|
+
## get_project_members
|
901
|
+
|
902
|
+
> <Array<CloudAccount>> get_project_members(project_id)
|
903
|
+
|
904
|
+
Get all members associated with this project.
|
905
|
+
|
906
|
+
This endpoint requires the user to be a member of the project with the role `OWNER` or `DEVELOPER`.
|
907
|
+
|
908
|
+
### Examples
|
909
|
+
|
910
|
+
```ruby
|
911
|
+
require 'time'
|
912
|
+
require 'ory-client'
|
913
|
+
# setup authorization
|
914
|
+
OryClient.configure do |config|
|
915
|
+
# Configure Bearer authorization: oryAccessToken
|
916
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
917
|
+
end
|
918
|
+
|
919
|
+
api_instance = OryClient::V0alpha2Api.new
|
920
|
+
project_id = 'project_id_example' # String | Project ID The project's ID.
|
921
|
+
|
922
|
+
begin
|
923
|
+
# Get all members associated with this project.
|
924
|
+
result = api_instance.get_project_members(project_id)
|
925
|
+
p result
|
926
|
+
rescue OryClient::ApiError => e
|
927
|
+
puts "Error when calling V0alpha2Api->get_project_members: #{e}"
|
928
|
+
end
|
929
|
+
```
|
930
|
+
|
931
|
+
#### Using the get_project_members_with_http_info variant
|
932
|
+
|
933
|
+
This returns an Array which contains the response data, status code and headers.
|
934
|
+
|
935
|
+
> <Array(<Array<CloudAccount>>, Integer, Hash)> get_project_members_with_http_info(project_id)
|
936
|
+
|
937
|
+
```ruby
|
938
|
+
begin
|
939
|
+
# Get all members associated with this project.
|
940
|
+
data, status_code, headers = api_instance.get_project_members_with_http_info(project_id)
|
941
|
+
p status_code # => 2xx
|
942
|
+
p headers # => { ... }
|
943
|
+
p data # => <Array<CloudAccount>>
|
944
|
+
rescue OryClient::ApiError => e
|
945
|
+
puts "Error when calling V0alpha2Api->get_project_members_with_http_info: #{e}"
|
946
|
+
end
|
947
|
+
```
|
948
|
+
|
949
|
+
### Parameters
|
950
|
+
|
951
|
+
| Name | Type | Description | Notes |
|
952
|
+
| ---- | ---- | ----------- | ----- |
|
953
|
+
| **project_id** | **String** | Project ID The project's ID. | |
|
954
|
+
|
955
|
+
### Return type
|
956
|
+
|
957
|
+
[**Array<CloudAccount>**](CloudAccount.md)
|
958
|
+
|
959
|
+
### Authorization
|
960
|
+
|
961
|
+
[oryAccessToken](../README.md#oryAccessToken)
|
962
|
+
|
963
|
+
### HTTP request headers
|
964
|
+
|
965
|
+
- **Content-Type**: Not defined
|
966
|
+
- **Accept**: application/json
|
967
|
+
|
968
|
+
|
752
969
|
## get_self_service_error
|
753
970
|
|
754
971
|
> <SelfServiceError> get_self_service_error(id)
|
@@ -1937,6 +2154,72 @@ No authorization required
|
|
1937
2154
|
- **Accept**: application/json
|
1938
2155
|
|
1939
2156
|
|
2157
|
+
## list_projects
|
2158
|
+
|
2159
|
+
> <Array<ProjectMetadata>> list_projects
|
2160
|
+
|
2161
|
+
List All Projects
|
2162
|
+
|
2163
|
+
Lists all projects you have access to.
|
2164
|
+
|
2165
|
+
### Examples
|
2166
|
+
|
2167
|
+
```ruby
|
2168
|
+
require 'time'
|
2169
|
+
require 'ory-client'
|
2170
|
+
# setup authorization
|
2171
|
+
OryClient.configure do |config|
|
2172
|
+
# Configure Bearer authorization: oryAccessToken
|
2173
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
2174
|
+
end
|
2175
|
+
|
2176
|
+
api_instance = OryClient::V0alpha2Api.new
|
2177
|
+
|
2178
|
+
begin
|
2179
|
+
# List All Projects
|
2180
|
+
result = api_instance.list_projects
|
2181
|
+
p result
|
2182
|
+
rescue OryClient::ApiError => e
|
2183
|
+
puts "Error when calling V0alpha2Api->list_projects: #{e}"
|
2184
|
+
end
|
2185
|
+
```
|
2186
|
+
|
2187
|
+
#### Using the list_projects_with_http_info variant
|
2188
|
+
|
2189
|
+
This returns an Array which contains the response data, status code and headers.
|
2190
|
+
|
2191
|
+
> <Array(<Array<ProjectMetadata>>, Integer, Hash)> list_projects_with_http_info
|
2192
|
+
|
2193
|
+
```ruby
|
2194
|
+
begin
|
2195
|
+
# List All Projects
|
2196
|
+
data, status_code, headers = api_instance.list_projects_with_http_info
|
2197
|
+
p status_code # => 2xx
|
2198
|
+
p headers # => { ... }
|
2199
|
+
p data # => <Array<ProjectMetadata>>
|
2200
|
+
rescue OryClient::ApiError => e
|
2201
|
+
puts "Error when calling V0alpha2Api->list_projects_with_http_info: #{e}"
|
2202
|
+
end
|
2203
|
+
```
|
2204
|
+
|
2205
|
+
### Parameters
|
2206
|
+
|
2207
|
+
This endpoint does not need any parameter.
|
2208
|
+
|
2209
|
+
### Return type
|
2210
|
+
|
2211
|
+
[**Array<ProjectMetadata>**](ProjectMetadata.md)
|
2212
|
+
|
2213
|
+
### Authorization
|
2214
|
+
|
2215
|
+
[oryAccessToken](../README.md#oryAccessToken)
|
2216
|
+
|
2217
|
+
### HTTP request headers
|
2218
|
+
|
2219
|
+
- **Content-Type**: Not defined
|
2220
|
+
- **Accept**: application/json
|
2221
|
+
|
2222
|
+
|
1940
2223
|
## list_sessions
|
1941
2224
|
|
1942
2225
|
> <Array<Session>> list_sessions(opts)
|
@@ -2009,6 +2292,217 @@ No authorization required
|
|
2009
2292
|
- **Accept**: application/json
|
2010
2293
|
|
2011
2294
|
|
2295
|
+
## patch_project
|
2296
|
+
|
2297
|
+
> <SuccessfulProjectUpdate> patch_project(project_id, opts)
|
2298
|
+
|
2299
|
+
Patch an Ory Cloud Project Configuration
|
2300
|
+
|
2301
|
+
This endpoints allows you to patch individual Ory Cloud Project configuration keys for Ory's services (identity, permission, ...). The configuration format is fully compatible with the open source projects for the respective services (e.g. Ory Kratos for Identity, Ory Keto for Permissions). This endpoint expects the `version` key to be set in the payload. If it is unset, it will try to import the config as if it is from the most recent version. If you have an older version of a configuration, you should set the version key in the payload! While this endpoint is able to process all configuration items related to features (e.g. password reset), it does not support operational configuration items (e.g. port, tracing, logging) otherwise available in the open source. For configuration items that can not be translated to Ory Cloud, this endpoint will return a list of warnings to help you understand which parts of your config could not be processed.
|
2302
|
+
|
2303
|
+
### Examples
|
2304
|
+
|
2305
|
+
```ruby
|
2306
|
+
require 'time'
|
2307
|
+
require 'ory-client'
|
2308
|
+
# setup authorization
|
2309
|
+
OryClient.configure do |config|
|
2310
|
+
# Configure Bearer authorization: oryAccessToken
|
2311
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
2312
|
+
end
|
2313
|
+
|
2314
|
+
api_instance = OryClient::V0alpha2Api.new
|
2315
|
+
project_id = 'project_id_example' # String | Project ID The project's ID.
|
2316
|
+
opts = {
|
2317
|
+
json_patch: [OryClient::JsonPatch.new({op: 'add', path: '/services/identity/config/smtp/from_name'})] # Array<JsonPatch> |
|
2318
|
+
}
|
2319
|
+
|
2320
|
+
begin
|
2321
|
+
# Patch an Ory Cloud Project Configuration
|
2322
|
+
result = api_instance.patch_project(project_id, opts)
|
2323
|
+
p result
|
2324
|
+
rescue OryClient::ApiError => e
|
2325
|
+
puts "Error when calling V0alpha2Api->patch_project: #{e}"
|
2326
|
+
end
|
2327
|
+
```
|
2328
|
+
|
2329
|
+
#### Using the patch_project_with_http_info variant
|
2330
|
+
|
2331
|
+
This returns an Array which contains the response data, status code and headers.
|
2332
|
+
|
2333
|
+
> <Array(<SuccessfulProjectUpdate>, Integer, Hash)> patch_project_with_http_info(project_id, opts)
|
2334
|
+
|
2335
|
+
```ruby
|
2336
|
+
begin
|
2337
|
+
# Patch an Ory Cloud Project Configuration
|
2338
|
+
data, status_code, headers = api_instance.patch_project_with_http_info(project_id, opts)
|
2339
|
+
p status_code # => 2xx
|
2340
|
+
p headers # => { ... }
|
2341
|
+
p data # => <SuccessfulProjectUpdate>
|
2342
|
+
rescue OryClient::ApiError => e
|
2343
|
+
puts "Error when calling V0alpha2Api->patch_project_with_http_info: #{e}"
|
2344
|
+
end
|
2345
|
+
```
|
2346
|
+
|
2347
|
+
### Parameters
|
2348
|
+
|
2349
|
+
| Name | Type | Description | Notes |
|
2350
|
+
| ---- | ---- | ----------- | ----- |
|
2351
|
+
| **project_id** | **String** | Project ID The project's ID. | |
|
2352
|
+
| **json_patch** | [**Array<JsonPatch>**](JsonPatch.md) | | [optional] |
|
2353
|
+
|
2354
|
+
### Return type
|
2355
|
+
|
2356
|
+
[**SuccessfulProjectUpdate**](SuccessfulProjectUpdate.md)
|
2357
|
+
|
2358
|
+
### Authorization
|
2359
|
+
|
2360
|
+
[oryAccessToken](../README.md#oryAccessToken)
|
2361
|
+
|
2362
|
+
### HTTP request headers
|
2363
|
+
|
2364
|
+
- **Content-Type**: application/json
|
2365
|
+
- **Accept**: application/json
|
2366
|
+
|
2367
|
+
|
2368
|
+
## purge_project
|
2369
|
+
|
2370
|
+
> purge_project(project_id)
|
2371
|
+
|
2372
|
+
Irrecoverably Purge a Project
|
2373
|
+
|
2374
|
+
!! Use with extreme caution !! Using this API endpoint you can purge (completely delete) a project and its data. This action can not be undone and will delete ALL your data. !! Use with extreme caution !!
|
2375
|
+
|
2376
|
+
### Examples
|
2377
|
+
|
2378
|
+
```ruby
|
2379
|
+
require 'time'
|
2380
|
+
require 'ory-client'
|
2381
|
+
# setup authorization
|
2382
|
+
OryClient.configure do |config|
|
2383
|
+
# Configure Bearer authorization: oryAccessToken
|
2384
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
2385
|
+
end
|
2386
|
+
|
2387
|
+
api_instance = OryClient::V0alpha2Api.new
|
2388
|
+
project_id = 'project_id_example' # String | Project ID The project's ID.
|
2389
|
+
|
2390
|
+
begin
|
2391
|
+
# Irrecoverably Purge a Project
|
2392
|
+
api_instance.purge_project(project_id)
|
2393
|
+
rescue OryClient::ApiError => e
|
2394
|
+
puts "Error when calling V0alpha2Api->purge_project: #{e}"
|
2395
|
+
end
|
2396
|
+
```
|
2397
|
+
|
2398
|
+
#### Using the purge_project_with_http_info variant
|
2399
|
+
|
2400
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
2401
|
+
|
2402
|
+
> <Array(nil, Integer, Hash)> purge_project_with_http_info(project_id)
|
2403
|
+
|
2404
|
+
```ruby
|
2405
|
+
begin
|
2406
|
+
# Irrecoverably Purge a Project
|
2407
|
+
data, status_code, headers = api_instance.purge_project_with_http_info(project_id)
|
2408
|
+
p status_code # => 2xx
|
2409
|
+
p headers # => { ... }
|
2410
|
+
p data # => nil
|
2411
|
+
rescue OryClient::ApiError => e
|
2412
|
+
puts "Error when calling V0alpha2Api->purge_project_with_http_info: #{e}"
|
2413
|
+
end
|
2414
|
+
```
|
2415
|
+
|
2416
|
+
### Parameters
|
2417
|
+
|
2418
|
+
| Name | Type | Description | Notes |
|
2419
|
+
| ---- | ---- | ----------- | ----- |
|
2420
|
+
| **project_id** | **String** | Project ID The project's ID. | |
|
2421
|
+
|
2422
|
+
### Return type
|
2423
|
+
|
2424
|
+
nil (empty response body)
|
2425
|
+
|
2426
|
+
### Authorization
|
2427
|
+
|
2428
|
+
[oryAccessToken](../README.md#oryAccessToken)
|
2429
|
+
|
2430
|
+
### HTTP request headers
|
2431
|
+
|
2432
|
+
- **Content-Type**: Not defined
|
2433
|
+
- **Accept**: application/json
|
2434
|
+
|
2435
|
+
|
2436
|
+
## remove_project_member
|
2437
|
+
|
2438
|
+
> remove_project_member(project_id, member_id)
|
2439
|
+
|
2440
|
+
Remove a member associated with this project. This also sets their invite status to `REMOVED`.
|
2441
|
+
|
2442
|
+
This endpoint requires the user to be a member of the project with the role `OWNER`.
|
2443
|
+
|
2444
|
+
### Examples
|
2445
|
+
|
2446
|
+
```ruby
|
2447
|
+
require 'time'
|
2448
|
+
require 'ory-client'
|
2449
|
+
# setup authorization
|
2450
|
+
OryClient.configure do |config|
|
2451
|
+
# Configure Bearer authorization: oryAccessToken
|
2452
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
2453
|
+
end
|
2454
|
+
|
2455
|
+
api_instance = OryClient::V0alpha2Api.new
|
2456
|
+
project_id = 'project_id_example' # String | Project ID The project's ID.
|
2457
|
+
member_id = 'member_id_example' # String | Member ID
|
2458
|
+
|
2459
|
+
begin
|
2460
|
+
# Remove a member associated with this project. This also sets their invite status to `REMOVED`.
|
2461
|
+
api_instance.remove_project_member(project_id, member_id)
|
2462
|
+
rescue OryClient::ApiError => e
|
2463
|
+
puts "Error when calling V0alpha2Api->remove_project_member: #{e}"
|
2464
|
+
end
|
2465
|
+
```
|
2466
|
+
|
2467
|
+
#### Using the remove_project_member_with_http_info variant
|
2468
|
+
|
2469
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
2470
|
+
|
2471
|
+
> <Array(nil, Integer, Hash)> remove_project_member_with_http_info(project_id, member_id)
|
2472
|
+
|
2473
|
+
```ruby
|
2474
|
+
begin
|
2475
|
+
# Remove a member associated with this project. This also sets their invite status to `REMOVED`.
|
2476
|
+
data, status_code, headers = api_instance.remove_project_member_with_http_info(project_id, member_id)
|
2477
|
+
p status_code # => 2xx
|
2478
|
+
p headers # => { ... }
|
2479
|
+
p data # => nil
|
2480
|
+
rescue OryClient::ApiError => e
|
2481
|
+
puts "Error when calling V0alpha2Api->remove_project_member_with_http_info: #{e}"
|
2482
|
+
end
|
2483
|
+
```
|
2484
|
+
|
2485
|
+
### Parameters
|
2486
|
+
|
2487
|
+
| Name | Type | Description | Notes |
|
2488
|
+
| ---- | ---- | ----------- | ----- |
|
2489
|
+
| **project_id** | **String** | Project ID The project's ID. | |
|
2490
|
+
| **member_id** | **String** | Member ID | |
|
2491
|
+
|
2492
|
+
### Return type
|
2493
|
+
|
2494
|
+
nil (empty response body)
|
2495
|
+
|
2496
|
+
### Authorization
|
2497
|
+
|
2498
|
+
[oryAccessToken](../README.md#oryAccessToken)
|
2499
|
+
|
2500
|
+
### HTTP request headers
|
2501
|
+
|
2502
|
+
- **Content-Type**: Not defined
|
2503
|
+
- **Accept**: application/json
|
2504
|
+
|
2505
|
+
|
2012
2506
|
## revoke_session
|
2013
2507
|
|
2014
2508
|
> revoke_session(id)
|
@@ -2685,3 +3179,76 @@ No authorization required
|
|
2685
3179
|
- **Content-Type**: Not defined
|
2686
3180
|
- **Accept**: application/json
|
2687
3181
|
|
3182
|
+
|
3183
|
+
## update_project
|
3184
|
+
|
3185
|
+
> <SuccessfulProjectUpdate> update_project(project_id, opts)
|
3186
|
+
|
3187
|
+
Update an Ory Cloud Project Configuration
|
3188
|
+
|
3189
|
+
This endpoints allows you to update the Ory Cloud Project configuration for individual services (identity, permission, ...). The configuration is fully compatible with the open source projects for the respective services (e.g. Ory Kratos for Identity, Ory Keto for Permissions). This endpoint expects the `version` key to be set in the payload. If it is unset, it will try to import the config as if it is from the most recent version. If you have an older version of a configuration, you should set the version key in the payload! While this endpoint is able to process all configuration items related to features (e.g. password reset), it does not support operational configuration items (e.g. port, tracing, logging) otherwise available in the open source. For configuration items that can not be translated to Ory Cloud, this endpoint will return a list of warnings to help you understand which parts of your config could not be processed. Be aware that updating any service's configuration will completely override your current configuration for that service!
|
3190
|
+
|
3191
|
+
### Examples
|
3192
|
+
|
3193
|
+
```ruby
|
3194
|
+
require 'time'
|
3195
|
+
require 'ory-client'
|
3196
|
+
# setup authorization
|
3197
|
+
OryClient.configure do |config|
|
3198
|
+
# Configure Bearer authorization: oryAccessToken
|
3199
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
3200
|
+
end
|
3201
|
+
|
3202
|
+
api_instance = OryClient::V0alpha2Api.new
|
3203
|
+
project_id = 'project_id_example' # String | Project ID The project's ID.
|
3204
|
+
opts = {
|
3205
|
+
update_project: OryClient::UpdateProject.new({name: 'name_example', services: OryClient::ProjectServices.new({identity: OryClient::ProjectServiceIdentity.new({config: 3.56})})}) # UpdateProject |
|
3206
|
+
}
|
3207
|
+
|
3208
|
+
begin
|
3209
|
+
# Update an Ory Cloud Project Configuration
|
3210
|
+
result = api_instance.update_project(project_id, opts)
|
3211
|
+
p result
|
3212
|
+
rescue OryClient::ApiError => e
|
3213
|
+
puts "Error when calling V0alpha2Api->update_project: #{e}"
|
3214
|
+
end
|
3215
|
+
```
|
3216
|
+
|
3217
|
+
#### Using the update_project_with_http_info variant
|
3218
|
+
|
3219
|
+
This returns an Array which contains the response data, status code and headers.
|
3220
|
+
|
3221
|
+
> <Array(<SuccessfulProjectUpdate>, Integer, Hash)> update_project_with_http_info(project_id, opts)
|
3222
|
+
|
3223
|
+
```ruby
|
3224
|
+
begin
|
3225
|
+
# Update an Ory Cloud Project Configuration
|
3226
|
+
data, status_code, headers = api_instance.update_project_with_http_info(project_id, opts)
|
3227
|
+
p status_code # => 2xx
|
3228
|
+
p headers # => { ... }
|
3229
|
+
p data # => <SuccessfulProjectUpdate>
|
3230
|
+
rescue OryClient::ApiError => e
|
3231
|
+
puts "Error when calling V0alpha2Api->update_project_with_http_info: #{e}"
|
3232
|
+
end
|
3233
|
+
```
|
3234
|
+
|
3235
|
+
### Parameters
|
3236
|
+
|
3237
|
+
| Name | Type | Description | Notes |
|
3238
|
+
| ---- | ---- | ----------- | ----- |
|
3239
|
+
| **project_id** | **String** | Project ID The project's ID. | |
|
3240
|
+
| **update_project** | [**UpdateProject**](UpdateProject.md) | | [optional] |
|
3241
|
+
|
3242
|
+
### Return type
|
3243
|
+
|
3244
|
+
[**SuccessfulProjectUpdate**](SuccessfulProjectUpdate.md)
|
3245
|
+
|
3246
|
+
### Authorization
|
3247
|
+
|
3248
|
+
[oryAccessToken](../README.md#oryAccessToken)
|
3249
|
+
|
3250
|
+
### HTTP request headers
|
3251
|
+
|
3252
|
+
- **Content-Type**: application/json
|
3253
|
+
- **Accept**: application/json
|
3254
|
+
|
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#Documentation for all public and administrative Ory APIs. Administrative APIs can only be accessed with a valid Personal Access Token. Public APIs are mostly used in browsers.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: v0.0.1-alpha.
|
6
|
+
The version of the OpenAPI document: v0.0.1-alpha.139
|
7
7
|
Contact: support@ory.sh
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 5.4.0
|