ory-kratos-client 1.0.0 → 1.1.0

data/docs/IdentityApi.md

@@ -266,6 +266,7 @@ end
 
 api_instance = OryKratosClient::IdentityApi.new
 opts = {
+  return_to: 'return_to_example', # String | 
   create_recovery_link_for_identity_body: OryKratosClient::CreateRecoveryLinkForIdentityBody.new({identity_id: 'identity_id_example'}) # CreateRecoveryLinkForIdentityBody | 
 }
 
@@ -300,6 +301,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
+| **return_to** | **String** |  | [optional] |
 | **create_recovery_link_for_identity_body** | [**CreateRecoveryLinkForIdentityBody**](CreateRecoveryLinkForIdentityBody.md) |  | [optional] |
 
 ### Return type
@@ -409,7 +411,7 @@ end
 
 api_instance = OryKratosClient::IdentityApi.new
 id = 'id_example' # String | ID is the identity's ID.
-type = 'totp' # String | Type is the credential's Type. One of totp, webauthn, lookup
+type = 'password' # String | Type is the type of credentials to be deleted. password CredentialsTypePassword oidc CredentialsTypeOIDC totp CredentialsTypeTOTP lookup_secret CredentialsTypeLookup webauthn CredentialsTypeWebAuthn code CredentialsTypeCodeAuth link_recovery CredentialsTypeRecoveryLink  CredentialsTypeRecoveryLink is a special credential type linked to the link strategy (recovery flow).  It is not used within the credentials object itself. code_recovery CredentialsTypeRecoveryCode
 
 begin
   # Delete a credential for a specific identity
@@ -442,7 +444,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** | ID is the identity's ID. |  |
-| **type** | **String** | Type is the credential's Type. One of totp, webauthn, lookup |  |
+| **type** | **String** | Type is the type of credentials to be deleted. password CredentialsTypePassword oidc CredentialsTypeOIDC totp CredentialsTypeTOTP lookup_secret CredentialsTypeLookup webauthn CredentialsTypeWebAuthn code CredentialsTypeCodeAuth link_recovery CredentialsTypeRecoveryLink  CredentialsTypeRecoveryLink is a special credential type linked to the link strategy (recovery flow).  It is not used within the credentials object itself. code_recovery CredentialsTypeRecoveryCode |  |
 
 ### Return type
 
@@ -906,9 +908,14 @@ end
 
 api_instance = OryKratosClient::IdentityApi.new
 opts = {
-  per_page: 789, # Integer | Items per Page  This is the number of items per page.
-  page: 789, # Integer | Pagination Page  This value is currently an integer, but it is not sequential. The value is not the page number, but a reference. The next page can be any number and some numbers might return an empty list.  For example, page 2 might not follow after page 1. And even if page 3 and 5 exist, but page 4 might not exist.
-  credentials_identifier: 'credentials_identifier_example' # String | CredentialsIdentifier is the identifier (username, email) of the credentials to look up.
+  per_page: 789, # Integer | Deprecated Items per Page  DEPRECATED: Please use `page_token` instead. This parameter will be removed in the future.  This is the number of items per page.
+  page: 789, # Integer | Deprecated Pagination Page  DEPRECATED: Please use `page_token` instead. This parameter will be removed in the future.  This value is currently an integer, but it is not sequential. The value is not the page number, but a reference. The next page can be any number and some numbers might return an empty list.  For example, page 2 might not follow after page 1. And even if page 3 and 5 exist, but page 4 might not exist. The first page can be retrieved by omitting this parameter. Following page pointers will be returned in the `Link` header.
+  page_size: 789, # Integer | Page Size  This is the number of items per page to return. For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination).
+  page_token: 'page_token_example', # String | Next Page Token  The next page token. For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination).
+  consistency: 'consistency_example', # String | Read Consistency Level (preview)  The read consistency level determines the consistency guarantee for reads:  strong (slow): The read is guaranteed to return the most recent data committed at the start of the read. eventual (very fast): The result will return data that is about 4.8 seconds old.  The default consistency guarantee can be changed in the Ory Network Console or using the Ory CLI with `ory patch project --replace '/previews/default_read_consistency_level=\"strong\"'`.  Setting the default consistency level to `eventual` may cause regressions in the future as we add consistency controls to more APIs. Currently, the following APIs will be affected by this setting:  `GET /admin/identities`  This feature is in preview and only available in Ory Network.  ConsistencyLevelUnset  ConsistencyLevelUnset is the unset / default consistency level. strong ConsistencyLevelStrong  ConsistencyLevelStrong is the strong consistency level. eventual ConsistencyLevelEventual  ConsistencyLevelEventual is the eventual consistency level using follower read timestamps.
+  ids: ['inner_example'], # Array<String> | List of ids used to filter identities. If this list is empty, then no filter will be applied.
+  credentials_identifier: 'credentials_identifier_example', # String | CredentialsIdentifier is the identifier (username, email) of the credentials to look up using exact match. Only one of CredentialsIdentifier and CredentialsIdentifierSimilar can be used.
+  preview_credentials_identifier_similar: 'preview_credentials_identifier_similar_example' # String | This is an EXPERIMENTAL parameter that WILL CHANGE. Do NOT rely on consistent, deterministic behavior. THIS PARAMETER WILL BE REMOVED IN AN UPCOMING RELEASE WITHOUT ANY MIGRATION PATH.  CredentialsIdentifierSimilar is the (partial) identifier (username, email) of the credentials to look up using similarity search. Only one of CredentialsIdentifier and CredentialsIdentifierSimilar can be used.
 }
 
 begin
