ory-kratos-client 1.3.8 → 25.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dcb0430ddf79b4c751a7a8a04517257f90a7632b8f3ebbf07f40e64e1ce019e3
-  data.tar.gz: 644753c40790b5fb4efc17014442d80818146cbfb97fe04d956155fbdc4a05c6
+  metadata.gz: 79d583c64fbbd982759b4a7b1916bef24d2684b00d20138bbaebead837dc3c52
+  data.tar.gz: ffde41822486a19d2c3ac57ab0e68795175928063caa59cc95a157d241c28bcb
 SHA512:
-  metadata.gz: 173ef3b72e61d34d6507d77cceeeb5d9c9bc08720d48298ee25787922e6374fa009d6f28aa12816578682767f6bff1f2a4f623ab48ab4dd47a0a1dc35ab9a10a
-  data.tar.gz: 638b6b4bdb6a68552b599e8681129dd391994881f8ae9420ea88475ca22380425675845e9692e8bcdec27e879b33cbcb6b3344f847f0121cd86148f344202599
+  metadata.gz: f7acd20881765be75187259d8273c98ed0469160c0b4dd4892942e8f71e5a19bca52fcd58f155c54180d1dca7c73335affcaab28f42549e86e800df4dca36fd3
+  data.tar.gz: 384c3b0618158ea3226935483aab834ae490a2121d4222fd155e263afd5d7e14742a7f5a288610274479967adcbe1a81a6c807936025e3dfc4905ded80153405

data/Gemfile.lock

@@ -1,49 +1,49 @@
 PATH
   remote: .
   specs:
-    ory-kratos-client (1.3.8)
+    ory-kratos-client (25.4.0)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.2)
-    byebug (11.1.3)
+    ast (2.4.3)
+    byebug (12.0.0)
     coderay (1.1.3)
-    diff-lcs (1.6.0)
-    ethon (0.16.0)
+    diff-lcs (1.6.2)
+    ethon (0.15.0)
       ffi (>= 1.15.0)
-    ffi (1.17.1)
+    ffi (1.17.2)
     jaro_winkler (1.5.6)
     method_source (1.1.0)
-    parallel (1.26.3)
-    parser (3.3.7.1)
+    parallel (1.27.0)
+    parser (3.3.10.0)
       ast (~> 2.4.1)
       racc
-    pry (0.14.2)
+    pry (0.15.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    pry-byebug (3.10.1)
-      byebug (~> 11.0)
-      pry (>= 0.13, < 0.15)
+    pry-byebug (3.11.0)
+      byebug (~> 12.0)
+      pry (>= 0.13, < 0.16)
     psych (4.0.6)
       stringio
     racc (1.8.1)
     rainbow (3.1.1)
     rake (13.0.6)
-    rspec (3.13.0)
+    rspec (3.13.2)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
       rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.3)
+    rspec-core (3.13.6)
       rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.3)
+    rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.2)
+    rspec-mocks (3.13.7)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-support (3.13.2)
+    rspec-support (3.13.6)
     rubocop (0.66.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
@@ -53,9 +53,9 @@ GEM
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 1.6)
     ruby-progressbar (1.13.0)
-    stringio (3.1.5)
-    typhoeus (1.4.1)
-      ethon (>= 0.9.0)
+    stringio (3.1.7)
+    typhoeus (1.5.0)
+      ethon (>= 0.9.0, < 0.16.0)
     unicode-display_width (1.5.0)
 
 PLATFORMS

data/README.md

@@ -7,9 +7,9 @@ This is the API specification for Ory Identities with features such as registrat
 
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: v1.3.8
-- Package version: v1.3.8
-- Generator version: 7.7.0
+- API version: v25.4.0
+- Package version: v25.4.0
+- Generator version: 7.12.0
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 
 ## Installation
@@ -25,16 +25,16 @@ gem build ory-kratos-client.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./ory-kratos-client-v1.3.8.gem
+gem install ./ory-kratos-client-v25.4.0.gem
 ```
 
-(for development, run `gem install --dev ./ory-kratos-client-v1.3.8.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ory-kratos-client-v25.4.0.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'ory-kratos-client', '~> v1.3.8'
+    gem 'ory-kratos-client', '~> v25.4.0'
 
 ### Install from Git
 
@@ -61,9 +61,9 @@ require 'ory-kratos-client'
 # Setup authorization
 OryKratosClient.configure do |config|
   # Configure API key authorization: oryAccessToken
-  config.api_key['oryAccessToken'] = 'YOUR API KEY'
+  config.api_key['Authorization'] = 'YOUR API KEY'
   # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  # config.api_key_prefix['oryAccessToken'] = 'Bearer'
