From 489bb54e2358984bae64da4bc3a22d896e9124c5 Mon Sep 17 00:00:00 2001
From: Florian Spreckelsen <f.spreckelsen@indiscale.com>
Date: Tue, 16 Jul 2024 10:40:55 +0200
Subject: [PATCH] DOC: Document UserInfo class
---
src/linkahead/common/models.py | 11 +++++++++++
1 file changed, 11 insertions(+)
diff --git a/src/linkahead/common/models.py b/src/linkahead/common/models.py
index 98fc28a4..5bc471d7 100644
--- a/src/linkahead/common/models.py
+++ b/src/linkahead/common/models.py
@@ -5019,6 +5019,17 @@ class DropOffBox(list):
class UserInfo():
+ """User information from a server response.
+
+ Attributes
+ ----------
+ name : str
+ Username
+ realm : str
+ Realm in which this user lives, e.g., CaosDB or LDAP.
+ roles : list[str]
+ List of roles assigned to this user.
+ """
def __init__(self, xml: etree._Element):
self.roles = [role.text for role in xml.findall("Roles/Role")]
--
GitLab