fix: mark identity as optional in session struct

The identity is not always available in the session struct, for example when AAL2 is required. Closes #3461
ory · Aug 29, 2023 · b9da094 · b9da094
1 parent eaaf375
commit b9da094
Show file tree

Hide file tree

Showing 5 changed files with 50 additions and 33 deletions.
diff --git a/internal/client-go/model_session.go b/internal/client-go/model_session.go
diff --git a/internal/httpclient/model_session.go b/internal/httpclient/model_session.go
diff --git a/session/session.go b/session/session.go
@@ -120,7 +120,12 @@ type Session struct {
 	// Use this token to log out a user.
 	LogoutToken string `json:"-" db:"logout_token"`
 
-	// required: true
+	// The Session Identity
+	//
+	// The identity that authenticated this session.
+	//
+	// If 2FA is required for the user, and the authentication process only solved the first factor, this field will be
+	// null until the session has been fully authenticated with the second factor.
 	Identity *identity.Identity `json:"identity" faker:"identity" db:"-" belongs_to:"identities" fk_id:"IdentityID"`
 
 	// Devices has history of all endpoints where the session was used

diff --git a/spec/api.json b/spec/api.json
@@ -1759,8 +1759,7 @@
           }
         },
         "required": [
-          "id",
-          "identity"
+          "id"
         ],
         "type": "object"
       },

diff --git a/spec/swagger.json b/spec/swagger.json
@@ -4638,8 +4638,7 @@
       "description": "A Session",
       "type": "object",
       "required": [
-        "id",
-        "identity"
+        "id"
       ],
       "properties": {
         "active": {
-Original file line number
+Diff line change
@@ Expand Up / @@ -1759,8 +1759,7 @@ @@
               }
             },
             "required": [
-              "id",
-              "identity"
+              "id"
             ],
             "type": "object"
           },
@@ Expand Down @@