Packages
ory_client
1.16.10
1.22.63
1.22.62
1.22.61
1.22.60
1.22.59
1.22.58
1.22.57
1.22.56
1.22.55
1.22.54
1.22.53
1.22.52
1.22.51
1.22.50
1.22.49
1.22.48
1.22.47
1.22.46
1.22.45
1.22.44
1.22.43
1.22.42
1.22.41
1.22.40
1.22.39
1.22.38
1.22.37
1.22.36
1.22.35
1.22.34
1.22.33
1.22.32
1.22.28
1.22.27
1.22.26
1.22.25
1.22.24
1.22.23
1.22.22
1.22.21
1.22.16
1.22.15
1.22.14
1.22.13
1.22.12
1.22.11
1.22.10
1.22.9
1.22.8
1.22.7
1.22.6
1.22.5
1.22.4
1.22.3
1.22.2
1.22.1
1.22.0
1.21.6
1.21.5
1.21.4
1.21.3
1.21.2
1.21.1
1.21.0
1.20.23
1.20.22
1.20.11
1.20.10
1.20.9
1.20.8
1.20.7
1.20.6
1.20.5
1.20.4
1.20.3
1.20.2
1.20.1
1.20.0
1.19.0
1.18.5
1.18.4
1.17.2
1.17.1
1.16.10
1.6.2
1.6.1
1.5.2
1.5.1
1.5.0
1.4.9
1.4.8
1.4.7
1.4.6
1.4.5
1.4.4
1.4.3
1.4.2
1.4.1
1.4.0
1.3.0
1.2.17
1.2.16
1.2.15
1.2.14
1.2.11
1.2.10
1.2.9
1.2.8
1.2.7
1.2.6
1.2.5
1.2.4
1.2.3
1.2.2
1.2.1
1.2.0
1.1.51
1.1.50
1.1.49
1.1.48
1.1.47
1.1.46
1.1.45
1.1.44
1.1.41
1.1.40
1.1.39
1.1.39-alpha.0
1.1.38
1.1.37
1.1.36
1.1.35
1.1.34
1.1.33
1.1.32
1.1.31
1.1.30
1.1.29
1.1.28
1.1.27
1.1.26
1.1.25
1.1.24
1.1.23
1.1.22
1.1.21
1.1.20
1.1.19
1.1.18
1.1.17
1.1.7
1.1.5
1.1.4
1.1.3
1.1.2
1.1.1
1.1.0
1.0.2
1.0.1
1.0.0
1.0.0-alpha.0
0.2.0-alpha.60
0.2.0-alpha.48
0.2.0-alpha.47
0.2.0-alpha.46
0.2.0-alpha.45
0.2.0-alpha.44
0.2.0-alpha.43
0.2.0-alpha.42
0.2.0-alpha.41
0.2.0-alpha.40
0.2.0-alpha.39
0.2.0-alpha.38
0.2.0-alpha.37
0.2.0-alpha.36
0.2.0-alpha.35
0.2.0-alpha.34
0.2.0-alpha.33
0.2.0-alpha.32
0.2.0-alpha.31
0.2.0-alpha.30
0.2.0-alpha.29
0.2.0-alpha.28
0.2.0-alpha.27
0.2.0-alpha.26
0.2.0-alpha.25
0.2.0-alpha.24
0.2.0-alpha.23
0.2.0-alpha.22
0.2.0-alpha.21
0.2.0-alpha.20
0.2.0-alpha.19
0.2.0-alpha.18
0.2.0-alpha.16
0.2.0-alpha.15
0.2.0-alpha.14
0.2.0-alpha.4
0.2.0-alpha.2
0.1.0-alpha.12
0.1.0-alpha.11
0.1.0-alpha.10
0.1.0-alpha.9
0.1.0-alpha.8
0.1.0-alpha.7
0.1.0-alpha.6
0.1.0-alpha.5
0.1.0-alpha.4
0.1.0-alpha.3
0.1.0-alpha.2
0.1.0-alpha.1
0.0.1-alpha.189
0.0.1-alpha.188
0.0.1-alpha.187
OpenAPI API client for Ory Network, Ory's web-scale API for identity and access control.
Current section
213 Versions
Jump to
Current section
213 Versions
Compare versions
302
files changed
+2616
additions
-774
deletions
| @@ -1,6 +1,6 @@ | |
| 1 1 | # Ory |
| 2 2 | |
| 3 | - 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. |
| 3 | + # Introduction 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. ## SDKs This document describes the APIs available in the Ory Network. The APIs are available as SDKs for the following languages: | Language | Download SDK | Documentation | | -------------- | ---------------------------------------------------------------- | ------------------------------------------------------------------------------------ | | Dart | [pub.dev](https://pub.dev/packages/ory_client) | [README](https://github.com/ory/sdk/blob/master/clients/client/dart/README.md) | | .NET | [nuget.org](https://www.nuget.org/packages/Ory.Client/) | [README](https://github.com/ory/sdk/blob/master/clients/client/dotnet/README.md) | | Elixir | [hex.pm](https://hex.pm/packages/ory_client) | [README](https://github.com/ory/sdk/blob/master/clients/client/elixir/README.md) | | Go | [github.com](https://github.com/ory/client-go) | [README](https://github.com/ory/sdk/blob/master/clients/client/go/README.md) | | Java | [maven.org](https://search.maven.org/artifact/sh.ory/ory-client) | [README](https://github.com/ory/sdk/blob/master/clients/client/java/README.md) | | JavaScript | [npmjs.com](https://www.npmjs.com/package/@ory/client) | [README](https://github.com/ory/sdk/blob/master/clients/client/typescript/README.md) | | JavaScript (With fetch) | [npmjs.com](https://www.npmjs.com/package/@ory/client-fetch) | [README](https://github.com/ory/sdk/blob/master/clients/client/typescript-fetch/README.md) | | PHP | [packagist.org](https://packagist.org/packages/ory/client) | [README](https://github.com/ory/sdk/blob/master/clients/client/php/README.md) | | Python | [pypi.org](https://pypi.org/project/ory-client/) | [README](https://github.com/ory/sdk/blob/master/clients/client/python/README.md) | | Ruby | [rubygems.org](https://rubygems.org/gems/ory-client) | [README](https://github.com/ory/sdk/blob/master/clients/client/ruby/README.md) | | Rust | [crates.io](https://crates.io/crates/ory-client) | [README](https://github.com/ory/sdk/blob/master/clients/client/rust/README.md) | |
| 4 4 | |
| 5 5 | ## Building |
| 6 6 | |
| @@ -18,7 +18,7 @@ your list of dependencies in `mix.exs`: | |
| 18 18 | |
| 19 19 | ```elixir |
| 20 20 | def deps do |
| 21 | - [{:ory_client, "~> v1.6.2"}] |
| 21 | + [{:ory_client, "~> v1.16.10"}] |
| 22 22 | end |
| 23 23 | ``` |
| @@ -1,7 +1,7 @@ | |
| 1 1 | {<<"app">>,<<"ory_client">>}. |
| 2 2 | {<<"build_tools">>,[<<"mix">>]}. |
| 3 3 | {<<"description">>, |
| 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.">>}. |
| 4 | + <<"OpenAPI API client for Ory Network, Ory's web-scale API for identity and access control.">>}. |
| 5 5 | {<<"elixir">>,<<"~> 1.10">>}. |
| 6 6 | {<<"files">>, |
| 7 7 | [<<".formatter.exs">>,<<"config">>,<<"config/config.exs">>, |
| @@ -9,18 +9,27 @@ | |
| 9 9 | <<"lib/ory/model/accept_o_auth2_consent_request.ex">>, |
| 10 10 | <<"lib/ory/model/accept_o_auth2_consent_request_session.ex">>, |
| 11 11 | <<"lib/ory/model/accept_o_auth2_login_request.ex">>, |
| 12 | + <<"lib/ory/model/account_experience_colors.ex">>, |
| 13 | + <<"lib/ory/model/account_experience_configuration.ex">>, |
| 14 | + <<"lib/ory/model/account_experience_theme_variables.ex">>, |
| 12 15 | <<"lib/ory/model/active_project_in_console.ex">>, |
| 16 | + <<"lib/ory/model/add_project_to_workspace_body.ex">>, |
| 13 17 | <<"lib/ory/model/attribute.ex">>,<<"lib/ory/model/attribute_filter.ex">>, |
| 14 18 | <<"lib/ory/model/attributes_count_datapoint.ex">>, |
| 15 19 | <<"lib/ory/model/authenticator_assurance_level.ex">>, |
| 20 | + <<"lib/ory/model/batch_check_permission_body.ex">>, |
| 21 | + <<"lib/ory/model/batch_check_permission_result.ex">>, |
| 16 22 | <<"lib/ory/model/batch_patch_identities_response.ex">>, |
| 23 | + <<"lib/ory/model/billing_period_bucket.ex">>, |
| 17 24 | <<"lib/ory/model/check_opl_syntax_result.ex">>, |
| 18 25 | <<"lib/ory/model/check_permission_result.ex">>, |
| 26 | + <<"lib/ory/model/check_permission_result_with_error.ex">>, |
| 19 27 | <<"lib/ory/model/cloud_account.ex">>, |
| 20 28 | <<"lib/ory/model/consistency_request_parameters.ex">>, |
| 21 29 | <<"lib/ory/model/continue_with.ex">>, |
| 22 30 | <<"lib/ory/model/continue_with_recovery_ui.ex">>, |
| 23 31 | <<"lib/ory/model/continue_with_recovery_ui_flow.ex">>, |
| 32 | + <<"lib/ory/model/continue_with_redirect_browser_to.ex">>, |
| 24 33 | <<"lib/ory/model/continue_with_set_ory_session_token.ex">>, |
| 25 34 | <<"lib/ory/model/continue_with_settings_ui.ex">>, |
| 26 35 | <<"lib/ory/model/continue_with_settings_ui_flow.ex">>, |
| @@ -30,6 +39,7 @@ | |
| 30 39 | <<"lib/ory/model/courier_message_type.ex">>, |
| 31 40 | <<"lib/ory/model/create_custom_domain_body.ex">>, |
| 32 41 | <<"lib/ory/model/create_event_stream_body.ex">>, |
| 42 | + <<"lib/ory/model/create_fedcm_flow_response.ex">>, |
| 33 43 | <<"lib/ory/model/create_identity_body.ex">>, |
| 34 44 | <<"lib/ory/model/create_invite_response.ex">>, |
| 35 45 | <<"lib/ory/model/create_json_web_key_set.ex">>, |
| @@ -44,8 +54,9 @@ | |
| 44 54 | <<"lib/ory/model/create_subscription_body.ex">>, |
| 45 55 | <<"lib/ory/model/create_subscription_common.ex">>, |
| 46 56 | <<"lib/ory/model/create_verifiable_credential_request_body.ex">>, |
| 57 | + <<"lib/ory/model/create_workspace_api_key_body.ex">>, |
| 58 | + <<"lib/ory/model/create_workspace_body.ex">>, |
| 47 59 | <<"lib/ory/model/create_workspace_member_invite_body.ex">>, |
| 48 | - <<"lib/ory/model/create_workspace_payload.ex">>, |
| 49 60 | <<"lib/ory/model/create_workspace_subscription_body.ex">>, |
| 50 61 | <<"lib/ory/model/credential_supported_draft00.ex">>, |
| 51 62 | <<"lib/ory/model/custom_domain.ex">>, |
| @@ -75,6 +86,7 @@ | |
| 75 86 | <<"lib/ory/model/health_status.ex">>,<<"lib/ory/model/identity.ex">>, |
| 76 87 | <<"lib/ory/model/identity_credentials.ex">>, |
| 77 88 | <<"lib/ory/model/identity_credentials_code.ex">>, |
| 89 | + <<"lib/ory/model/identity_credentials_code_address.ex">>, |
| 78 90 | <<"lib/ory/model/identity_credentials_oidc.ex">>, |
| 79 91 | <<"lib/ory/model/identity_credentials_oidc_provider.ex">>, |
| 80 92 | <<"lib/ory/model/identity_credentials_password.ex">>, |
| @@ -91,33 +103,33 @@ | |
| 91 103 | <<"lib/ory/model/internal_get_project_branding_body.ex">>, |
| 92 104 | <<"lib/ory/model/internal_is_ax_welcome_screen_enabled_for_project_body.ex">>, |
| 93 105 | <<"lib/ory/model/internal_is_owner_for_project_by_slug_body.ex">>, |
| 94 | - <<"lib/ory/model/is_ready_200_response.ex">>, |
| 95 106 | <<"lib/ory/model/internal_is_owner_for_project_by_slug_response.ex">>, |
| 96 | - <<"lib/ory/model/internal_provision_mock_subscription.ex">>, |
| 97 107 | <<"lib/ory/model/introspected_o_auth2_token.ex">>, |
| 108 | + <<"lib/ory/model/invite_token_body.ex">>,<<"lib/ory/model/invoice.ex">>, |
| 109 | + <<"lib/ory/model/invoice_data_v1.ex">>, |
| 98 110 | <<"lib/ory/model/is_owner_for_project_by_slug.ex">>, |
| 99 | - <<"lib/ory/model/is_ready_503_response.ex">>, |
| 100 111 | <<"lib/ory/model/json_patch.ex">>,<<"lib/ory/model/json_web_key.ex">>, |
| 101 112 | <<"lib/ory/model/json_web_key_set.ex">>, |
| 102 | - <<"lib/ory/model/keto_namespace.ex">>, |
| 113 | + <<"lib/ory/model/keto_namespace.ex">>,<<"lib/ory/model/line_item_v1.ex">>, |
| 103 114 | <<"lib/ory/model/list_event_streams.ex">>, |
| 104 | - <<"lib/ory/model/list_my_workspaces_response.ex">>, |
| 115 | + <<"lib/ory/model/list_invoices_response.ex">>, |
| 105 116 | <<"lib/ory/model/list_organizations_response.ex">>, |
| 106 | - <<"lib/ory/model/list_workspace_projects_response.ex">>, |
| 107 | - <<"lib/ory/model/login_flow.ex">>,<<"lib/ory/model/login_flow_state.ex">>, |
| 108 | - <<"lib/ory/model/logout_flow.ex">>, |
| 117 | + <<"lib/ory/model/list_workspace_projects.ex">>, |
| 118 | + <<"lib/ory/model/list_workspaces.ex">>,<<"lib/ory/model/login_flow.ex">>, |
| 119 | + <<"lib/ory/model/login_flow_state.ex">>,<<"lib/ory/model/logout_flow.ex">>, |
| 109 120 | <<"lib/ory/model/managed_identity_schema.ex">>, |
| 110 121 | <<"lib/ory/model/managed_identity_schema_validation_result.ex">>, |
| 111 122 | <<"lib/ory/model/member_invite.ex">>,<<"lib/ory/model/message.ex">>, |
| 112 123 | <<"lib/ory/model/message_dispatch.ex">>, |
| 113 | - <<"lib/ory/model/metrics_datapoint.ex">>, |
| 114 | - <<"lib/ory/model/migration_options.ex">>,<<"lib/ory/model/namespace.ex">>, |
| 124 | + <<"lib/ory/model/metrics_datapoint.ex">>,<<"lib/ory/model/money.ex">>, |
| 125 | + <<"lib/ory/model/namespace.ex">>, |
| 115 126 | <<"lib/ory/model/needs_privileged_session_error.ex">>, |
| 116 127 | <<"lib/ory/model/normalized_project.ex">>, |
| 117 128 | <<"lib/ory/model/normalized_project_revision.ex">>, |
| 118 129 | <<"lib/ory/model/normalized_project_revision_courier_channel.ex">>, |
| 119 130 | <<"lib/ory/model/normalized_project_revision_hook.ex">>, |
| 120 131 | <<"lib/ory/model/normalized_project_revision_identity_schema.ex">>, |
| 132 | + <<"lib/ory/model/normalized_project_revision_saml_provider.ex">>, |
| 121 133 | <<"lib/ory/model/normalized_project_revision_third_party_provider.ex">>, |
| 122 134 | <<"lib/ory/model/normalized_project_revision_tokenizer_template.ex">>, |
| 123 135 | <<"lib/ory/model/o_auth2_client.ex">>, |
| @@ -137,7 +149,8 @@ | |
| 137 149 | <<"lib/ory/model/parse_error.ex">>, |
| 138 150 | <<"lib/ory/model/patch_identities_body.ex">>, |
| 139 151 | <<"lib/ory/model/perform_native_logout_body.ex">>, |
| 140 | - <<"lib/ory/model/plan.ex">>,<<"lib/ory/model/plan_details.ex">>, |
| 152 | + <<"lib/ory/model/permissions_on_workspace.ex">>,<<"lib/ory/model/plan.ex">>, |
| 153 | + <<"lib/ory/model/plan_details.ex">>, |
| 141 154 | <<"lib/ory/model/post_check_permission_body.ex">>, |
| 142 155 | <<"lib/ory/model/post_check_permission_or_error_body.ex">>, |
| 143 156 | <<"lib/ory/model/project.ex">>,<<"lib/ory/model/project_api_key.ex">>, |
| @@ -146,11 +159,13 @@ | |
| 146 159 | <<"lib/ory/model/project_branding_theme.ex">>, |
| 147 160 | <<"lib/ory/model/project_cors.ex">>, |
| 148 161 | <<"lib/ory/model/project_events_datapoint.ex">>, |
| 149 | - <<"lib/ory/model/project_host.ex">>,<<"lib/ory/model/project_metadata.ex">>, |
| 162 | + <<"lib/ory/model/project_host.ex">>,<<"lib/ory/model/project_member.ex">>, |
| 163 | + <<"lib/ory/model/project_metadata.ex">>, |
| 150 164 | <<"lib/ory/model/project_service_identity.ex">>, |
| 151 165 | <<"lib/ory/model/project_service_o_auth2.ex">>, |
| 152 166 | <<"lib/ory/model/project_service_permission.ex">>, |
| 153 | - <<"lib/ory/model/project_services.ex">>,<<"lib/ory/model/quota_usage.ex">>, |
| 167 | + <<"lib/ory/model/project_services.ex">>,<<"lib/ory/model/provider.ex">>, |
| 168 | + <<"lib/ory/model/quota_usage.ex">>, |
| 154 169 | <<"lib/ory/model/recovery_code_for_identity.ex">>, |
| 155 170 | <<"lib/ory/model/recovery_flow.ex">>, |
| 156 171 | <<"lib/ory/model/recovery_flow_state.ex">>, |
| @@ -180,10 +195,11 @@ | |
| 180 195 | <<"lib/ory/model/source_position.ex">>,<<"lib/ory/model/subject_set.ex">>, |
| 181 196 | <<"lib/ory/model/subscription.ex">>, |
| 182 197 | <<"lib/ory/model/successful_code_exchange_response.ex">>, |
| 183 | - <<"lib/ory/model/token_pagination.ex">>, |
| 184 198 | <<"lib/ory/model/successful_native_login.ex">>, |
| 185 199 | <<"lib/ory/model/successful_native_registration.ex">>, |
| 186 200 | <<"lib/ory/model/successful_project_update.ex">>, |
| 201 | + <<"lib/ory/model/tax_line_item.ex">>,<<"lib/ory/model/time_interval.ex">>, |
| 202 | + <<"lib/ory/model/token_pagination.ex">>, |
| 187 203 | <<"lib/ory/model/token_pagination_headers.ex">>, |
| 188 204 | <<"lib/ory/model/token_pagination_request_parameters.ex">>, |
| 189 205 | <<"lib/ory/model/token_pagination_response_headers.ex">>, |
| @@ -198,11 +214,15 @@ | |
| 198 214 | <<"lib/ory/model/ui_node_meta.ex">>, |
| 199 215 | <<"lib/ory/model/ui_node_script_attributes.ex">>, |
| 200 216 | <<"lib/ory/model/ui_node_text_attributes.ex">>, |
| 201 | - <<"lib/ory/model/ui_text.ex">>,<<"lib/ory/model/update_identity_body.ex">>, |
| 217 | + <<"lib/ory/model/ui_text.ex">>, |
| 218 | + <<"lib/ory/model/update_fedcm_flow_body.ex">>, |
| 219 | + <<"lib/ory/model/update_identity_body.ex">>, |
| 202 220 | <<"lib/ory/model/update_login_flow_body.ex">>, |
| 203 221 | <<"lib/ory/model/update_login_flow_with_code_method.ex">>, |
| 222 | + <<"lib/ory/model/update_login_flow_with_identifier_first_method.ex">>, |
| 204 223 | <<"lib/ory/model/update_login_flow_with_lookup_secret_method.ex">>, |
| 205 224 | <<"lib/ory/model/update_login_flow_with_oidc_method.ex">>, |
| 225 | + <<"lib/ory/model/update_login_flow_with_passkey_method.ex">>, |
| 206 226 | <<"lib/ory/model/update_login_flow_with_password_method.ex">>, |
| 207 227 | <<"lib/ory/model/update_login_flow_with_totp_method.ex">>, |
| 208 228 | <<"lib/ory/model/update_login_flow_with_web_authn_method.ex">>, |
| @@ -212,11 +232,14 @@ | |
| 212 232 | <<"lib/ory/model/update_registration_flow_body.ex">>, |
| 213 233 | <<"lib/ory/model/update_registration_flow_with_code_method.ex">>, |
| 214 234 | <<"lib/ory/model/update_registration_flow_with_oidc_method.ex">>, |
| 235 | + <<"lib/ory/model/update_registration_flow_with_passkey_method.ex">>, |
| 215 236 | <<"lib/ory/model/update_registration_flow_with_password_method.ex">>, |
| 237 | + <<"lib/ory/model/update_registration_flow_with_profile_method.ex">>, |
| 216 238 | <<"lib/ory/model/update_registration_flow_with_web_authn_method.ex">>, |
| 217 239 | <<"lib/ory/model/update_settings_flow_body.ex">>, |
| 218 240 | <<"lib/ory/model/update_settings_flow_with_lookup_method.ex">>, |
| 219 241 | <<"lib/ory/model/update_settings_flow_with_oidc_method.ex">>, |
| 242 | + <<"lib/ory/model/update_settings_flow_with_passkey_method.ex">>, |
| 220 243 | <<"lib/ory/model/update_settings_flow_with_password_method.ex">>, |
| 221 244 | <<"lib/ory/model/update_settings_flow_with_profile_method.ex">>, |
| 222 245 | <<"lib/ory/model/update_settings_flow_with_totp_method.ex">>, |
| @@ -225,7 +248,7 @@ | |
| 225 248 | <<"lib/ory/model/update_verification_flow_body.ex">>, |
| 226 249 | <<"lib/ory/model/update_verification_flow_with_code_method.ex">>, |
| 227 250 | <<"lib/ory/model/update_verification_flow_with_link_method.ex">>, |
| 228 | - <<"lib/ory/model/usage.ex">>, |
| 251 | + <<"lib/ory/model/update_workspace_body.ex">>,<<"lib/ory/model/usage.ex">>, |
| 229 252 | <<"lib/ory/model/verifiable_credential_priming_response.ex">>, |
| 230 253 | <<"lib/ory/model/verifiable_credential_proof.ex">>, |
| 231 254 | <<"lib/ory/model/verifiable_credential_response.ex">>, |
| @@ -233,15 +256,16 @@ | |
| 233 256 | <<"lib/ory/model/verification_flow.ex">>, |
| 234 257 | <<"lib/ory/model/verification_flow_state.ex">>, |
| 235 258 | <<"lib/ory/model/version.ex">>,<<"lib/ory/model/warning.ex">>, |
| 236 | - <<"lib/ory/model/workspace.ex">>,<<"lib/ory/model/workspace_meta.ex">>, |
| 259 | + <<"lib/ory/model/workspace.ex">>,<<"lib/ory/model/workspace_api_key.ex">>, |
| 237 260 | <<"lib/ory/api">>,<<"lib/ory/api/courier.ex">>,<<"lib/ory/api/events.ex">>, |
| 238 261 | <<"lib/ory/api/frontend.ex">>,<<"lib/ory/api/identity.ex">>, |
| 239 262 | <<"lib/ory/api/jwk.ex">>,<<"lib/ory/api/metadata.ex">>, |
| 240 263 | <<"lib/ory/api/o_auth2.ex">>,<<"lib/ory/api/oidc.ex">>, |
| 241 264 | <<"lib/ory/api/permission.ex">>,<<"lib/ory/api/project.ex">>, |
| 242 265 | <<"lib/ory/api/relationship.ex">>,<<"lib/ory/api/wellknown.ex">>, |
| 243 | - <<"lib/ory/connection.ex">>,<<"lib/ory/request_builder.ex">>, |
| 244 | - <<"lib/ory/deserializer.ex">>,<<"mix.exs">>,<<"README.md">>,<<"LICENSE">>]}. |
| 266 | + <<"lib/ory/api/workspace.ex">>,<<"lib/ory/connection.ex">>, |
| 267 | + <<"lib/ory/request_builder.ex">>,<<"lib/ory/deserializer.ex">>, |
| 268 | + <<"mix.exs">>,<<"README.md">>,<<"LICENSE">>]}. |
| 245 269 | {<<"licenses">>,[<<"Apache-2.0">>]}. |
| 246 270 | {<<"links">>, |
| 247 271 | [{<<"Documentation">>,<<"https://www.ory.sh/docs">>}, |
| @@ -260,4 +284,4 @@ | |
| 260 284 | {<<"optional">>,false}, |
| 261 285 | {<<"repository">>,<<"hexpm">>}, |
| 262 286 | {<<"requirement">>,<<"~> 1.4">>}]]}. |
| 263 | - {<<"version">>,<<"1.6.2">>}. |
| 287 | + {<<"version">>,<<"1.16.10">>}. |
| @@ -1,4 +1,4 @@ | |
| 1 | - # NOTE: This file is auto generated by OpenAPI Generator 7.2.0 (https://openapi-generator.tech). |
| 1 | + # NOTE: This file is auto generated by OpenAPI Generator 7.7.0 (https://openapi-generator.tech). |
| 2 2 | # Do not edit this file manually. |
| 3 3 | |
| 4 4 | defmodule Ory.Api.Courier do |
| @@ -59,7 +59,7 @@ defmodule Ory.Api.Courier do | |
| 59 59 | - `{:ok, [%Message{}, ...]}` on success |
| 60 60 | - `{:error, Tesla.Env.t}` on failure |
| 61 61 | """ |
| 62 | - @spec list_courier_messages(Tesla.Env.client, keyword()) :: {:ok, list(Ory.Model.Message.t)} | {:ok, Ory.Model.ErrorGeneric.t} | {:error, Tesla.Env.t} |
| 62 | + @spec list_courier_messages(Tesla.Env.client, keyword()) :: {:ok, Ory.Model.ErrorGeneric.t} | {:ok, [Ory.Model.Message.t]} | {:error, Tesla.Env.t} |
| 63 63 | def list_courier_messages(connection, opts \\ []) do |
| 64 64 | optional_params = %{ |
| 65 65 | :page_size => :query, |
| @@ -1,4 +1,4 @@ | |
| 1 | - # NOTE: This file is auto generated by OpenAPI Generator 7.2.0 (https://openapi-generator.tech). |
| 1 | + # NOTE: This file is auto generated by OpenAPI Generator 7.7.0 (https://openapi-generator.tech). |
| 2 2 | # Do not edit this file manually. |
| 3 3 | |
| 4 4 | defmodule Ory.Api.Events do |
| @@ -1,4 +1,4 @@ | |
| 1 | - # NOTE: This file is auto generated by OpenAPI Generator 7.2.0 (https://openapi-generator.tech). |
| 1 | + # NOTE: This file is auto generated by OpenAPI Generator 7.7.0 (https://openapi-generator.tech). |
| 2 2 | # Do not edit this file manually. |
| 3 3 | |
| 4 4 | defmodule Ory.Api.Frontend do |
| @@ -23,6 +23,7 @@ defmodule Ory.Api.Frontend do | |
| 23 23 | - `:Cookie` (String.t): HTTP Cookies When using the SDK in a browser app, on the server side you must include the HTTP Cookie Header sent by the client to your server here. This ensures that CSRF and session cookies are respected. |
| 24 24 | - `:login_challenge` (String.t): An optional Hydra login challenge. If present, Kratos will cooperate with Ory Hydra to act as an OAuth2 identity provider. The value for this parameter comes from `login_challenge` URL Query parameter sent to your application (e.g. `/login?login_challenge=abcde`). |
| 25 25 | - `:organization` (String.t): An optional organization ID that should be used for logging this user in. This parameter is only effective in the Ory Network. |
| 26 | + - `:via` (String.t): Via should contain the identity's credential the code should be sent to. Only relevant in aal2 flows. DEPRECATED: This field is deprecated. Please remove it from your requests. The user will now see a choice of MFA credentials to choose from to perform the second factor instead. |
| 26 27 | |
| 27 28 | ### Returns |
| 28 29 | |
| @@ -37,7 +38,8 @@ defmodule Ory.Api.Frontend do | |
| 37 38 | :return_to => :query, |
| 38 39 | :Cookie => :headers, |
| 39 40 | :login_challenge => :query, |
| 40 | - :organization => :query |
| 41 | + :organization => :query, |
| 42 | + :via => :query |
| 41 43 | } |
| 42 44 | |
| 43 45 | request = |
| @@ -146,7 +148,7 @@ defmodule Ory.Api.Frontend do | |
| 146 148 | - `:return_to` (String.t): The URL to return the browser to after the flow was completed. |
| 147 149 | - `:login_challenge` (String.t): Ory OAuth 2.0 Login Challenge. If set will cooperate with Ory OAuth2 and OpenID to act as an OAuth2 server / OpenID Provider. The value for this parameter comes from `login_challenge` URL Query parameter sent to your application (e.g. `/registration?login_challenge=abcde`). This feature is compatible with Ory Hydra when not running on the Ory Network. |
| 148 150 | - `:after_verification_return_to` (String.t): The URL to return the browser to after the verification flow was completed. After the registration flow is completed, the user will be sent a verification email. Upon completing the verification flow, this URL will be used to override the default `selfservice.flows.verification.after.default_redirect_to` value. |
| 149 | - - `:organization` (String.t): |
| 151 | + - `:organization` (String.t): An optional organization ID that should be used to register this user. This parameter is only effective in the Ory Network. |
| 150 152 | |
| 151 153 | ### Returns |
| 152 154 | |
| @@ -257,6 +259,37 @@ defmodule Ory.Api.Frontend do | |
| 257 259 | ]) |
| 258 260 | end |
| 259 261 | |
| 262 | + @doc """ |
| 263 | + Get FedCM Parameters |
| 264 | + This endpoint returns a list of all available FedCM providers. It is only supported on the Ory Network. |
| 265 | + |
| 266 | + ### Parameters |
| 267 | + |
| 268 | + - `connection` (Ory.Connection): Connection to server |
| 269 | + - `opts` (keyword): Optional parameters |
| 270 | + |
| 271 | + ### Returns |
| 272 | + |
| 273 | + - `{:ok, Ory.Model.CreateFedcmFlowResponse.t}` on success |
| 274 | + - `{:error, Tesla.Env.t}` on failure |
| 275 | + """ |
| 276 | + @spec create_fedcm_flow(Tesla.Env.client, keyword()) :: {:ok, Ory.Model.ErrorGeneric.t} | {:ok, Ory.Model.CreateFedcmFlowResponse.t} | {:error, Tesla.Env.t} |
| 277 | + def create_fedcm_flow(connection, _opts \\ []) do |
| 278 | + request = |
| 279 | + %{} |
| 280 | + |> method(:get) |
| 281 | + |> url("/self-service/fed-cm/parameters") |
| 282 | + |> Enum.into([]) |
| 283 | + |
| 284 | + connection |
| 285 | + |> Connection.request(request) |
| 286 | + |> evaluate_response([ |
| 287 | + {200, Ory.Model.CreateFedcmFlowResponse}, |
| 288 | + {400, Ory.Model.ErrorGeneric}, |
| 289 | + {:default, Ory.Model.ErrorGeneric} |
| 290 | + ]) |
| 291 | + end |
| 292 | + |
| 260 293 | @doc """ |
| 261 294 | Create Login Flow for Native Apps |
| 262 295 | This endpoint initiates a login flow for native apps that do not use a browser, such as mobile devices, smart TVs, and so on. If a valid provided session cookie or session token is provided, a 400 Bad Request error will be returned unless the URL query parameter `?refresh=true` is set. To fetch an existing login flow call `/self-service/login/flows?flow=<flow_id>`. You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks, including CSRF login attacks. In the case of an error, the `error.id` of the JSON response body can be one of: `session_already_available`: The user is already signed in. `session_aal1_required`: Multi-factor auth (e.g. 2fa) was requested but the user has no session yet. `security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). More information can be found at [Ory Kratos User Login](https://www.ory.sh/docs/kratos/self-service/flows/user-login) and [User Registration Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-registration). |
| @@ -270,7 +303,8 @@ defmodule Ory.Api.Frontend do | |
| 270 303 | - `:"X-Session-Token"` (String.t): The Session Token of the Identity performing the settings flow. |
| 271 304 | - `:return_session_token_exchange_code` (boolean()): EnableSessionTokenExchangeCode requests the login flow to include a code that can be used to retrieve the session token after the login flow has been completed. |
| 272 305 | - `:return_to` (String.t): The URL to return the browser to after the flow was completed. |
| 273 | - - `:via` (String.t): Via should contain the identity's credential the code should be sent to. Only relevant in aal2 flows. |
| 306 | + - `:organization` (String.t): An optional organization ID that should be used for logging this user in. This parameter is only effective in the Ory Network. |
| 307 | + - `:via` (String.t): Via should contain the identity's credential the code should be sent to. Only relevant in aal2 flows. DEPRECATED: This field is deprecated. Please remove it from your requests. The user will now see a choice of MFA credentials to choose from to perform the second factor instead. |
| 274 308 | |
| 275 309 | ### Returns |
| 276 310 | |
| @@ -285,6 +319,7 @@ defmodule Ory.Api.Frontend do | |
| 285 319 | :"X-Session-Token" => :headers, |
| 286 320 | :return_session_token_exchange_code => :query, |
| 287 321 | :return_to => :query, |
| 322 | + :organization => :query, |
| 288 323 | :via => :query |
| 289 324 | } |
| 290 325 | |
| @@ -345,6 +380,7 @@ defmodule Ory.Api.Frontend do | |
| 345 380 | - `opts` (keyword): Optional parameters |
| 346 381 | - `:return_session_token_exchange_code` (boolean()): EnableSessionTokenExchangeCode requests the login flow to include a code that can be used to retrieve the session token after the login flow has been completed. |
| 347 382 | - `:return_to` (String.t): The URL to return the browser to after the flow was completed. |
| 383 | + - `:organization` (String.t): An optional organization ID that should be used to register this user. This parameter is only effective in the Ory Network. |
| 348 384 | |
| 349 385 | ### Returns |
| 350 386 | |
| @@ -355,7 +391,8 @@ defmodule Ory.Api.Frontend do | |
| 355 391 | def create_native_registration_flow(connection, opts \\ []) do |
| 356 392 | optional_params = %{ |
| 357 393 | :return_session_token_exchange_code => :query, |
| 358 | - :return_to => :query |
| 394 | + :return_to => :query, |
| 395 | + :organization => :query |
| 359 396 | } |
| 360 397 | |
| 361 398 | request = |
| @@ -419,6 +456,7 @@ defmodule Ory.Api.Frontend do | |
| 419 456 | |
| 420 457 | - `connection` (Ory.Connection): Connection to server |
| 421 458 | - `opts` (keyword): Optional parameters |
| 459 | + - `:return_to` (String.t): A URL contained in the return_to key of the verification flow. This piece of data has no effect on the actual logic of the flow and is purely informational. |
| 422 460 | |
| 423 461 | ### Returns |
| 424 462 | |
| @@ -426,11 +464,16 @@ defmodule Ory.Api.Frontend do | |
| 426 464 | - `{:error, Tesla.Env.t}` on failure |
| 427 465 | """ |
| 428 466 | @spec create_native_verification_flow(Tesla.Env.client, keyword()) :: {:ok, Ory.Model.ErrorGeneric.t} | {:ok, Ory.Model.VerificationFlow.t} | {:error, Tesla.Env.t} |
| 429 | - def create_native_verification_flow(connection, _opts \\ []) do |
| 467 | + def create_native_verification_flow(connection, opts \\ []) do |
| 468 | + optional_params = %{ |
| 469 | + :return_to => :query |
| 470 | + } |
| 471 | + |
| 430 472 | request = |
| 431 473 | %{} |
| 432 474 | |> method(:get) |
| 433 475 | |> url("/self-service/verification/api") |
| 476 | + |> add_optional_params(optional_params, opts) |
| 434 477 | |> Enum.into([]) |
| 435 478 | |
| 436 479 | connection |
| @@ -848,7 +891,7 @@ defmodule Ory.Api.Frontend do | |
| 848 891 | - `{:ok, [%Session{}, ...]}` on success |
| 849 892 | - `{:error, Tesla.Env.t}` on failure |
| 850 893 | """ |
| 851 | - @spec list_my_sessions(Tesla.Env.client, keyword()) :: {:ok, list(Ory.Model.Session.t)} | {:ok, Ory.Model.ErrorGeneric.t} | {:error, Tesla.Env.t} |
| 894 | + @spec list_my_sessions(Tesla.Env.client, keyword()) :: {:ok, [Ory.Model.Session.t]} | {:ok, Ory.Model.ErrorGeneric.t} | {:error, Tesla.Env.t} |
| 852 895 | def list_my_sessions(connection, opts \\ []) do |
| 853 896 | optional_params = %{ |
| 854 897 | :per_page => :query, |
| @@ -951,6 +994,42 @@ defmodule Ory.Api.Frontend do | |
| 951 994 | ]) |
| 952 995 | end |
| 953 996 | |
| 997 | + @doc """ |
| 998 | + Submit a FedCM token |
| 999 | + Use this endpoint to submit a token from a FedCM provider through `navigator.credentials.get` and log the user in. The parameters from `navigator.credentials.get` must have come from `GET self-service/fed-cm/parameters`. |
| 1000 | + |
| 1001 | + ### Parameters |
| 1002 | + |
| 1003 | + - `connection` (Ory.Connection): Connection to server |
| 1004 | + - `update_fedcm_flow_body` (UpdateFedcmFlowBody): |
| 1005 | + - `opts` (keyword): Optional parameters |
| 1006 | + |
| 1007 | + ### Returns |
| 1008 | + |
| 1009 | + - `{:ok, Ory.Model.SuccessfulNativeLogin.t}` on success |
| 1010 | + - `{:error, Tesla.Env.t}` on failure |
| 1011 | + """ |
| 1012 | + @spec update_fedcm_flow(Tesla.Env.client, Ory.Model.UpdateFedcmFlowBody.t, keyword()) :: {:ok, nil} | {:ok, Ory.Model.ErrorGeneric.t} | {:ok, Ory.Model.LoginFlow.t} | {:ok, Ory.Model.ErrorBrowserLocationChangeRequired.t} | {:ok, Ory.Model.SuccessfulNativeLogin.t} | {:error, Tesla.Env.t} |
| 1013 | + def update_fedcm_flow(connection, update_fedcm_flow_body, _opts \\ []) do |
| 1014 | + request = |
| 1015 | + %{} |
| 1016 | + |> method(:post) |
| 1017 | + |> url("/self-service/fed-cm/token") |
| 1018 | + |> add_param(:body, :body, update_fedcm_flow_body) |
| 1019 | + |> Enum.into([]) |
| 1020 | + |
| 1021 | + connection |
| 1022 | + |> Connection.request(request) |
| 1023 | + |> evaluate_response([ |
| 1024 | + {200, Ory.Model.SuccessfulNativeLogin}, |
| 1025 | + {303, false}, |
| 1026 | + {400, Ory.Model.LoginFlow}, |
| 1027 | + {410, Ory.Model.ErrorGeneric}, |
| 1028 | + {422, Ory.Model.ErrorBrowserLocationChangeRequired}, |
| 1029 | + {:default, Ory.Model.ErrorGeneric} |
| 1030 | + ]) |
| 1031 | + end |
| 1032 | + |
| 954 1033 | @doc """ |
| 955 1034 | Submit a Login Flow |
| 956 1035 | Use this endpoint to complete a login flow. This endpoint behaves differently for API and browser flows. API flows expect `application/json` to be sent in the body and responds with HTTP 200 and a application/json body with the session token on success; HTTP 410 if the original flow expired with the appropriate error messages set and optionally a `use_flow_id` parameter in the body; HTTP 400 on form validation errors. Browser flows expect a Content-Type of `application/x-www-form-urlencoded` or `application/json` to be sent in the body and respond with a HTTP 303 redirect to the post/after login URL or the `return_to` value if it was set and if the login succeeded; a HTTP 303 redirect to the login UI URL with the flow ID containing the validation errors otherwise. Browser flows with an accept header of `application/json` will not redirect but instead respond with HTTP 200 and a application/json body with the signed in identity and a `Set-Cookie` header on success; HTTP 303 redirect to a fresh login flow if the original flow expired with the appropriate error messages set; HTTP 400 on form validation errors. If this endpoint is called with `Accept: application/json` in the header, the response contains the flow without a redirect. In the case of an error, the `error.id` of the JSON response body can be one of: `session_already_available`: The user is already signed in. `security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred. `security_identity_mismatch`: The requested `?return_to` address is not allowed to be used. Adjust this in the configuration! `browser_location_change_required`: Usually sent when an AJAX request indicates that the browser needs to open a specific URL. Most likely used in Social Sign In flows. More information can be found at [Ory Kratos User Login](https://www.ory.sh/docs/kratos/self-service/flows/user-login) and [User Registration Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-registration). |
Loading more files…