From b22043176eabbbc252ef8ac6875941747a7cf9a8 Mon Sep 17 00:00:00 2001
From: Frederick Muriuki Muriithi
Date: Wed, 10 May 2023 14:03:03 +0300
Subject: issue: Provide data format for user accounts in redis

Update the issue with the data format for the user accounts as stored
in redis.
---
 .../migrate-user-accounts-from-redis.gmi           | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/issues/authentication_authorisation/migrate-user-accounts-from-redis.gmi b/issues/authentication_authorisation/migrate-user-accounts-from-redis.gmi
index 7d3352f..5b9630b 100644
--- a/issues/authentication_authorisation/migrate-user-accounts-from-redis.gmi
+++ b/issues/authentication_authorisation/migrate-user-accounts-from-redis.gmi
@@ -32,6 +32,28 @@ We could have the migration be triggered by the user:
 * Provide the user with the chance to trigger migration of their details from the old system
 * If credentials are not found in either system, that is not a valid user. Show error and end the login process.
 
+The user accounts information in redis is stored in a hash of the form:
+
+```
+{
+  <user-id:UUID>: {
+    "email_address": <:STRING>,
+    "full_name": <:STRING>,
+    "organization": <:STRING>,
+    "password": <pbkdf2-password-representation:MAPPING>,
+    "user_id": <user-id:UUID>,
+    "confirmed": <:int (0 or 1)>,
+    "registration_info": {
+        "timestamp": <:TIMESTAMP>,
+        "ip_address": <:IPv4ADDRESS>,
+        "user_agent": <:STRING>}
+    },
+  ...
+}
+```
+
+where both ```<user-id:UUID>``` values are the same.
+
 ## Related Topic(s)
 
 => /topics/authentication/authentication-authorisation-design Authentication/authorisation design
-- 
cgit v1.2.3