+  # config.api_key_prefix['Authorization'] = 'Bearer'
 end
 
 api_instance = OryKratosClient::CourierApi.new
@@ -129,6 +129,7 @@ Class | Method | HTTP request | Description
 *OryKratosClient::IdentityApi* | [**disable_session**](docs/IdentityApi.md#disable_session) | **DELETE** /admin/sessions/{id} | Deactivate a Session
 *OryKratosClient::IdentityApi* | [**extend_session**](docs/IdentityApi.md#extend_session) | **PATCH** /admin/sessions/{id}/extend | Extend a Session
 *OryKratosClient::IdentityApi* | [**get_identity**](docs/IdentityApi.md#get_identity) | **GET** /admin/identities/{id} | Get an Identity
+*OryKratosClient::IdentityApi* | [**get_identity_by_external_id**](docs/IdentityApi.md#get_identity_by_external_id) | **GET** /admin/identities/by/external/{externalID} | Get an Identity by its External ID
 *OryKratosClient::IdentityApi* | [**get_identity_schema**](docs/IdentityApi.md#get_identity_schema) | **GET** /schemas/{id} | Get Identity JSON Schema
 *OryKratosClient::IdentityApi* | [**get_session**](docs/IdentityApi.md#get_session) | **GET** /admin/sessions/{id} | Get Session
 *OryKratosClient::IdentityApi* | [**list_identities**](docs/IdentityApi.md#list_identities) | **GET** /admin/identities | List Identities
@@ -188,6 +189,9 @@ Class | Method | HTTP request | Description
  - [OryKratosClient::IdentityWithCredentialsOidcConfigProvider](docs/IdentityWithCredentialsOidcConfigProvider.md)
  - [OryKratosClient::IdentityWithCredentialsPassword](docs/IdentityWithCredentialsPassword.md)
  - [OryKratosClient::IdentityWithCredentialsPasswordConfig](docs/IdentityWithCredentialsPasswordConfig.md)
+ - [OryKratosClient::IdentityWithCredentialsSaml](docs/IdentityWithCredentialsSaml.md)
+ - [OryKratosClient::IdentityWithCredentialsSamlConfig](docs/IdentityWithCredentialsSamlConfig.md)
+ - [OryKratosClient::IdentityWithCredentialsSamlConfigProvider](docs/IdentityWithCredentialsSamlConfigProvider.md)
  - [OryKratosClient::IsAlive200Response](docs/IsAlive200Response.md)
  - [OryKratosClient::IsReady503Response](docs/IsReady503Response.md)
  - [OryKratosClient::JsonPatch](docs/JsonPatch.md)
@@ -225,6 +229,7 @@ Class | Method | HTTP request | Description
  - [OryKratosClient::UiNode](docs/UiNode.md)
  - [OryKratosClient::UiNodeAnchorAttributes](docs/UiNodeAnchorAttributes.md)
  - [OryKratosClient::UiNodeAttributes](docs/UiNodeAttributes.md)
+ - [OryKratosClient::UiNodeDivisionAttributes](docs/UiNodeDivisionAttributes.md)
  - [OryKratosClient::UiNodeImageAttributes](docs/UiNodeImageAttributes.md)
  - [OryKratosClient::UiNodeInputAttributes](docs/UiNodeInputAttributes.md)
  - [OryKratosClient::UiNodeMeta](docs/UiNodeMeta.md)
@@ -240,6 +245,7 @@ Class | Method | HTTP request | Description
  - [OryKratosClient::UpdateLoginFlowWithOidcMethod](docs/UpdateLoginFlowWithOidcMethod.md)
  - [OryKratosClient::UpdateLoginFlowWithPasskeyMethod](docs/UpdateLoginFlowWithPasskeyMethod.md)
  - [OryKratosClient::UpdateLoginFlowWithPasswordMethod](docs/UpdateLoginFlowWithPasswordMethod.md)
+ - [OryKratosClient::UpdateLoginFlowWithSamlMethod](docs/UpdateLoginFlowWithSamlMethod.md)
  - [OryKratosClient::UpdateLoginFlowWithTotpMethod](docs/UpdateLoginFlowWithTotpMethod.md)
  - [OryKratosClient::UpdateLoginFlowWithWebAuthnMethod](docs/UpdateLoginFlowWithWebAuthnMethod.md)
  - [OryKratosClient::UpdateRecoveryFlowBody](docs/UpdateRecoveryFlowBody.md)
@@ -251,6 +257,7 @@ Class | Method | HTTP request | Description
  - [OryKratosClient::UpdateRegistrationFlowWithPasskeyMethod](docs/UpdateRegistrationFlowWithPasskeyMethod.md)
  - [OryKratosClient::UpdateRegistrationFlowWithPasswordMethod](docs/UpdateRegistrationFlowWithPasswordMethod.md)
  - [OryKratosClient::UpdateRegistrationFlowWithProfileMethod](docs/UpdateRegistrationFlowWithProfileMethod.md)
+ - [OryKratosClient::UpdateRegistrationFlowWithSamlMethod](docs/UpdateRegistrationFlowWithSamlMethod.md)
  - [OryKratosClient::UpdateRegistrationFlowWithWebAuthnMethod](docs/UpdateRegistrationFlowWithWebAuthnMethod.md)
  - [OryKratosClient::UpdateSettingsFlowBody](docs/UpdateSettingsFlowBody.md)
  - [OryKratosClient::UpdateSettingsFlowWithLookupMethod](docs/UpdateSettingsFlowWithLookupMethod.md)
@@ -258,6 +265,7 @@ Class | Method | HTTP request | Description
  - [OryKratosClient::UpdateSettingsFlowWithPasskeyMethod](docs/UpdateSettingsFlowWithPasskeyMethod.md)
  - [OryKratosClient::UpdateSettingsFlowWithPasswordMethod](docs/UpdateSettingsFlowWithPasswordMethod.md)
  - [OryKratosClient::UpdateSettingsFlowWithProfileMethod](docs/UpdateSettingsFlowWithProfileMethod.md)
+ - [OryKratosClient::UpdateSettingsFlowWithSamlMethod](docs/UpdateSettingsFlowWithSamlMethod.md)
  - [OryKratosClient::UpdateSettingsFlowWithTotpMethod](docs/UpdateSettingsFlowWithTotpMethod.md)
  - [OryKratosClient::UpdateSettingsFlowWithWebAuthnMethod](docs/UpdateSettingsFlowWithWebAuthnMethod.md)
  - [OryKratosClient::UpdateVerificationFlowBody](docs/UpdateVerificationFlowBody.md)

data/docs/CourierApi.md

@@ -24,9 +24,9 @@ require 'ory-kratos-client'
 # setup authorization
 OryKratosClient.configure do |config|
   # Configure API key authorization: oryAccessToken
-  config.api_key['oryAccessToken'] = 'YOUR API KEY'
+  config.api_key['Authorization'] = 'YOUR API KEY'
   # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  # config.api_key_prefix['oryAccessToken'] = 'Bearer'
+  # config.api_key_prefix['Authorization'] = 'Bearer'
 end
 
 api_instance = OryKratosClient::CourierApi.new
@@ -95,9 +95,9 @@ require 'ory-kratos-client'
 # setup authorization
 OryKratosClient.configure do |config|
   # Configure API key authorization: oryAccessToken
-  config.api_key['oryAccessToken'] = 'YOUR API KEY'
+  config.api_key['Authorization'] = 'YOUR API KEY'
   # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  # config.api_key_prefix['oryAccessToken'] = 'Bearer'
+  # config.api_key_prefix['Authorization'] = 'Bearer'
 end
 
 api_instance = OryKratosClient::CourierApi.new

data/docs/CreateIdentityBody.md

@@ -5,6 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **credentials** | [**IdentityWithCredentials**](IdentityWithCredentials.md) |  | [optional] |
+| **external_id** | **String** | ExternalID is an optional external ID of the identity. This is used to link the identity to an external system. If set, the external ID must be unique across all identities. | [optional] |
 | **metadata_admin** | **Object** | Store metadata about the user which is only accessible through admin APIs such as `GET /admin/identities/<id>`. | [optional] |
 | **metadata_public** | **Object** | Store metadata about the identity which the identity itself can see when calling for example the session endpoint. Do not store sensitive information (e.g. credit score) about the identity in this field. | [optional] |
 | **organization_id** | **String** |  | [optional] |
@@ -21,6 +22,7 @@ require 'ory-kratos-client'
 
 instance = OryKratosClient::CreateIdentityBody.new(
   credentials: null,
+  external_id: null,
   metadata_admin: null,
   metadata_public: null,
   organization_id: null,

data/docs/FrontendApi.md

@@ -60,7 +60,8 @@ opts = {
   cookie: 'cookie_example', # String | 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.
   login_challenge: 'login_challenge_example', # String | 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`).
   organization: 'organization_example', # String | An optional organization ID that should be used for logging this user in. This parameter is only effective in the Ory Network.
-  via: 'via_example' # String | 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.
+  via: 'via_example', # String | 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.
+  identity_schema: 'identity_schema_example' # String | An optional identity schema to use for the login flow.
 }
 
 begin
@@ -101,6 +102,7 @@ end
 | **login_challenge** | **String** | 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`). | [optional] |
 | **organization** | **String** | An optional organization ID that should be used for logging this user in. This parameter is only effective in the Ory Network. | [optional] |
 | **via** | **String** | 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. | [optional] |
+| **identity_schema** | **String** | An optional identity schema to use for the login flow. | [optional] |
 
 ### Return type
 
@@ -269,7 +271,8 @@ opts = {
   return_to: 'return_to_example', # String | The URL to return the browser to after the flow was completed.
   login_challenge: 'login_challenge_example', # String | 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.
   after_verification_return_to: 'after_verification_return_to_example', # String | 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.
-  organization: 'organization_example' # String | An optional organization ID that should be used to register this user. This parameter is only effective in the Ory Network.
+  organization: 'organization_example', # String | An optional organization ID that should be used to register this user. This parameter is only effective in the Ory Network.
+  identity_schema: 'identity_schema_example' # String | An optional identity schema to use for the registration flow.
 }
 
 begin
@@ -307,6 +310,7 @@ end
 | **login_challenge** | **String** | 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. | [optional] |
 | **after_verification_return_to** | **String** | 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. | [optional] |
 | **organization** | **String** | An optional organization ID that should be used to register this user. This parameter is only effective in the Ory Network. | [optional] |
+| **identity_schema** | **String** | An optional identity schema to use for the registration flow. | [optional] |
 
 ### Return type
 
@@ -539,7 +543,8 @@ opts = {
   return_session_token_exchange_code: true, # 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.
   return_to: 'return_to_example', # String | The URL to return the browser to after the flow was completed.
   organization: 'organization_example', # String | An optional organization ID that should be used for logging this user in. This parameter is only effective in the Ory Network.
-  via: 'via_example' # String | 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.
+  via: 'via_example', # String | 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.
+  identity_schema: 'identity_schema_example' # String | An optional identity schema to use for the login flow.
 }
 
 begin
@@ -580,6 +585,7 @@ end
 | **return_to** | **String** | The URL to return the browser to after the flow was completed. | [optional] |
 | **organization** | **String** | An optional organization ID that should be used for logging this user in. This parameter is only effective in the Ory Network. | [optional] |
 | **via** | **String** | 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. | [optional] |
+| **identity_schema** | **String** | An optional identity schema to use for the login flow. | [optional] |
 
 ### Return type
 
@@ -674,7 +680,8 @@ api_instance = OryKratosClient::FrontendApi.new
 opts = {
   return_session_token_exchange_code: true, # 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.
   return_to: 'return_to_example', # String | The URL to return the browser to after the flow was completed.
-  organization: 'organization_example' # String | An optional organization ID that should be used to register this user. This parameter is only effective in the Ory Network.
+  organization: 'organization_example', # String | An optional organization ID that should be used to register this user. This parameter is only effective in the Ory Network.
+  identity_schema: 'identity_schema_example' # String | An optional identity schema to use for the registration flow.
 }
 
 begin
@@ -711,6 +718,7 @@ end
 | **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. | [optional] |
 | **return_to** | **String** | The URL to return the browser to after the flow was completed. | [optional] |
 | **organization** | **String** | An optional organization ID that should be used to register this user. This parameter is only effective in the Ory Network. | [optional] |
+| **identity_schema** | **String** | An optional identity schema to use for the registration flow. | [optional] |
 
 ### Return type
 

data/docs/Identity.md

@@ -6,6 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **created_at** | **Time** | CreatedAt is a helper struct field for gobuffalo.pop. | [optional] |
 | **credentials** | [**Hash<String, IdentityCredentials>**](IdentityCredentials.md) | Credentials represents all credentials that can be used for authenticating this identity. | [optional] |
+| **external_id** | **String** | ExternalID is an optional external ID of the identity. This is used to link the identity to an external system. If set, the external ID must be unique across all identities. | [optional] |
 | **id** | **String** | ID is the identity's unique identifier.  The Identity ID can not be changed and can not be chosen. This ensures future compatibility and optimization for distributed stores such as CockroachDB. |  |
 | **metadata_admin** | **Object** | NullJSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger and is NULLable- | [optional] |
 | **metadata_public** | **Object** | NullJSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger and is NULLable- | [optional] |
@@ -27,6 +28,7 @@ require 'ory-kratos-client'
 instance = OryKratosClient::Identity.new(
   created_at: null,
   credentials: null,
+  external_id: null,
   id: null,
   metadata_admin: null,
   metadata_public: null,