@@ -942,9 +949,14 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **per_page** | **Integer** | Items per Page  This is the number of items per page. | [optional][default to 250] |
-| **page** | **Integer** | Pagination Page  This value is currently an integer, but it is not sequential. The value is not the page number, but a reference. The next page can be any number and some numbers might return an empty list.  For example, page 2 might not follow after page 1. And even if page 3 and 5 exist, but page 4 might not exist. | [optional][default to 1] |
-| **credentials_identifier** | **String** | CredentialsIdentifier is the identifier (username, email) of the credentials to look up. | [optional] |
+| **per_page** | **Integer** | Deprecated Items per Page  DEPRECATED: Please use &#x60;page_token&#x60; instead. This parameter will be removed in the future.  This is the number of items per page. | [optional][default to 250] |
+| **page** | **Integer** | Deprecated Pagination Page  DEPRECATED: Please use &#x60;page_token&#x60; instead. This parameter will be removed in the future.  This value is currently an integer, but it is not sequential. The value is not the page number, but a reference. The next page can be any number and some numbers might return an empty list.  For example, page 2 might not follow after page 1. And even if page 3 and 5 exist, but page 4 might not exist. The first page can be retrieved by omitting this parameter. Following page pointers will be returned in the &#x60;Link&#x60; header. | [optional] |
+| **page_size** | **Integer** | Page Size  This is the number of items per page to return. For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination). | [optional][default to 250] |
+| **page_token** | **String** | Next Page Token  The next page token. For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination). | [optional][default to &#39;1&#39;] |
+| **consistency** | **String** | Read Consistency Level (preview)  The read consistency level determines the consistency guarantee for reads:  strong (slow): The read is guaranteed to return the most recent data committed at the start of the read. eventual (very fast): The result will return data that is about 4.8 seconds old.  The default consistency guarantee can be changed in the Ory Network Console or using the Ory CLI with &#x60;ory patch project --replace &#39;/previews/default_read_consistency_level&#x3D;\&quot;strong\&quot;&#39;&#x60;.  Setting the default consistency level to &#x60;eventual&#x60; may cause regressions in the future as we add consistency controls to more APIs. Currently, the following APIs will be affected by this setting:  &#x60;GET /admin/identities&#x60;  This feature is in preview and only available in Ory Network.  ConsistencyLevelUnset  ConsistencyLevelUnset is the unset / default consistency level. strong ConsistencyLevelStrong  ConsistencyLevelStrong is the strong consistency level. eventual ConsistencyLevelEventual  ConsistencyLevelEventual is the eventual consistency level using follower read timestamps. | [optional] |
+| **ids** | [**Array&lt;String&gt;**](String.md) | List of ids used to filter identities. If this list is empty, then no filter will be applied. | [optional] |
+| **credentials_identifier** | **String** | CredentialsIdentifier is the identifier (username, email) of the credentials to look up using exact match. Only one of CredentialsIdentifier and CredentialsIdentifierSimilar can be used. | [optional] |
+| **preview_credentials_identifier_similar** | **String** | This is an EXPERIMENTAL parameter that WILL CHANGE. Do NOT rely on consistent, deterministic behavior. THIS PARAMETER WILL BE REMOVED IN AN UPCOMING RELEASE WITHOUT ANY MIGRATION PATH.  CredentialsIdentifierSimilar is the (partial) identifier (username, email) of the credentials to look up using similarity search. Only one of CredentialsIdentifier and CredentialsIdentifierSimilar can be used. | [optional] |
 
 ### Return type
 
@@ -976,8 +988,10 @@ require 'ory-kratos-client'
 
 api_instance = OryKratosClient::IdentityApi.new
 opts = {
-  per_page: 789, # Integer | Items per Page  This is the number of items per page.
-  page: 789 # Integer | Pagination Page  This value is currently an integer, but it is not sequential. The value is not the page number, but a reference. The next page can be any number and some numbers might return an empty list.  For example, page 2 might not follow after page 1. And even if page 3 and 5 exist, but page 4 might not exist.
+  per_page: 789, # Integer | Deprecated Items per Page  DEPRECATED: Please use `page_token` instead. This parameter will be removed in the future.  This is the number of items per page.
+  page: 789, # Integer | Deprecated Pagination Page  DEPRECATED: Please use `page_token` instead. This parameter will be removed in the future.  This value is currently an integer, but it is not sequential. The value is not the page number, but a reference. The next page can be any number and some numbers might return an empty list.  For example, page 2 might not follow after page 1. And even if page 3 and 5 exist, but page 4 might not exist. The first page can be retrieved by omitting this parameter. Following page pointers will be returned in the `Link` header.
+  page_size: 789, # Integer | Page Size  This is the number of items per page to return. For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination).
+  page_token: 'page_token_example' # String | Next Page Token  The next page token. For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination).
 }
 
 begin
@@ -1011,8 +1025,10 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **per_page** | **Integer** | Items per Page  This is the number of items per page. | [optional][default to 250] |
-| **page** | **Integer** | Pagination Page  This value is currently an integer, but it is not sequential. The value is not the page number, but a reference. The next page can be any number and some numbers might return an empty list.  For example, page 2 might not follow after page 1. And even if page 3 and 5 exist, but page 4 might not exist. | [optional][default to 1] |
+| **per_page** | **Integer** | Deprecated Items per Page  DEPRECATED: Please use &#x60;page_token&#x60; instead. This parameter will be removed in the future.  This is the number of items per page. | [optional][default to 250] |
+| **page** | **Integer** | Deprecated Pagination Page  DEPRECATED: Please use &#x60;page_token&#x60; instead. This parameter will be removed in the future.  This value is currently an integer, but it is not sequential. The value is not the page number, but a reference. The next page can be any number and some numbers might return an empty list.  For example, page 2 might not follow after page 1. And even if page 3 and 5 exist, but page 4 might not exist. The first page can be retrieved by omitting this parameter. Following page pointers will be returned in the &#x60;Link&#x60; header. | [optional] |
+| **page_size** | **Integer** | Page Size  This is the number of items per page to return. For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination). | [optional][default to 250] |
+| **page_token** | **String** | Next Page Token  The next page token. For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination). | [optional][default to &#39;1&#39;] |
 
 ### Return type
 
@@ -1052,8 +1068,10 @@ end
 api_instance = OryKratosClient::IdentityApi.new
 id = 'id_example' # String | ID is the identity's ID.
 opts = {
-  per_page: 789, # Integer | Items per Page  This is the number of items per page.
-  page: 789, # Integer | Pagination Page  This value is currently an integer, but it is not sequential. The value is not the page number, but a reference. The next page can be any number and some numbers might return an empty list.  For example, page 2 might not follow after page 1. And even if page 3 and 5 exist, but page 4 might not exist.
+  per_page: 789, # Integer | Deprecated Items per Page  DEPRECATED: Please use `page_token` instead. This parameter will be removed in the future.  This is the number of items per page.
+  page: 789, # Integer | Deprecated Pagination Page  DEPRECATED: Please use `page_token` instead. This parameter will be removed in the future.  This value is currently an integer, but it is not sequential. The value is not the page number, but a reference. The next page can be any number and some numbers might return an empty list.  For example, page 2 might not follow after page 1. And even if page 3 and 5 exist, but page 4 might not exist. The first page can be retrieved by omitting this parameter. Following page pointers will be returned in the `Link` header.
+  page_size: 789, # Integer | Page Size  This is the number of items per page to return. For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination).
+  page_token: 'page_token_example', # String | Next Page Token  The next page token. For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination).
   active: true # Boolean | Active is a boolean flag that filters out sessions based on the state. If no value is provided, all sessions are returned.
 }
 
@@ -1089,8 +1107,10 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** | ID is the identity&#39;s ID. |  |
-| **per_page** | **Integer** | Items per Page  This is the number of items per page. | [optional][default to 250] |
-| **page** | **Integer** | Pagination Page  This value is currently an integer, but it is not sequential. The value is not the page number, but a reference. The next page can be any number and some numbers might return an empty list.  For example, page 2 might not follow after page 1. And even if page 3 and 5 exist, but page 4 might not exist. | [optional][default to 1] |
+| **per_page** | **Integer** | Deprecated Items per Page  DEPRECATED: Please use &#x60;page_token&#x60; instead. This parameter will be removed in the future.  This is the number of items per page. | [optional][default to 250] |
+| **page** | **Integer** | Deprecated Pagination Page  DEPRECATED: Please use &#x60;page_token&#x60; instead. This parameter will be removed in the future.  This value is currently an integer, but it is not sequential. The value is not the page number, but a reference. The next page can be any number and some numbers might return an empty list.  For example, page 2 might not follow after page 1. And even if page 3 and 5 exist, but page 4 might not exist. The first page can be retrieved by omitting this parameter. Following page pointers will be returned in the &#x60;Link&#x60; header. | [optional] |
+| **page_size** | **Integer** | Page Size  This is the number of items per page to return. For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination). | [optional][default to 250] |
+| **page_token** | **String** | Next Page Token  The next page token. For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination). | [optional][default to &#39;1&#39;] |
 | **active** | **Boolean** | Active is a boolean flag that filters out sessions based on the state. If no value is provided, all sessions are returned. | [optional] |
 
 ### Return type
@@ -1285,7 +1305,7 @@ end
 api_instance = OryKratosClient::IdentityApi.new
 id = 'id_example' # String | ID must be set to the ID of identity you want to update
 opts = {
-  update_identity_body: OryKratosClient::UpdateIdentityBody.new({schema_id: 'schema_id_example', state: OryKratosClient::IdentityState::ACTIVE, traits: 3.56}) # UpdateIdentityBody | 
+  update_identity_body: OryKratosClient::UpdateIdentityBody.new({schema_id: 'schema_id_example', state: 'active', traits: 3.56}) # UpdateIdentityBody | 
 }
 
 begin

data/docs/IdentityCredentials.md

@@ -7,7 +7,7 @@
 | **config** | **Object** |  | [optional] |
 | **created_at** | **Time** | CreatedAt is a helper struct field for gobuffalo.pop. | [optional] |
 | **identifiers** | **Array<String>** | Identifiers represents a list of unique identifiers this credential type matches. | [optional] |
-| **type** | [**IdentityCredentialsType**](IdentityCredentialsType.md) |  | [optional] |
+| **type** | **String** | Type discriminates between different types of credentials. password CredentialsTypePassword oidc CredentialsTypeOIDC totp CredentialsTypeTOTP lookup_secret CredentialsTypeLookup webauthn CredentialsTypeWebAuthn code CredentialsTypeCodeAuth link_recovery CredentialsTypeRecoveryLink  CredentialsTypeRecoveryLink is a special credential type linked to the link strategy (recovery flow).  It is not used within the credentials object itself. code_recovery CredentialsTypeRecoveryCode | [optional] |
 | **updated_at** | **Time** | UpdatedAt is a helper struct field for gobuffalo.pop. | [optional] |
 | **version** | **Integer** | Version refers to the version of the credential. Useful when changing the config schema. | [optional] |
 

data/docs/IdentityCredentialsCode.md

@@ -0,0 +1,20 @@
+# OryKratosClient::IdentityCredentialsCode
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **address_type** | **String** | The type of the address for this code | [optional] |
+| **used_at** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ory-kratos-client'
+
+instance = OryKratosClient::IdentityCredentialsCode.new(
+  address_type: null,
+  used_at: null
+)
+```
+

data/docs/IdentityCredentialsOidcProvider.md

@@ -7,6 +7,7 @@
 | **initial_access_token** | **String** |  | [optional] |
 | **initial_id_token** | **String** |  | [optional] |
 | **initial_refresh_token** | **String** |  | [optional] |
+| **organization** | **String** |  | [optional] |
 | **provider** | **String** |  | [optional] |
 | **subject** | **String** |  | [optional] |
 
@@ -19,6 +20,7 @@ instance = OryKratosClient::IdentityCredentialsOidcProvider.new(
   initial_access_token: null,
   initial_id_token: null,
   initial_refresh_token: null,
+  organization: null,
   provider: null,
   subject: null
 )

data/docs/IdentityWithCredentialsPasswordConfig.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **hashed_password** | **String** | The hashed password in [PHC format]( https://www.ory.sh/docs/kratos/concepts/credentials/username-email-password#hashed-password-format) | [optional] |
+| **hashed_password** | **String** | The hashed password in [PHC format](https://www.ory.sh/docs/kratos/manage-identities/import-user-accounts-identities#hashed-passwords) | [optional] |
 | **password** | **String** | The password in plain text if no hash is available. | [optional] |
 
 ## Example

data/docs/LoginFlow.md

@@ -4,18 +4,20 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **active** | [**IdentityCredentialsType**](IdentityCredentialsType.md) |  | [optional] |
+| **active** | **String** | The active login method  If set contains the login method used. If the flow is new, it is unset. password CredentialsTypePassword oidc CredentialsTypeOIDC totp CredentialsTypeTOTP lookup_secret CredentialsTypeLookup webauthn CredentialsTypeWebAuthn code CredentialsTypeCodeAuth link_recovery CredentialsTypeRecoveryLink  CredentialsTypeRecoveryLink is a special credential type linked to the link strategy (recovery flow).  It is not used within the credentials object itself. code_recovery CredentialsTypeRecoveryCode | [optional] |
 | **created_at** | **Time** | CreatedAt is a helper struct field for gobuffalo.pop. | [optional] |
 | **expires_at** | **Time** | ExpiresAt is the time (UTC) when the flow expires. If the user still wishes to log in, a new flow has to be initiated. |  |
 | **id** | **String** | ID represents the flow's unique ID. When performing the login flow, this represents the id in the login UI's query parameter: http://<selfservice.flows.login.ui_url>/?flow=<flow_id> |  |
 | **issued_at** | **Time** | IssuedAt is the time (UTC) when the flow started. |  |
 | **oauth2_login_challenge** | **String** | Ory OAuth 2.0 Login Challenge.  This value is set using the `login_challenge` query parameter of the registration and login endpoints. If set will cooperate with Ory OAuth2 and OpenID to act as an OAuth2 server / OpenID Provider. | [optional] |
 | **oauth2_login_request** | [**OAuth2LoginRequest**](OAuth2LoginRequest.md) |  | [optional] |
+| **organization_id** | **String** |  | [optional] |
 | **refresh** | **Boolean** | Refresh stores whether this login flow should enforce re-authentication. | [optional] |
 | **request_url** | **String** | RequestURL is the initial URL that was requested from Ory Kratos. It can be used to forward information contained in the URL's path or query for example. |  |
 | **requested_aal** | [**AuthenticatorAssuranceLevel**](AuthenticatorAssuranceLevel.md) |  | [optional] |
 | **return_to** | **String** | ReturnTo contains the requested return_to URL. | [optional] |
 | **session_token_exchange_code** | **String** | SessionTokenExchangeCode holds the secret code that the client can use to retrieve a session token after the login flow has been completed. This is only set if the client has requested a session token exchange code, and if the flow is of type \"api\", and only on creating the login flow. | [optional] |
+| **state** | **Object** | State represents the state of this request:  choose_method: ask the user to choose a method to sign in with sent_email: the email has been sent to the user passed_challenge: the request was successful and the login challenge was passed. |  |
 | **type** | **String** | The flow type can either be `api` or `browser`. |  |
 | **ui** | [**UiContainer**](UiContainer.md) |  |  |
 | **updated_at** | **Time** | UpdatedAt is a helper struct field for gobuffalo.pop. | [optional] |
@@ -33,11 +35,13 @@ instance = OryKratosClient::LoginFlow.new(
   issued_at: null,
   oauth2_login_challenge: null,
   oauth2_login_request: null,
+  organization_id: null,
   refresh: null,
   request_url: null,
   requested_aal: null,
   return_to: null,
   session_token_exchange_code: null,
+  state: null,
   type: null,
   ui: null,
   updated_at: null

data/docs/LoginFlowState.md

@@ -0,0 +1,15 @@
+# OryKratosClient::LoginFlowState
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'ory-kratos-client'
+
+instance = OryKratosClient::LoginFlowState.new()
+```
+

data/docs/Message.md

@@ -5,6 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **body** | **String** |  |  |
+| **channel** | **String** |  | [optional] |
 | **created_at** | **Time** | CreatedAt is a helper struct field for gobuffalo.pop. |  |
 | **dispatches** | [**Array<MessageDispatch>**](MessageDispatch.md) | Dispatches store information about the attempts of delivering a message May contain an error if any happened, or just the `success` state. | [optional] |
 | **id** | **String** |  |  |
@@ -12,7 +13,7 @@
 | **send_count** | **Integer** |  |  |
 | **status** | [**CourierMessageStatus**](CourierMessageStatus.md) |  |  |
 | **subject** | **String** |  |  |
-| **template_type** | **String** |  recovery_invalid TypeRecoveryInvalid recovery_valid TypeRecoveryValid recovery_code_invalid TypeRecoveryCodeInvalid recovery_code_valid TypeRecoveryCodeValid verification_invalid TypeVerificationInvalid verification_valid TypeVerificationValid verification_code_invalid TypeVerificationCodeInvalid verification_code_valid TypeVerificationCodeValid otp TypeOTP stub TypeTestStub |  |
+| **template_type** | **String** |  recovery_invalid TypeRecoveryInvalid recovery_valid TypeRecoveryValid recovery_code_invalid TypeRecoveryCodeInvalid recovery_code_valid TypeRecoveryCodeValid verification_invalid TypeVerificationInvalid verification_valid TypeVerificationValid verification_code_invalid TypeVerificationCodeInvalid verification_code_valid TypeVerificationCodeValid stub TypeTestStub login_code_valid TypeLoginCodeValid registration_code_valid TypeRegistrationCodeValid |  |
 | **type** | [**CourierMessageType**](CourierMessageType.md) |  |  |
 | **updated_at** | **Time** | UpdatedAt is a helper struct field for gobuffalo.pop. |  |
 
@@ -23,6 +24,7 @@ require 'ory-kratos-client'
 
 instance = OryKratosClient::Message.new(
   body: null,
+  channel: null,
   created_at: null,
   dispatches: null,
   id: null,

data/docs/OAuth2Client.md

@@ -4,6 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
+| **access_token_strategy** | **String** | OAuth 2.0 Access Token Strategy  AccessTokenStrategy is the strategy used to generate access tokens. Valid options are `jwt` and `opaque`. `jwt` is a bad idea, see https://www.ory.sh/docs/hydra/advanced#json-web-tokens Setting the stragegy here overrides the global setting in `strategies.access_token`. | [optional] |
 | **allowed_cors_origins** | **Array<String>** |  | [optional] |
 | **audience** | **Array<String>** |  | [optional] |
 | **authorization_code_grant_access_token_lifespan** | **String** | Specify a time duration in milliseconds, seconds, minutes, hours. | [optional] |
@@ -12,7 +13,7 @@
 | **backchannel_logout_session_required** | **Boolean** | OpenID Connect Back-Channel Logout Session Required  Boolean value specifying whether the RP requires that a sid (session ID) Claim be included in the Logout Token to identify the RP session with the OP when the backchannel_logout_uri is used. If omitted, the default value is false. | [optional] |
 | **backchannel_logout_uri** | **String** | OpenID Connect Back-Channel Logout URI  RP URL that will cause the RP to log itself out when sent a Logout Token by the OP. | [optional] |
 | **client_credentials_grant_access_token_lifespan** | **String** | Specify a time duration in milliseconds, seconds, minutes, hours. | [optional] |
-| **client_id** | **String** | OAuth 2.0 Client ID  The ID is autogenerated and immutable. | [optional] |
+| **client_id** | **String** | OAuth 2.0 Client ID  The ID is immutable. If no ID is provided, a UUID4 will be generated. | [optional] |
 | **client_name** | **String** | OAuth 2.0 Client Name  The human-readable name of the client to be presented to the end-user during authorization. | [optional] |
 | **client_secret** | **String** | OAuth 2.0 Client Secret  The secret will be included in the create request as cleartext, and then never again. The secret is kept in hashed format and is not recoverable once lost. | [optional] |
 | **client_secret_expires_at** | **Integer** | OAuth 2.0 Client Secret Expires At  The field is currently not supported and its value is always 0. | [optional] |
@@ -43,8 +44,10 @@
 | **response_types** | **Array<String>** |  | [optional] |
 | **scope** | **String** | OAuth 2.0 Client Scope  Scope is a string containing a space-separated list of scope values (as described in Section 3.3 of OAuth 2.0 [RFC6749]) that the client can use when requesting access tokens. | [optional] |
 | **sector_identifier_uri** | **String** | OpenID Connect Sector Identifier URI  URL using the https scheme to be used in calculating Pseudonymous Identifiers by the OP. The URL references a file with a single JSON array of redirect_uri values. | [optional] |
+| **skip_consent** | **Boolean** | SkipConsent skips the consent screen for this client. This field can only be set from the admin API. | [optional] |
+| **skip_logout_consent** | **Boolean** | SkipLogoutConsent skips the logout consent screen for this client. This field can only be set from the admin API. | [optional] |
 | **subject_type** | **String** | OpenID Connect Subject Type  The `subject_types_supported` Discovery parameter contains a list of the supported subject_type values for this server. Valid types include `pairwise` and `public`. | [optional] |
-| **token_endpoint_auth_method** | **String** | OAuth 2.0 Token Endpoint Authentication Method  Requested Client Authentication method for the Token Endpoint. The options are:  `client_secret_post`: (default) Send `client_id` and `client_secret` as `application/x-www-form-urlencoded` in the HTTP body. `client_secret_basic`: Send `client_id` and `client_secret` as `application/x-www-form-urlencoded` encoded in the HTTP Authorization header. `private_key_jwt`: Use JSON Web Tokens to authenticate the client. `none`: Used for public clients (native apps, mobile apps) which can not have secrets. | [optional] |
+| **token_endpoint_auth_method** | **String** | OAuth 2.0 Token Endpoint Authentication Method  Requested Client Authentication method for the Token Endpoint. The options are:  `client_secret_basic`: (default) Send `client_id` and `client_secret` as `application/x-www-form-urlencoded` encoded in the HTTP Authorization header. `client_secret_post`: Send `client_id` and `client_secret` as `application/x-www-form-urlencoded` in the HTTP body. `private_key_jwt`: Use JSON Web Tokens to authenticate the client. `none`: Used for public clients (native apps, mobile apps) which can not have secrets. | [optional] |
 | **token_endpoint_auth_signing_alg** | **String** | OAuth 2.0 Token Endpoint Signing Algorithm  Requested Client Authentication signing algorithm for the Token Endpoint. | [optional] |
 | **tos_uri** | **String** | OAuth 2.0 Client Terms of Service URI  A URL string pointing to a human-readable terms of service document for the client that describes a contractual relationship between the end-user and the client that the end-user accepts when authorizing the client. | [optional] |
 | **updated_at** | **Time** | OAuth 2.0 Client Last Update Date  UpdatedAt returns the timestamp of the last update. | [optional] |
@@ -56,6 +59,7 @@
 require 'ory-kratos-client'
 
 instance = OryKratosClient::OAuth2Client.new(
+  access_token_strategy: null,
   allowed_cors_origins: null,
   audience: null,
   authorization_code_grant_access_token_lifespan: null,
@@ -95,6 +99,8 @@ instance = OryKratosClient::OAuth2Client.new(
   response_types: null,
   scope: null,
   sector_identifier_uri: null,
+  skip_consent: null,
+  skip_logout_consent: null,
   subject_type: null,
   token_endpoint_auth_method: null,
   token_endpoint_auth_signing_alg: null,

data/docs/RecoveryCodeForIdentity.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **expires_at** | **Time** | Expires At is the timestamp of when the recovery flow expires  The timestamp when the recovery link expires. | [optional] |
+| **expires_at** | **Time** | Expires At is the timestamp of when the recovery flow expires  The timestamp when the recovery code expires. | [optional] |
 | **recovery_code** | **String** | RecoveryCode is the code that can be used to recover the account |  |
 | **recovery_link** | **String** | RecoveryLink with flow  This link opens the recovery UI with an empty `code` field. |  |
 

data/docs/RecoveryFlow.md

@@ -5,12 +5,13 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **active** | **String** | Active, if set, contains the recovery method that is being used. It is initially not set. | [optional] |
+| **continue_with** | [**Array<ContinueWith>**](ContinueWith.md) | Contains possible actions that could follow this flow | [optional] |
 | **expires_at** | **Time** | ExpiresAt is the time (UTC) when the request expires. If the user still wishes to update the setting, a new request has to be initiated. |  |
 | **id** | **String** | ID represents the request's unique ID. When performing the recovery flow, this represents the id in the recovery ui's query parameter: http://<selfservice.flows.recovery.ui_url>?request=<id> |  |
 | **issued_at** | **Time** | IssuedAt is the time (UTC) when the request occurred. |  |
 | **request_url** | **String** | RequestURL is the initial URL that was requested from Ory Kratos. It can be used to forward information contained in the URL's path or query for example. |  |
 | **return_to** | **String** | ReturnTo contains the requested return_to URL. | [optional] |
-| **state** | [**RecoveryFlowState**](RecoveryFlowState.md) |  |  |
+| **state** | **Object** | State represents the state of this request:  choose_method: ask the user to choose a method (e.g. recover account via email) sent_email: the email has been sent to the user passed_challenge: the request was successful and the recovery challenge was passed. |  |
 | **type** | **String** | The flow type can either be `api` or `browser`. |  |
 | **ui** | [**UiContainer**](UiContainer.md) |  |  |
 
@@ -21,6 +22,7 @@ require 'ory-kratos-client'
 
 instance = OryKratosClient::RecoveryFlow.new(
   active: null,
+  continue_with: null,
   expires_at: null,
   id: null,
   issued_at: null,

data/docs/RegistrationFlow.md

@@ -4,15 +4,17 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **active** | [**IdentityCredentialsType**](IdentityCredentialsType.md) |  | [optional] |
+| **active** | **String** | Active, if set, contains the registration method that is being used. It is initially not set. password CredentialsTypePassword oidc CredentialsTypeOIDC totp CredentialsTypeTOTP lookup_secret CredentialsTypeLookup webauthn CredentialsTypeWebAuthn code CredentialsTypeCodeAuth link_recovery CredentialsTypeRecoveryLink  CredentialsTypeRecoveryLink is a special credential type linked to the link strategy (recovery flow).  It is not used within the credentials object itself. code_recovery CredentialsTypeRecoveryCode | [optional] |
 | **expires_at** | **Time** | ExpiresAt is the time (UTC) when the flow expires. If the user still wishes to log in, a new flow has to be initiated. |  |
 | **id** | **String** | ID represents the flow's unique ID. When performing the registration flow, this represents the id in the registration ui's query parameter: http://<selfservice.flows.registration.ui_url>/?flow=<id> |  |
 | **issued_at** | **Time** | IssuedAt is the time (UTC) when the flow occurred. |  |
 | **oauth2_login_challenge** | **String** | Ory OAuth 2.0 Login Challenge.  This value is set using the `login_challenge` query parameter of the registration and login endpoints. If set will cooperate with Ory OAuth2 and OpenID to act as an OAuth2 server / OpenID Provider. | [optional] |
 | **oauth2_login_request** | [**OAuth2LoginRequest**](OAuth2LoginRequest.md) |  | [optional] |
+| **organization_id** | **String** |  | [optional] |
 | **request_url** | **String** | RequestURL is the initial URL that was requested from Ory Kratos. It can be used to forward information contained in the URL's path or query for example. |  |
 | **return_to** | **String** | ReturnTo contains the requested return_to URL. | [optional] |
 | **session_token_exchange_code** | **String** | SessionTokenExchangeCode holds the secret code that the client can use to retrieve a session token after the flow has been completed. This is only set if the client has requested a session token exchange code, and if the flow is of type \"api\", and only on creating the flow. | [optional] |
+| **state** | **Object** | State represents the state of this request:  choose_method: ask the user to choose a method (e.g. registration with email) sent_email: the email has been sent to the user passed_challenge: the request was successful and the registration challenge was passed. |  |
 | **transient_payload** | **Object** | TransientPayload is used to pass data from the registration to a webhook | [optional] |
 | **type** | **String** | The flow type can either be `api` or `browser`. |  |
 | **ui** | [**UiContainer**](UiContainer.md) |  |  |
@@ -29,9 +31,11 @@ instance = OryKratosClient::RegistrationFlow.new(
   issued_at: null,
   oauth2_login_challenge: null,
   oauth2_login_request: null,
+  organization_id: null,
   request_url: null,
   return_to: null,
   session_token_exchange_code: null,
+  state: null,
   transient_payload: null,
   type: null,
   ui: null

data/docs/RegistrationFlowState.md

@@ -0,0 +1,15 @@
+# OryKratosClient::RegistrationFlowState
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'ory-kratos-client'
+
+instance = OryKratosClient::RegistrationFlowState.new()
+```
+

data/docs/Session.md

@@ -11,8 +11,9 @@
 | **devices** | [**Array<SessionDevice>**](SessionDevice.md) | Devices has history of all endpoints where the session was used | [optional] |
 | **expires_at** | **Time** | The Session Expiry  When this session expires at. | [optional] |
 | **id** | **String** | Session ID |  |
-| **identity** | [**Identity**](Identity.md) |  |  |
+| **identity** | [**Identity**](Identity.md) |  | [optional] |
 | **issued_at** | **Time** | The Session Issuance Timestamp  When this session was issued at. Usually equal or close to `authenticated_at`. | [optional] |
+| **tokenized** | **String** | Tokenized is the tokenized (e.g. JWT) version of the session.  It is only set when the `tokenize` query parameter was set to a valid tokenize template during calls to `/session/whoami`. | [optional] |
 
 ## Example
 
@@ -28,7 +29,8 @@ instance = OryKratosClient::Session.new(
   expires_at: null,
   id: null,
   identity: null,
-  issued_at: null
+  issued_at: null,
+  tokenized: null
 )
 ```
 

data/docs/SessionAuthenticationMethod.md

@@ -7,6 +7,7 @@
 | **aal** | [**AuthenticatorAssuranceLevel**](AuthenticatorAssuranceLevel.md) |  | [optional] |
 | **completed_at** | **Time** | When the authentication challenge was completed. | [optional] |
 | **method** | **String** |  | [optional] |
+| **organization** | **String** | The Organization id used for authentication | [optional] |
 | **provider** | **String** | OIDC or SAML provider id used for authentication | [optional] |
 
 ## Example
@@ -18,6 +19,7 @@ instance = OryKratosClient::SessionAuthenticationMethod.new(
   aal: null,
   completed_at: null,
   method: null,
+  organization: null,
   provider: null
 )
 ```

data/docs/SettingsFlow.md

@@ -12,7 +12,7 @@
 | **issued_at** | **Time** | IssuedAt is the time (UTC) when the flow occurred. |  |
 | **request_url** | **String** | RequestURL is the initial URL that was requested from Ory Kratos. It can be used to forward information contained in the URL's path or query for example. |  |
 | **return_to** | **String** | ReturnTo contains the requested return_to URL. | [optional] |
-| **state** | [**SettingsFlowState**](SettingsFlowState.md) |  |  |
+| **state** | **Object** | State represents the state of this flow. It knows two states:  show_form: No user data has been collected, or it is invalid, and thus the form should be shown. success: Indicates that the settings flow has been updated successfully with the provided data. Done will stay true when repeatedly checking. If set to true, done will revert back to false only when a flow with invalid (e.g. \"please use a valid phone number\") data was sent. |  |
 | **type** | **String** | The flow type can either be `api` or `browser`. |  |
 | **ui** | [**UiContainer**](UiContainer.md) |  |  |
 

data/docs/UpdateIdentityBody.md

@@ -8,7 +8,7 @@
 | **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] |
 | **schema_id** | **String** | SchemaID is the ID of the JSON Schema to be used for validating the identity's traits. If set will update the Identity's SchemaID. |  |
-| **state** | [**IdentityState**](IdentityState.md) |  |  |
+| **state** | **String** | State is the identity's state. active StateActive inactive StateInactive |  |
 | **traits** | **Object** | Traits represent an identity's traits. The identity is able to create, modify, and delete traits in a self-service manner. The input will always be validated against the JSON Schema defined in `schema_id`. |  |
 
 ## Example

data/docs/UpdateLoginFlowBody.md

@@ -14,6 +14,7 @@ require 'ory-kratos-client'
 OryKratosClient::UpdateLoginFlowBody.openapi_one_of
 # =>
 # [
+#   :'UpdateLoginFlowWithCodeMethod',
 #   :'UpdateLoginFlowWithLookupSecretMethod',
 #   :'UpdateLoginFlowWithOidcMethod',
 #   :'UpdateLoginFlowWithPasswordMethod',
@@ -47,6 +48,7 @@ require 'ory-kratos-client'
 OryKratosClient::UpdateLoginFlowBody.openapi_discriminator_mapping
 # =>
 # {
+#   :'code' => :'UpdateLoginFlowWithCodeMethod',
 #   :'lookup_secret' => :'UpdateLoginFlowWithLookupSecretMethod',
 #   :'oidc' => :'UpdateLoginFlowWithOidcMethod',
 #   :'password' => :'UpdateLoginFlowWithPasswordMethod',
@@ -64,7 +66,7 @@ Find the appropriate object from the `openapi_one_of` list and casts the data in
 require 'ory-kratos-client'
 
 OryKratosClient::UpdateLoginFlowBody.build(data)
-# => #<UpdateLoginFlowWithLookupSecretMethod:0x00007fdd4aab02a0>
+# => #<UpdateLoginFlowWithCodeMethod:0x00007fdd4aab02a0>
 
 OryKratosClient::UpdateLoginFlowBody.build(data_that_doesnt_match)
 # => nil
@@ -78,6 +80,7 @@ OryKratosClient::UpdateLoginFlowBody.build(data_that_doesnt_match)
 
 #### Return type
 
+- `UpdateLoginFlowWithCodeMethod`
 - `UpdateLoginFlowWithLookupSecretMethod`
 - `UpdateLoginFlowWithOidcMethod`
 - `UpdateLoginFlowWithPasswordMethod`

data/docs/UpdateLoginFlowWithCodeMethod.md

@@ -0,0 +1,26 @@
+# OryKratosClient::UpdateLoginFlowWithCodeMethod
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** | Code is the 6 digits code sent to the user | [optional] |
+| **csrf_token** | **String** | CSRFToken is the anti-CSRF token |  |
+| **identifier** | **String** | Identifier is the code identifier The identifier requires that the user has already completed the registration or settings with code flow. | [optional] |
+| **method** | **String** | Method should be set to \"code\" when logging in using the code strategy. |  |
+| **resend** | **String** | Resend is set when the user wants to resend the code | [optional] |
+
+## Example
+
+```ruby
+require 'ory-kratos-client'
+
+instance = OryKratosClient::UpdateLoginFlowWithCodeMethod.new(
+  code: null,
+  csrf_token: null,
+  identifier: null,
+  method: null,
+  resend: null
+)
+```
+

data/docs/UpdateLoginFlowWithOidcMethod.md

@@ -5,6 +5,8 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **csrf_token** | **String** | The CSRF Token | [optional] |
+| **id_token** | **String** | IDToken is an optional id token provided by an OIDC provider  If submitted, it is verified using the OIDC provider's public key set and the claims are used to populate the OIDC credentials of the identity. If the OIDC provider does not store additional claims (such as name, etc.) in the IDToken itself, you can use the `traits` field to populate the identity's traits. Note, that Apple only includes the users email in the IDToken.  Supported providers are Apple | [optional] |
+| **id_token_nonce** | **String** | IDTokenNonce is the nonce, used when generating the IDToken. If the provider supports nonce validation, the nonce will be validated against this value and required. | [optional] |
 | **method** | **String** | Method to use  This field must be set to `oidc` when using the oidc method. |  |
 | **provider** | **String** | The provider to register with |  |
 | **traits** | **Object** | The identity traits. This is a placeholder for the registration flow. | [optional] |
@@ -17,6 +19,8 @@ require 'ory-kratos-client'
 
 instance = OryKratosClient::UpdateLoginFlowWithOidcMethod.new(
   csrf_token: null,
+  id_token: null,
+  id_token_nonce: null,
   method: null,
   provider: null,
   traits: null,

data/docs/UpdateRegistrationFlowBody.md

@@ -14,6 +14,7 @@ require 'ory-kratos-client'
 OryKratosClient::UpdateRegistrationFlowBody.openapi_one_of
 # =>
 # [
+#   :'UpdateRegistrationFlowWithCodeMethod',
 #   :'UpdateRegistrationFlowWithOidcMethod',
 #   :'UpdateRegistrationFlowWithPasswordMethod',
 #   :'UpdateRegistrationFlowWithWebAuthnMethod'
@@ -45,6 +46,7 @@ require 'ory-kratos-client'
 OryKratosClient::UpdateRegistrationFlowBody.openapi_discriminator_mapping
 # =>
 # {
+#   :'code' => :'UpdateRegistrationFlowWithCodeMethod',
 #   :'oidc' => :'UpdateRegistrationFlowWithOidcMethod',
 #   :'password' => :'UpdateRegistrationFlowWithPasswordMethod',
 #   :'webauthn' => :'UpdateRegistrationFlowWithWebAuthnMethod'
@@ -60,7 +62,7 @@ Find the appropriate object from the `openapi_one_of` list and casts the data in
 require 'ory-kratos-client'
 
 OryKratosClient::UpdateRegistrationFlowBody.build(data)
-# => #<UpdateRegistrationFlowWithOidcMethod:0x00007fdd4aab02a0>
+# => #<UpdateRegistrationFlowWithCodeMethod:0x00007fdd4aab02a0>
 
 OryKratosClient::UpdateRegistrationFlowBody.build(data_that_doesnt_match)
 # => nil
@@ -74,6 +76,7 @@ OryKratosClient::UpdateRegistrationFlowBody.build(data_that_doesnt_match)
 
 #### Return type
 
+- `UpdateRegistrationFlowWithCodeMethod`
 - `UpdateRegistrationFlowWithOidcMethod`
 - `UpdateRegistrationFlowWithPasswordMethod`
 - `UpdateRegistrationFlowWithWebAuthnMethod`

data/docs/UpdateRegistrationFlowWithCodeMethod.md

@@ -0,0 +1,28 @@
+# OryKratosClient::UpdateRegistrationFlowWithCodeMethod
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** | The OTP Code sent to the user | [optional] |
+| **csrf_token** | **String** | The CSRF Token | [optional] |
+| **method** | **String** | Method to use  This field must be set to `code` when using the code method. |  |
+| **resend** | **String** | Resend restarts the flow with a new code | [optional] |
+| **traits** | **Object** | The identity's traits |  |
+| **transient_payload** | **Object** | Transient data to pass along to any webhooks | [optional] |
+
+## Example
+
+```ruby
+require 'ory-kratos-client'
+
+instance = OryKratosClient::UpdateRegistrationFlowWithCodeMethod.new(
+  code: null,
+  csrf_token: null,
+  method: null,
+  resend: null,
+  traits: null,
+  transient_payload: null
+)
+```
+