Skip to content

Commit 0dd21c9

Browse files
heiytorgustavosbarreto
authored andcommitted
feat(api): update admin user get endpoint response schema
- Replace nested user object structure with flat response - Add new fields: status, max_namespaces, recovery_email, mfa, preferences - Update examples to reflect new response pattern - Remove legacy fields: namespaces, confirmed, password - Support auth_methods with local and saml options
1 parent 218a9e2 commit 0dd21c9

File tree

1 file changed

+93
-25
lines changed

1 file changed

+93
-25
lines changed

openapi/spec/paths/admin@api@users@{id}.yaml

Lines changed: 93 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -87,39 +87,107 @@ get:
8787
schema:
8888
type: object
8989
properties:
90-
user:
91-
$ref: ../components/schemas/userAdminResponse.yaml
90+
id:
91+
$ref: ../components/schemas/userID.yaml
92+
status:
93+
description: User's status
94+
type: string
95+
enum: [confirmed, pending]
96+
max_namespaces:
97+
description: Maximum number of namespaces the user can own
98+
type: integer
99+
minimum: 0
100+
created_at:
101+
description: User's creating date
102+
type: string
103+
format: date-time
104+
last_login:
105+
description: User's last login date
106+
type: string
107+
format: date-time
108+
name:
109+
$ref: ../components/schemas/userName.yaml
110+
username:
111+
$ref: ../components/schemas/userUsername.yaml
112+
email:
113+
$ref: ../components/schemas/userEmail.yaml
114+
recovery_email:
115+
description: User's recovery email address
116+
type: string
117+
format: email
118+
mfa:
119+
description: Multi-factor authentication settings
120+
type: object
121+
properties:
122+
enabled:
123+
description: Whether MFA is enabled for the user
124+
type: boolean
125+
required:
126+
- enabled
92127
namespacesOwned:
93-
description: User's integer of owned namespaces
128+
description: Number of namespaces owned by the user
94129
type: integer
95130
minimum: 0
131+
preferences:
132+
description: User preferences
133+
type: object
134+
properties:
135+
auth_methods:
136+
description: Preferred authentication methods
137+
type: array
138+
items:
139+
type: string
140+
enum: [local, saml]
141+
required:
142+
- auth_methods
143+
required:
144+
- id
145+
- status
146+
- max_namespaces
147+
- created_at
148+
- last_login
149+
- name
150+
- username
151+
- email
152+
- mfa
153+
- namespacesOwned
154+
- preferences
96155
examples:
97156
user_confirmed:
98157
value:
99-
user:
100-
id: 507f1f77bcf86cd799439011
101-
namespaces: 0
102-
confirmed: true
103-
created_at: 2020-05-01T00:00:00.000Z
104-
last_login: 2020-05-01T00:00:00.000Z
105-
name: example
106-
107-
username: example
108-
password: 50d858e0985ecc7f60418aaf0cc5ab587f42c2570a884095a9e8ccacd0f6545c
109-
namespacesOwned: 0
110-
user_not_confirmed:
158+
id: '68ada99d2f96ee43fd86306a'
159+
status: 'confirmed'
160+
max_namespaces: 0
161+
created_at: '2025-08-26T12:33:33.19Z'
162+
last_login: '2025-10-27T13:10:59.458Z'
163+
name: 'dev'
164+
username: 'dev'
165+
166+
recovery_email: '[email protected]'
167+
mfa:
168+
enabled: false
169+
namespacesOwned: 1
170+
preferences:
171+
auth_methods:
172+
- 'local'
173+
user_pending:
111174
value:
112-
user:
113-
id: 507f1f77bcf86cd799439011
114-
namespaces: 2
115-
confirmed: false
116-
created_at: 2012-01-02T00:00:00.000Z
117-
last_login: 2012-01-02T00:00:00.000Z
118-
name: example
119-
120-
username: example
121-
password: 50d858e0985ecc7f60418aaf0cc5ab587f42c2570a884095a9e8ccacd0f6545c
175+
id: '507f1f77bcf86cd799439012'
176+
status: 'pending'
177+
max_namespaces: 5
178+
created_at: '2025-01-15T10:00:00.000Z'
179+
last_login: '2025-01-20T15:30:00.000Z'
180+
name: 'testuser'
181+
username: 'testuser'
182+
183+
recovery_email: '[email protected]'
184+
mfa:
185+
enabled: true
122186
namespacesOwned: 2
187+
preferences:
188+
auth_methods:
189+
- 'local'
190+
- 'saml'
123191
'401':
124192
$ref: ../components/responses/401.yaml
125193
'404':

0 commit comments

Comments
 (0)