autogen: regenerate OpenAPI client for v1.21.1

Version: v1.21.1

Author: aeneasr

api/openapi.yaml

@@ -39,7 +39,7 @@ info:
     url: https://www.apache.org/licenses/LICENSE-2.0.html
   termsOfService: /tos
   title: Ory APIs
-  version: v1.21.0
+  version: v1.21.1
 servers:
 - url: "https://{project_slug}.projects.oryapis.com/"
   variables:
@@ -898,6 +898,73 @@ paths:
       x-content-type: application/json
       x-accepts:
       - application/json
+  /admin/identities/by/external/{externalID}:
+    get:
+      description: |-
+        Return an [identity](https://www.ory.sh/docs/kratos/concepts/identity-user-model) by its external ID. You can optionally
+        include credentials (e.g. social sign in connections) in the response by using the `include_credential` query parameter.
+      operationId: getIdentityByExternalID
+      parameters:
+      - description: ExternalID must be set to the ID of identity you want to get
+        explode: false
+        in: path
+        name: externalID
+        required: true
+        schema:
+          type: string
+        style: simple
+      - description: |-
+          Include Credentials in Response
+
+          Include any credential, for example `password` or `oidc`, in the response. When set to `oidc`, This will return
+          the initial OAuth 2.0 Access Token, OAuth 2.0 Refresh Token and the OpenID Connect ID Token if available.
+        explode: true
+        in: query
+        name: include_credential
+        required: false
+        schema:
+          items:
+            enum:
+            - password
+            - oidc
+            - totp
+            - lookup_secret
+            - webauthn
+            - code
+            - passkey
+            - profile
+            - saml
+            - link_recovery
+            - code_recovery
+            type: string
+          type: array
+        style: form
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/identity'
+          description: identity
+        "404":
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/errorGeneric'
+          description: errorGeneric
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/errorGeneric'
+          description: errorGeneric
+      security:
+      - oryAccessToken: []
+      summary: Get an Identity by its External ID
+      tags:
+      - identity
+      x-accepts:
+      - application/json
   /admin/identities/{id}:
     delete:
       description: |-
@@ -12360,6 +12427,12 @@ components:
       properties:
         credentials:
           $ref: '#/components/schemas/identityWithCredentials'
+        external_id:
+          description: |-
+            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.
+          type: string
         metadata_admin:
           description: Store metadata about the user which is only accessible through
             admin APIs such as `GET /admin/identities/<id>`.
@@ -13366,6 +13439,7 @@ components:
             version: 0
         state_changed_at: 2000-01-23T04:56:07.000+00:00
         created_at: 2000-01-23T04:56:07.000+00:00
+        external_id: external_id
         recovery_addresses:
         - updated_at: 2000-01-23T04:56:07.000+00:00
           created_at: 2000-01-23T04:56:07.000+00:00
@@ -13413,6 +13487,12 @@ components:
           description: Credentials represents all credentials that can be used for
             authenticating this identity.
           type: object
+        external_id:
+          description: |-
+            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.
+          type: string
         id:
           description: |-
             ID is the identity's unique identifier.
@@ -21124,6 +21204,7 @@ components:
               version: 0
           state_changed_at: 2000-01-23T04:56:07.000+00:00
           created_at: 2000-01-23T04:56:07.000+00:00
+          external_id: external_id
           recovery_addresses:
           - updated_at: 2000-01-23T04:56:07.000+00:00
             created_at: 2000-01-23T04:56:07.000+00:00
@@ -21512,6 +21593,7 @@ components:
               version: 0
           state_changed_at: 2000-01-23T04:56:07.000+00:00
           created_at: 2000-01-23T04:56:07.000+00:00
+          external_id: external_id
           recovery_addresses:
           - updated_at: 2000-01-23T04:56:07.000+00:00
             created_at: 2000-01-23T04:56:07.000+00:00
@@ -21823,6 +21905,7 @@ components:
                 version: 0
             state_changed_at: 2000-01-23T04:56:07.000+00:00
             created_at: 2000-01-23T04:56:07.000+00:00
+            external_id: external_id
             recovery_addresses:
             - updated_at: 2000-01-23T04:56:07.000+00:00
               created_at: 2000-01-23T04:56:07.000+00:00
@@ -21918,6 +22001,7 @@ components:
               version: 0
           state_changed_at: 2000-01-23T04:56:07.000+00:00
           created_at: 2000-01-23T04:56:07.000+00:00
+          external_id: external_id
           recovery_addresses:
           - updated_at: 2000-01-23T04:56:07.000+00:00
             created_at: 2000-01-23T04:56:07.000+00:00
@@ -21992,6 +22076,7 @@ components:
                 version: 0
             state_changed_at: 2000-01-23T04:56:07.000+00:00
             created_at: 2000-01-23T04:56:07.000+00:00
+            external_id: external_id
             recovery_addresses:
             - updated_at: 2000-01-23T04:56:07.000+00:00
               created_at: 2000-01-23T04:56:07.000+00:00
@@ -23104,6 +23189,12 @@ components:
       properties:
         credentials:
           $ref: '#/components/schemas/identityWithCredentials'
+        external_id:
+          description: |-
+            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.
+          type: string
         metadata_admin:
           description: Store metadata about the user which is only accessible through
             admin APIs such as `GET /admin/identities/<id>`.
@@ -23497,8 +23588,7 @@ components:
           type: string
         screen:
           description: |-
-            Go back in the flow, meaningfully.
-            The actual value is not important (it is typically "previous"), the system checks whether the value is empty or not.
+            Set to "previous" to return to the previous screen.
             Used in RecoveryV2.
           type: string
         transient_payload:

build.gradle

@@ -4,7 +4,7 @@ apply plugin: 'java'
 apply plugin: 'com.diffplug.spotless'
 
 group = 'sh.ory'
-version = 'v1.21.0'
+version = 'v1.21.1'
 
 buildscript {
     repositories {

build.sbt

@@ -2,7 +2,7 @@ lazy val root = (project in file(".")).
   settings(
     organization := "sh.ory",
     name := "client",
-    version := "v1.21.0",
+    version := "v1.21.1",
     scalaVersion := "2.11.4",
     scalacOptions ++= Seq("-feature"),
     javacOptions in compile ++= Seq("-Xlint:deprecation"),

docs/CreateIdentityBody.md

@@ -9,6 +9,7 @@ Create Identity Body
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
 |**credentials** | [**IdentityWithCredentials**](IdentityWithCredentials.md) |  |  [optional] |
+|**externalId** | **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] |
 |**metadataAdmin** | **Object** | Store metadata about the user which is only accessible through admin APIs such as `GET /admin/identities/<id>`. |  [optional] |
 |**metadataPublic** | **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] |
 |**organizationId** | **String** |  |  [optional] |

docs/Identity.md

@@ -10,6 +10,7 @@ An [identity](https://www.ory.sh/docs/kratos/concepts/identity-user-model) repre
 |------------ | ------------- | ------------- | -------------|
 |**createdAt** | **OffsetDateTime** | CreatedAt is a helper struct field for gobuffalo.pop. |  [optional] |
 |**credentials** | [**Map<String, IdentityCredentials>**](IdentityCredentials.md) | Credentials represents all credentials that can be used for authenticating this identity. |  [optional] |
+|**externalId** | **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. |  |
 |**metadataAdmin** | **Object** | NullJSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger and is NULLable- |  [optional] |
 |**metadataPublic** | **Object** | NullJSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger and is NULLable- |  [optional] |

docs/IdentityApi.md

@@ -14,6 +14,7 @@ All URIs are relative to *https://playground.projects.oryapis.com*
 | [**disableSession**](IdentityApi.md#disableSession) | **DELETE** /admin/sessions/{id} | Deactivate a Session |
 | [**extendSession**](IdentityApi.md#extendSession) | **PATCH** /admin/sessions/{id}/extend | Extend a Session |
 | [**getIdentity**](IdentityApi.md#getIdentity) | **GET** /admin/identities/{id} | Get an Identity |
+| [**getIdentityByExternalID**](IdentityApi.md#getIdentityByExternalID) | **GET** /admin/identities/by/external/{externalID} | Get an Identity by its External ID |
 | [**getIdentitySchema**](IdentityApi.md#getIdentitySchema) | **GET** /schemas/{id} | Get Identity JSON Schema |
 | [**getSession**](IdentityApi.md#getSession) | **GET** /admin/sessions/{id} | Get Session |
 | [**listIdentities**](IdentityApi.md#listIdentities) | **GET** /admin/identities | List Identities |
@@ -727,6 +728,77 @@ public class Example {
 | **404** | errorGeneric |  -  |
 | **0** | errorGeneric |  -  |
 
+<a id="getIdentityByExternalID"></a>
+# **getIdentityByExternalID**
+> Identity getIdentityByExternalID(externalID, includeCredential)
+
+Get an Identity by its External ID
+
+Return an [identity](https://www.ory.sh/docs/kratos/concepts/identity-user-model) by its external ID. You can optionally include credentials (e.g. social sign in connections) in the response by using the &#x60;include_credential&#x60; query parameter.
+
+### Example
+```java
+// Import classes:
+import sh.ory.ApiClient;
+import sh.ory.ApiException;
+import sh.ory.Configuration;
+import sh.ory.auth.*;
+import sh.ory.models.*;
+import sh.ory.api.IdentityApi;
+
+public class Example {
+  public static void main(String[] args) {
+    ApiClient defaultClient = Configuration.getDefaultApiClient();
+    defaultClient.setBasePath("https://playground.projects.oryapis.com");
+    
+    // Configure HTTP bearer authorization: oryAccessToken
+    HttpBearerAuth oryAccessToken = (HttpBearerAuth) defaultClient.getAuthentication("oryAccessToken");
+    oryAccessToken.setBearerToken("BEARER TOKEN");
+
+    IdentityApi apiInstance = new IdentityApi(defaultClient);
+    String externalID = "externalID_example"; // String | ExternalID must be set to the ID of identity you want to get
+    List<String> includeCredential = Arrays.asList(); // List<String> | Include Credentials in Response  Include any credential, for example `password` or `oidc`, in the response. When set to `oidc`, This will return the initial OAuth 2.0 Access Token, OAuth 2.0 Refresh Token and the OpenID Connect ID Token if available.
+    try {
+      Identity result = apiInstance.getIdentityByExternalID(externalID, includeCredential);
+      System.out.println(result);
+    } catch (ApiException e) {
+      System.err.println("Exception when calling IdentityApi#getIdentityByExternalID");
+      System.err.println("Status code: " + e.getCode());
+      System.err.println("Reason: " + e.getResponseBody());
+      System.err.println("Response headers: " + e.getResponseHeaders());
+      e.printStackTrace();
+    }
+  }
+}
+```
+
+### Parameters
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **externalID** | **String**| ExternalID must be set to the ID of identity you want to get | |
+| **includeCredential** | [**List&lt;String&gt;**](String.md)| Include Credentials in Response  Include any credential, for example &#x60;password&#x60; or &#x60;oidc&#x60;, in the response. When set to &#x60;oidc&#x60;, This will return the initial OAuth 2.0 Access Token, OAuth 2.0 Refresh Token and the OpenID Connect ID Token if available. | [optional] [enum: password, oidc, totp, lookup_secret, webauthn, code, passkey, profile, saml, link_recovery, code_recovery] |
+
+### Return type
+
+[**Identity**](Identity.md)
+
+### Authorization
+
+[oryAccessToken](../README.md#oryAccessToken)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | identity |  -  |
+| **404** | errorGeneric |  -  |
+| **0** | errorGeneric |  -  |
+
 <a id="getIdentitySchema"></a>
 # **getIdentitySchema**
 > Object getIdentitySchema(id)

docs/UpdateIdentityBody.md

@@ -9,6 +9,7 @@ Update Identity Body
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
 |**credentials** | [**IdentityWithCredentials**](IdentityWithCredentials.md) |  |  [optional] |
+|**externalId** | **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] |
 |**metadataAdmin** | **Object** | Store metadata about the user which is only accessible through admin APIs such as `GET /admin/identities/<id>`. |  [optional] |
 |**metadataPublic** | **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] |
 |**schemaId** | **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. |  |

docs/UpdateRecoveryFlowBody.md

@@ -16,7 +16,7 @@ Update Recovery Flow Request Body
 |**recoveryAddress** | **String** | A recovery address that is registered for the user. It can be an email, a phone number (to receive the code via SMS), etc. Used in RecoveryV2. |  [optional] |
 |**recoveryConfirmAddress** | **String** | If there are multiple recovery addresses registered for the user, and the initially provided address is different from the address chosen when the choice (of masked addresses) is presented, then we need to make sure that the user actually knows the full address to avoid information exfiltration, so we ask for the full address. Used in RecoveryV2. |  [optional] |
 |**recoverySelectAddress** | **String** | If there are multiple addresses registered for the user, a choice is presented and this field stores the result of this choice. Addresses are 'masked' (never sent in full to the client and shown partially in the UI) since at this point in the recovery flow, the user has not yet proven that it knows the full address and we want to avoid information exfiltration. So for all intents and purposes, the value of this field should be treated as an opaque identifier. Used in RecoveryV2. |  [optional] |
-|**screen** | **String** | Go back in the flow, meaningfully. The actual value is not important (it is typically \"previous\"), the system checks whether the value is empty or not. Used in RecoveryV2. |  [optional] |
+|**screen** | **String** | Set to \"previous\" to return to the previous screen. Used in RecoveryV2. |  [optional] |
 
 
 

docs/UpdateRecoveryFlowWithCodeMethod.md

@@ -15,7 +15,7 @@ Update Recovery Flow with Code Method
 |**recoveryAddress** | **String** | A recovery address that is registered for the user. It can be an email, a phone number (to receive the code via SMS), etc. Used in RecoveryV2. |  [optional] |
 |**recoveryConfirmAddress** | **String** | If there are multiple recovery addresses registered for the user, and the initially provided address is different from the address chosen when the choice (of masked addresses) is presented, then we need to make sure that the user actually knows the full address to avoid information exfiltration, so we ask for the full address. Used in RecoveryV2. |  [optional] |
 |**recoverySelectAddress** | **String** | If there are multiple addresses registered for the user, a choice is presented and this field stores the result of this choice. Addresses are 'masked' (never sent in full to the client and shown partially in the UI) since at this point in the recovery flow, the user has not yet proven that it knows the full address and we want to avoid information exfiltration. So for all intents and purposes, the value of this field should be treated as an opaque identifier. Used in RecoveryV2. |  [optional] |
-|**screen** | **String** | Go back in the flow, meaningfully. The actual value is not important (it is typically \"previous\"), the system checks whether the value is empty or not. Used in RecoveryV2. |  [optional] |
+|**screen** | **String** | Set to \"previous\" to return to the previous screen. Used in RecoveryV2. |  [optional] |
 |**transientPayload** | **Object** | Transient data to pass along to any webhooks |  [optional] |