Packages
ory_client
1.22.48
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
28
files changed
+367
additions
-182
deletions
| @@ -18,7 +18,7 @@ your list of dependencies in `mix.exs`: | |
| 18 18 | |
| 19 19 | ```elixir |
| 20 20 | def deps do |
| 21 | - [{:ory_client, "~> 1.22.47"}] |
| 21 | + [{:ory_client, "~> 1.22.48"}] |
| 22 22 | end |
| 23 23 | ``` |
| @@ -15,7 +15,8 @@ | |
| 15 15 | <<"lib/ory/model/add_project_to_workspace_body.ex">>, |
| 16 16 | <<"lib/ory/model/admin_identity_import_credentials_lookup_secret.ex">>, |
| 17 17 | <<"lib/ory/model/admin_identity_import_credentials_lookup_secret_config.ex">>, |
| 18 | - <<"lib/ory/model/admin_revoke_api_key_body.ex">>, |
| 18 | + <<"lib/ory/model/admin_revoke_imported_api_key_body.ex">>, |
| 19 | + <<"lib/ory/model/admin_revoke_issued_api_key_body.ex">>, |
| 19 20 | <<"lib/ory/model/admin_rotate_issued_api_key_body.ex">>, |
| 20 21 | <<"lib/ory/model/admin_update_imported_api_key_request.ex">>, |
| 21 22 | <<"lib/ory/model/admin_update_issued_api_key_request.ex">>, |
| @@ -26,10 +27,10 @@ | |
| 26 27 | <<"lib/ory/model/basic_organization.ex">>, |
| 27 28 | <<"lib/ory/model/batch_check_permission_body.ex">>, |
| 28 29 | <<"lib/ory/model/batch_check_permission_result.ex">>, |
| 29 | - <<"lib/ory/model/batch_import_api_keys_request.ex">>, |
| 30 | - <<"lib/ory/model/batch_import_api_keys_response.ex">>, |
| 31 | - <<"lib/ory/model/batch_import_error_code.ex">>, |
| 32 | - <<"lib/ory/model/batch_import_result.ex">>, |
| 30 | + <<"lib/ory/model/batch_create_imported_api_keys_error_code.ex">>, |
| 31 | + <<"lib/ory/model/batch_create_imported_api_keys_request.ex">>, |
| 32 | + <<"lib/ory/model/batch_create_imported_api_keys_response.ex">>, |
| 33 | + <<"lib/ory/model/batch_create_imported_api_keys_result.ex">>, |
| 33 34 | <<"lib/ory/model/batch_patch_identities_response.ex">>, |
| 34 35 | <<"lib/ory/model/batch_verify_api_keys_request.ex">>, |
| 35 36 | <<"lib/ory/model/batch_verify_api_keys_response.ex">>, |
| @@ -89,15 +90,14 @@ | |
| 89 90 | <<"lib/ory/model/device_authn_ios_attestation.ex">>, |
| 90 91 | <<"lib/ory/model/device_authn_key.ex">>, |
| 91 92 | <<"lib/ory/model/device_authorization.ex">>, |
| 93 | + <<"lib/ory/model/error_generic.ex">>, |
| 92 94 | <<"lib/ory/model/device_user_auth_request.ex">>, |
| 93 95 | <<"lib/ory/model/email_template_data.ex">>, |
| 94 96 | <<"lib/ory/model/email_template_data_body.ex">>, |
| 95 | - <<"lib/ory/model/identity.ex">>, |
| 96 97 | <<"lib/ory/model/error_authenticator_assurance_level_not_satisfied.ex">>, |
| 97 98 | <<"lib/ory/model/error_browser_location_change_required.ex">>, |
| 98 99 | <<"lib/ory/model/error_flow_replaced.ex">>, |
| 99 | - <<"lib/ory/model/error_generic.ex">>,<<"lib/ory/model/error_o_auth2.ex">>, |
| 100 | - <<"lib/ory/model/event_stream.ex">>, |
| 100 | + <<"lib/ory/model/error_o_auth2.ex">>,<<"lib/ory/model/event_stream.ex">>, |
| 101 101 | <<"lib/ory/model/expanded_permission_tree.ex">>, |
| 102 102 | <<"lib/ory/model/flow_error.ex">>,<<"lib/ory/model/generic_error.ex">>, |
| 103 103 | <<"lib/ory/model/generic_error_content.ex">>, |
| @@ -116,7 +116,7 @@ | |
| 116 116 | <<"lib/ory/model/get_session_activity.ex">>, |
| 117 117 | <<"lib/ory/model/get_version_200_response.ex">>, |
| 118 118 | <<"lib/ory/model/health_not_ready_status.ex">>, |
| 119 | - <<"lib/ory/model/health_status.ex">>, |
| 119 | + <<"lib/ory/model/health_status.ex">>,<<"lib/ory/model/identity.ex">>, |
| 120 120 | <<"lib/ory/model/identity_credentials.ex">>, |
| 121 121 | <<"lib/ory/model/identity_credentials_code.ex">>, |
| 122 122 | <<"lib/ory/model/identity_credentials_code_address.ex">>, |
| @@ -177,9 +177,9 @@ | |
| 177 177 | <<"lib/ory/model/login_flow_state.ex">>, |
| 178 178 | <<"lib/ory/model/login_flow_test_context.ex">>, |
| 179 179 | <<"lib/ory/model/login_flow_test_debug_payload.ex">>, |
| 180 | - <<"lib/ory/model/logout_flow.ex">>, |
| 181 180 | <<"lib/ory/model/login_flow_test_schema_validation_error.ex">>, |
| 182 181 | <<"lib/ory/model/login_flow_test_step_error.ex">>, |
| 182 | + <<"lib/ory/model/logout_flow.ex">>, |
| 183 183 | <<"lib/ory/model/manage_sessions_body.ex">>, |
| 184 184 | <<"lib/ory/model/manage_sessions_response.ex">>, |
| 185 185 | <<"lib/ory/model/managed_identity_schema.ex">>, |
| @@ -233,6 +233,7 @@ | |
| 233 233 | <<"lib/ory/model/project_service_identity.ex">>, |
| 234 234 | <<"lib/ory/model/project_service_o_auth2.ex">>, |
| 235 235 | <<"lib/ory/model/project_service_permission.ex">>, |
| 236 | + <<"lib/ory/model/project_service_talos.ex">>, |
| 236 237 | <<"lib/ory/model/project_services.ex">>,<<"lib/ory/model/provider.ex">>, |
| 237 238 | <<"lib/ory/model/quota_usage.ex">>,<<"lib/ory/model/rate_limit_policy.ex">>, |
| 238 239 | <<"lib/ory/model/recovery_code_for_identity.ex">>, |
| @@ -251,6 +252,7 @@ | |
| 251 252 | <<"lib/ory/model/revocation_reason.ex">>, |
| 252 253 | <<"lib/ory/model/rfc6749_error_json.ex">>, |
| 253 254 | <<"lib/ory/model/rotate_issued_api_key_response.ex">>, |
| 255 | + <<"lib/ory/model/rotate_talos_key_body.ex">>, |
| 254 256 | <<"lib/ory/model/schema_patch.ex">>, |
| 255 257 | <<"lib/ory/model/self_revoke_api_key_request.ex">>, |
| 256 258 | <<"lib/ory/model/self_service_flow_expired_error.ex">>, |
| @@ -371,4 +373,4 @@ | |
| 371 373 | {<<"optional">>,false}, |
| 372 374 | {<<"repository">>,<<"hexpm">>}, |
| 373 375 | {<<"requirement">>,<<"~> 1.4">>}]]}. |
| 374 | - {<<"version">>,<<"1.22.47">>}. |
| 376 | + {<<"version">>,<<"1.22.48">>}. |
| @@ -1,9 +1,9 @@ | |
| 1 1 | # NOTE: This file is auto generated by OpenAPI Generator 7.12.0 (https://openapi-generator.tech). |
| 2 2 | # Do not edit this file manually. |
| 3 3 | |
| 4 | - defmodule Ory.Api.APIKeys do |
| 4 | + defmodule Ory.Api.ApiKeys do |
| 5 5 | @moduledoc """ |
| 6 | - API calls for all endpoints tagged `APIKeys`. |
| 6 | + API calls for all endpoints tagged `ApiKeys`. |
| 7 7 | """ |
| 8 8 | |
| 9 9 | alias Ory.Connection |
| @@ -11,32 +11,32 @@ defmodule Ory.Api.APIKeys do | |
| 11 11 | |
| 12 12 | @doc """ |
| 13 13 | Batch Import API Keys |
| 14 | - Imports up to 1000 external API keys in one request. Returns per-item results. If at least one item succeeds, response is 200 OK. If all items fail, the endpoint returns a non-200 error. ```http POST /v2alpha1/admin/importedApiKeys:batchImport { \"requests\": [ {\"raw_key\": \"sk_live_abc\", \"name\": \"Stripe key\", \"actor_id\": \"user_1\"}, {\"raw_key\": \"ghp_xyz\", \"name\": \"GitHub PAT\", \"actor_id\": \"user_2\"} ] } ``` |
| 14 | + Imports up to 1000 external API keys in one request. Returns per-item results. If at least one item succeeds, response is 200 OK. If all items fail, the endpoint returns a non-200 error. ```http POST /v2alpha1/admin/importedApiKeys:batchCreate { \"requests\": [ {\"raw_key\": \"sk_live_abc\", \"name\": \"Stripe key\", \"actor_id\": \"user_1\"}, {\"raw_key\": \"ghp_xyz\", \"name\": \"GitHub PAT\", \"actor_id\": \"user_2\"} ] } ``` |
| 15 15 | |
| 16 16 | ### Parameters |
| 17 17 | |
| 18 18 | - `connection` (Ory.Connection): Connection to server |
| 19 | - - `batch_import_api_keys_request` (BatchImportApiKeysRequest): BatchImportAPIKeysRequest imports multiple external API keys in one request. The maximum batch size is 1000 keys. |
| 19 | + - `batch_create_imported_api_keys_request` (BatchCreateImportedApiKeysRequest): BatchCreateImportedApiKeysRequest imports multiple external API keys in one request. The maximum batch size is 1000 keys. |
| 20 20 | - `opts` (keyword): Optional parameters |
| 21 21 | |
| 22 22 | ### Returns |
| 23 23 | |
| 24 | - - `{:ok, Ory.Model.BatchImportApiKeysResponse.t}` on success |
| 24 | + - `{:ok, Ory.Model.BatchCreateImportedApiKeysResponse.t}` on success |
| 25 25 | - `{:error, Tesla.Env.t}` on failure |
| 26 26 | """ |
| 27 | - @spec admin_batch_import_api_keys(Tesla.Env.client, Ory.Model.BatchImportApiKeysRequest.t, keyword()) :: {:ok, Ory.Model.BatchImportApiKeysResponse.t} | {:ok, Ory.Model.Status.t} | {:error, Tesla.Env.t} |
| 28 | - def admin_batch_import_api_keys(connection, batch_import_api_keys_request, _opts \\ []) do |
| 27 | + @spec admin_batch_create_imported_api_keys(Tesla.Env.client, Ory.Model.BatchCreateImportedApiKeysRequest.t, keyword()) :: {:ok, Ory.Model.BatchCreateImportedApiKeysResponse.t} | {:ok, Ory.Model.Status.t} | {:error, Tesla.Env.t} |
| 28 | + def admin_batch_create_imported_api_keys(connection, batch_create_imported_api_keys_request, _opts \\ []) do |
| 29 29 | request = |
| 30 30 | %{} |
| 31 31 | |> method(:post) |
| 32 | - |> url("/v2alpha1/admin/importedApiKeys:batchImport") |
| 33 | - |> add_param(:body, :body, batch_import_api_keys_request) |
| 32 | + |> url("/v2alpha1/admin/importedApiKeys:batchCreate") |
| 33 | + |> add_param(:body, :body, batch_create_imported_api_keys_request) |
| 34 34 | |> Enum.into([]) |
| 35 35 | |
| 36 36 | connection |
| 37 37 | |> Connection.request(request) |
| 38 38 | |> evaluate_response([ |
| 39 | - {200, Ory.Model.BatchImportApiKeysResponse}, |
| 39 | + {200, Ory.Model.BatchCreateImportedApiKeysResponse}, |
| 40 40 | {:default, Ory.Model.Status} |
| 41 41 | ]) |
| 42 42 | end |
| @@ -83,7 +83,7 @@ defmodule Ory.Api.APIKeys do | |
| 83 83 | |
| 84 84 | @doc """ |
| 85 85 | Delete Imported API Key |
| 86 | - Permanently deletes an imported key (hard delete). The key is removed from the database. Use RevokeAPIKey for soft deletion (recommended). ```http DELETE /v2alpha1/admin/importedApiKeys/{key_id} ``` |
| 86 | + Permanently deletes an imported key (hard delete). The key is removed from the database. Use AdminRevokeImportedApiKey for soft deletion (recommended). ```http DELETE /v2alpha1/admin/importedApiKeys/{key_id} ``` |
| 87 87 | |
| 88 88 | ### Parameters |
| 89 89 | |
| @@ -312,7 +312,7 @@ defmodule Ory.Api.APIKeys do | |
| 312 312 | |
| 313 313 | @doc """ |
| 314 314 | List Issued API Keys |
| 315 | - Lists issued API keys with optional filtering. Supports cursor-based pagination and AIP-160 filter expressions. Returns only issued (generated) API keys; use ListImportedAPIKeys for imported keys. ```http GET /v2alpha1/admin/issuedApiKeys?page_size=50&filter=actor_id%3D%22user_123%22 ``` |
| 315 | + Lists issued API keys with optional filtering. Supports cursor-based pagination and AIP-160 filter expressions. Returns only issued (generated) API keys; use ListImportedApiKeys for imported keys. ```http GET /v2alpha1/admin/issuedApiKeys?page_size=50&filter=actor_id%3D%22user_123%22 ``` |
| 316 316 | |
| 317 317 | ### Parameters |
| 318 318 | |
| @@ -351,14 +351,14 @@ defmodule Ory.Api.APIKeys do | |
| 351 351 | end |
| 352 352 | |
| 353 353 | @doc """ |
| 354 | - Revoke API Key |
| 355 | - Immediately revokes an API key (issued or imported). Once revoked, the key can no longer be used for authentication. This operation is irreversible. Revoked keys are retained for audit purposes. ```http POST /v2alpha1/admin/apiKeys/01HQZX9VYQKJB8XQZQXQZQXQXQ:revoke { \"reason\": \"REVOCATION_REASON_KEY_COMPROMISE\" } ``` |
| 354 | + Revoke Imported API Key |
| 355 | + Immediately revokes an imported API key. Once revoked, the key can no longer be used for authentication. This operation is irreversible. Revoked keys are retained for audit purposes. ```http POST /v2alpha1/admin/importedApiKeys/9a3f051b2c7e8d4f1a6b9c0e5f2d8a3b:revoke { \"reason\": \"REVOCATION_REASON_KEY_COMPROMISE\" } ``` |
| 356 356 | |
| 357 357 | ### Parameters |
| 358 358 | |
| 359 359 | - `connection` (Ory.Connection): Connection to server |
| 360 | - - `key_id` (String.t): Identifier of the API key resource. |
| 361 | - - `admin_revoke_api_key_body` (AdminRevokeApiKeyBody): |
| 360 | + - `key_id` (String.t): SHA-512/256 hash of the imported key (REQUIRED) |
| 361 | + - `admin_revoke_imported_api_key_body` (AdminRevokeImportedApiKeyBody): |
| 362 362 | - `opts` (keyword): Optional parameters |
| 363 363 | |
| 364 364 | ### Returns |
| @@ -366,13 +366,46 @@ defmodule Ory.Api.APIKeys do | |
| 366 366 | - `{:ok, any()}` on success |
| 367 367 | - `{:error, Tesla.Env.t}` on failure |
| 368 368 | """ |
| 369 | - @spec admin_revoke_api_key(Tesla.Env.client, String.t, Ory.Model.AdminRevokeApiKeyBody.t, keyword()) :: {:ok, any()} | {:ok, Ory.Model.Status.t} | {:error, Tesla.Env.t} |
| 370 | - def admin_revoke_api_key(connection, key_id, admin_revoke_api_key_body, _opts \\ []) do |
| 369 | + @spec admin_revoke_imported_api_key(Tesla.Env.client, String.t, Ory.Model.AdminRevokeImportedApiKeyBody.t, keyword()) :: {:ok, any()} | {:ok, Ory.Model.Status.t} | {:error, Tesla.Env.t} |
| 370 | + def admin_revoke_imported_api_key(connection, key_id, admin_revoke_imported_api_key_body, _opts \\ []) do |
| 371 371 | request = |
| 372 372 | %{} |
| 373 373 | |> method(:post) |
| 374 | - |> url("/v2alpha1/admin/apiKeys/#{key_id}:revoke") |
| 375 | - |> add_param(:body, :body, admin_revoke_api_key_body) |
| 374 | + |> url("/v2alpha1/admin/importedApiKeys/#{key_id}:revoke") |
| 375 | + |> add_param(:body, :body, admin_revoke_imported_api_key_body) |
| 376 | + |> Enum.into([]) |
| 377 | + |
| 378 | + connection |
| 379 | + |> Connection.request(request) |
| 380 | + |> evaluate_response([ |
| 381 | + {204, false}, |
| 382 | + {:default, Ory.Model.Status} |
| 383 | + ]) |
| 384 | + end |
| 385 | + |
| 386 | + @doc """ |
| 387 | + Revoke Issued API Key |
| 388 | + Immediately revokes an issued API key. Once revoked, the key can no longer be used for authentication. This operation is irreversible. Revoked keys are retained for audit purposes. ```http POST /v2alpha1/admin/issuedApiKeys/01HQZX9VYQKJB8XQZQXQZQXQXQ:revoke { \"reason\": \"REVOCATION_REASON_KEY_COMPROMISE\" } ``` |
| 389 | + |
| 390 | + ### Parameters |
| 391 | + |
| 392 | + - `connection` (Ory.Connection): Connection to server |
| 393 | + - `key_id` (String.t): UUID of the issued key (REQUIRED) |
| 394 | + - `admin_revoke_issued_api_key_body` (AdminRevokeIssuedApiKeyBody): |
| 395 | + - `opts` (keyword): Optional parameters |
| 396 | + |
| 397 | + ### Returns |
| 398 | + |
| 399 | + - `{:ok, any()}` on success |
| 400 | + - `{:error, Tesla.Env.t}` on failure |
| 401 | + """ |
| 402 | + @spec admin_revoke_issued_api_key(Tesla.Env.client, String.t, Ory.Model.AdminRevokeIssuedApiKeyBody.t, keyword()) :: {:ok, any()} | {:ok, Ory.Model.Status.t} | {:error, Tesla.Env.t} |
| 403 | + def admin_revoke_issued_api_key(connection, key_id, admin_revoke_issued_api_key_body, _opts \\ []) do |
| 404 | + request = |
| 405 | + %{} |
| 406 | + |> method(:post) |
| 407 | + |> url("/v2alpha1/admin/issuedApiKeys/#{key_id}:revoke") |
| 408 | + |> add_param(:body, :body, admin_revoke_issued_api_key_body) |
| 376 409 | |> Enum.into([]) |
| 377 410 | |
| 378 411 | connection |
| @@ -385,7 +418,7 @@ defmodule Ory.Api.APIKeys do | |
| 385 418 | |
| 386 419 | @doc """ |
| 387 420 | Rotate Issued API Key |
| 388 | - Generates a new secret for an issued API key. Creates a new API key with a new key_id and secret, and immediately revokes the old key. This is the recommended way to update scopes, metadata, or rotate credentials. For zero-downtime rotation, use this workflow instead: 1. IssueAPIKey with new credentials 2. Deploy new secret to all services 3. Verify new secret works everywhere 4. RevokeAPIKey to remove the old key ```http POST /v2alpha1/admin/issuedApiKeys/01HQZX9VYQKJB8XQZQXQZQXQXQ:rotate { \"scopes\": [\"read\"] } ``` |
| 421 | + Generates a new secret for an issued API key. Creates a new API key with a new key_id and secret, and immediately revokes the old key. This is the recommended way to update scopes, metadata, or rotate credentials. For zero-downtime rotation, use this workflow instead: 1. IssueApiKey with new credentials 2. Deploy new secret to all services 3. Verify new secret works everywhere 4. AdminRevokeIssuedApiKey to remove the old key ```http POST /v2alpha1/admin/issuedApiKeys/01HQZX9VYQKJB8XQZQXQZQXQXQ:rotate { \"scopes\": [\"read\"] } ``` |
| 389 422 | |
| 390 423 | ### Parameters |
| 391 424 | |
| @@ -457,7 +490,7 @@ defmodule Ory.Api.APIKeys do | |
| 457 490 | |
| 458 491 | @doc """ |
| 459 492 | Update Issued API Key |
| 460 | - Updates metadata, scopes, or rate limits of an issued key without rotating the secret. Use RotateIssuedAPIKey to change the secret. Follows AIP-134: the request body is the IssuedAPIKey resource itself, and the update_mask query parameter names the subset of fields to apply. Omitting update_mask is equivalent to a mask of every populated field in the body. To clear a field to its zero value, list it explicitly in update_mask and leave it unset (or empty) in the body. ```http PATCH /v2alpha1/admin/issuedApiKeys/01HQZX9VYQKJB8XQZQXQZQXQXQ?update_mask=scopes { \"issued_api_key\": { \"key_id\": \"01HQZX9VYQKJB8XQZQXQZQXQXQ\", \"scopes\": [\"read\"] } } ``` |
| 493 | + Updates metadata, scopes, or rate limits of an issued key without rotating the secret. Use RotateIssuedApiKey to change the secret. Follows AIP-134: the request body is the IssuedApiKey resource itself, and the update_mask query parameter names the subset of fields to apply. Omitting update_mask is equivalent to a mask of every populated field in the body. To clear a field to its zero value, list it explicitly in update_mask and leave it unset (or empty) in the body. ```http PATCH /v2alpha1/admin/issuedApiKeys/01HQZX9VYQKJB8XQZQXQZQXQXQ?update_mask=scopes { \"issued_api_key\": { \"key_id\": \"01HQZX9VYQKJB8XQZQXQZQXQXQ\", \"scopes\": [\"read\"] } } ``` |
| 461 494 | |
| 462 495 | ### Parameters |
| 463 496 | |
| @@ -566,12 +599,12 @@ defmodule Ory.Api.APIKeys do | |
| 566 599 | |
| 567 600 | @doc """ |
| 568 601 | Revoke API Key (self-service) |
| 569 | - Proof-of-possession variant of revocation. Lives alongside `AdminRevokeAPIKey` in this service; the `Self*` prefix on the request/response messages disambiguates from the admin variant's `RevokeAPIKeyRequest`. Allows an API key holder to revoke their own key. The caller must provide the full API key secret as proof of possession. Supports issued API keys and imported keys. JWT and macaroon tokens cannot be self-revoked (they are stateless). The PRIVILEGE_WITHDRAWN reason is not allowed for self-revocation (admin-only). ```http POST /v2alpha1/apiKeys:selfRevoke { \"credential\": \"sk_live_abc123...\", \"reason\": \"REVOCATION_REASON_KEY_COMPROMISE\" } ``` |
| 602 | + Proof-of-possession variant of revocation. The `Self*` prefix on the request/response messages disambiguates from the admin variants (`AdminRevokeIssuedApiKey` / `AdminRevokeImportedApiKey`). Allows an API key holder to revoke their own key. The caller must provide the full API key secret as proof of possession. Supports issued API keys and imported keys. JWT and macaroon tokens cannot be self-revoked (they are stateless). The PRIVILEGE_WITHDRAWN reason is not allowed for self-revocation (admin-only). ```http POST /v2alpha1/apiKeys:selfRevoke { \"credential\": \"sk_live_abc123...\", \"reason\": \"REVOCATION_REASON_KEY_COMPROMISE\" } ``` |
| 570 603 | |
| 571 604 | ### Parameters |
| 572 605 | |
| 573 606 | - `connection` (Ory.Connection): Connection to server |
| 574 | - - `self_revoke_api_key_request` (SelfRevokeApiKeyRequest): SelfRevokeAPIKeyRequest allows an API key holder to revoke their own key by providing the full key secret as proof of possession. |
| 607 | + - `self_revoke_api_key_request` (SelfRevokeApiKeyRequest): SelfRevokeApiKeyRequest allows an API key holder to revoke their own key by providing the full key secret as proof of possession. |
| 575 608 | - `opts` (keyword): Optional parameters |
| 576 609 | |
| 577 610 | ### Returns |
| @@ -164,7 +164,7 @@ defmodule Ory.Connection do | |
| 164 164 | Keyword.get( |
| 165 165 | tesla_options, |
| 166 166 | :user_agent, |
| 167 | - "openapi-generator - Ory 1.22.47 - elixir" |
| 167 | + "openapi-generator - Ory 1.22.48 - elixir" |
| 168 168 | ) |
| 169 169 | ) |
| @@ -1,27 +0,0 @@ | |
| 1 | - # NOTE: This file is auto generated by OpenAPI Generator 7.12.0 (https://openapi-generator.tech). |
| 2 | - # Do not edit this file manually. |
| 3 | - |
| 4 | - defmodule Ory.Model.AdminRevokeApiKeyBody do |
| 5 | - @moduledoc """ |
| 6 | - |
| 7 | - """ |
| 8 | - |
| 9 | - @derive Jason.Encoder |
| 10 | - defstruct [ |
| 11 | - :description, |
| 12 | - :reason |
| 13 | - ] |
| 14 | - |
| 15 | - @type t :: %__MODULE__{ |
| 16 | - :description => String.t | nil, |
| 17 | - :reason => Ory.Model.RevocationReason.t | nil |
| 18 | - } |
| 19 | - |
| 20 | - alias Ory.Deserializer |
| 21 | - |
| 22 | - def decode(value) do |
| 23 | - value |
| 24 | - |> Deserializer.deserialize(:reason, :struct, Ory.Model.RevocationReason) |
| 25 | - end |
| 26 | - end |
| 27 | - |
Loading more files…