Skip to content

Users

BaseUser

Bases: ResponseModel

A base user model. Not meant to be instantiated directly.

Parameters:

Name Type Description Default
id int

The ID of the user

 required
oauth_id int | None

The OAuth ID of the user

 required
name str

The name of the user

 required
website str | None

The website of the user

 required
affiliation str | None

The affiliation of the user

 required
country str | None

The country of the user

 required
bracket_id int | None

The ID of the bracket the user is in

 required
team_id int | None

The ID of the team the user is in

 required
fields list

The fields of the user

 required

Attributes:

Name Type Description
id int

The ID of the user
oauth_id int | None

The OAuth ID of the user
name str

The name of the user
website str | None

The website of the user
affiliation str | None

The affiliation of the user
country str | None

The country of the user
bracket_id int | None

The ID of the bracket the user is in
team_id int | None

The ID of the team the user is in
fields list

The fields of the user
Source code in ctfdpy\models\users.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
class BaseUser(ResponseModel):
    """
    A base user model. Not meant to be instantiated directly.

    Parameters
    ----------
    id : int
        The ID of the user
    oauth_id : int | None
        The OAuth ID of the user
    name : str
        The name of the user
    website : str | None
        The website of the user
    affiliation : str | None
        The affiliation of the user
    country : str | None
        The country of the user
    bracket_id : int | None
        The ID of the bracket the user is in
    team_id : int | None
        The ID of the team the user is in
    fields : list
        The fields of the user

    Attributes
    ----------
    id : int
        The ID of the user
    oauth_id : int | None
        The OAuth ID of the user
    name : str
        The name of the user
    website : str | None
        The website of the user
    affiliation : str | None
        The affiliation of the user
    country : str | None
        The country of the user
    bracket_id : int | None
        The ID of the bracket the user is in
    team_id : int | None
        The ID of the team the user is in
    fields : list
        The fields of the user
    """

    id: int = Field(frozen=True, exclude=True)
    oauth_id: int | None = Field(None, frozen=True, exclude=True)

    name: str

    website: str | None
    affiliation: str | None
    country: str | None

    bracket_id: int | None
    team_id: int | None

    fields: list  # not fully implemented by us yet

    def to_update_paylaod(self) -> UpdateUserPayload:
        """
        Converts the user to a payload for updating users.

        Returns
        -------
        UpdateUserPayload
            The payload for updating users
        """
        return UpdateUserPayload.model_validate(self, from_attributes=True)

to_update_paylaod 

to_update_paylaod() -> UpdateUserPayload

Converts the user to a payload for updating users.

Returns:

Type Description
UpdateUserPayload

The payload for updating users
Source code in ctfdpy\models\users.py 
78
79
80
81
82
83
84
85
86
87
def to_update_paylaod(self) -> UpdateUserPayload:
    """
    Converts the user to a payload for updating users.

    Returns
    -------
    UpdateUserPayload
        The payload for updating users
    """
    return UpdateUserPayload.model_validate(self, from_attributes=True)

UserListing

Bases: BaseUser

Represents a user listing in CTFd.

Returned by the GET /users endpoint.

Parameters:

Name Type Description Default
id int

The ID of the user

 required
oauth_id int | None

The OAuth ID of the user

 required
name str

The name of the user

 required
website str | None

The website of the user

 required
affiliation str | None

The affiliation of the user

 required
country str | None

The country of the user

 required
bracket_id int | None

The ID of the bracket the user is in

 required
team_id int | None

The ID of the team the user is in

 required
fields list

The fields of the user

 required

Attributes:

Name Type Description
id int

The ID of the user, read-only
oauth_id int | None

The OAuth ID of the user, read-only
name str

The name of the user
website str | None

The website of the user
affiliation str | None

The affiliation of the user
country str | None

The country of the user
bracket_id int | None

The ID of the bracket the user is in
team_id int | None

The ID of the team the user is in
fields list

The fields of the user
Source code in ctfdpy\models\users.py 
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
class UserListing(BaseUser):
    """
    Represents a user listing in CTFd.

    Returned by the `GET /users` endpoint.

    Parameters
    ----------
    id : int
        The ID of the user
    oauth_id : int | None
        The OAuth ID of the user
    name : str
        The name of the user
    website : str | None
        The website of the user
    affiliation : str | None
        The affiliation of the user
    country : str | None
        The country of the user
    bracket_id : int | None
        The ID of the bracket the user is in
    team_id : int | None
        The ID of the team the user is in
    fields : list
        The fields of the user

    Attributes
    ----------
    id : int
        The ID of the user, read-only
    oauth_id : int | None
        The OAuth ID of the user, read-only
    name : str
        The name of the user
    website : str | None
        The website of the user
    affiliation : str | None
        The affiliation of the user
    country : str | None
        The country of the user
    bracket_id : int | None
        The ID of the bracket the user is in
    team_id : int | None
        The ID of the team the user is in
    fields : list
        The fields of the user
    """

UserPublicView

Bases: BaseUser

Represents a public view of a user in CTFd.

Parameters:

Name Type Description Default
id int

The ID of the user

 required
oauth_id int | None

The OAuth ID of the user

 required
name str

The name of the user

 required
website str | None

The website of the user

 required
affiliation str | None

The affiliation of the user

 required
country str | None

The country of the user

 required
bracket_id int | None

The ID of the bracket the user is in

 required
team_id int | None

The ID of the team the user is in

 required
fields list

The fields of the user

 required
place int | None

The placing of the user. Not returned by all endpoints

 required
score int | None

The score of the user. Not returned by all endpoints

 required

Attributes:

Name Type Description
id int

The ID of the user, read-only
oauth_id int | None

The OAuth ID of the user, read-only
name str

The name of the user
website str | None

The website of the user
affiliation str | None

The affiliation of the user
country str | None

The country of the user
bracket_id int | None

The ID of the bracket the user is in
team_id int | None

The ID of the team the user is in
fields list

The fields of the user
place int | None

The placing of the user. Not returned by all endpoints
score int | None

The score of the user. Not returned by all endpoints
Source code in ctfdpy\models\users.py 
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
class UserPublicView(BaseUser):
    """
    Represents a public view of a user in CTFd.

    Parameters
    ----------
    id : int
        The ID of the user
    oauth_id : int | None
        The OAuth ID of the user
    name : str
        The name of the user
    website : str | None
        The website of the user
    affiliation : str | None
        The affiliation of the user
    country : str | None
        The country of the user
    bracket_id : int | None
        The ID of the bracket the user is in
    team_id : int | None
        The ID of the team the user is in
    fields : list
        The fields of the user
    place : int | None
        The placing of the user. Not returned by all endpoints
    score : int | None
        The score of the user. Not returned by all endpoints

    Attributes
    ----------
    id : int
        The ID of the user, read-only
    oauth_id : int | None
        The OAuth ID of the user, read-only
    name : str
        The name of the user
    website : str | None
        The website of the user
    affiliation : str | None
        The affiliation of the user
    country : str | None
        The country of the user
    bracket_id : int | None
        The ID of the bracket the user is in
    team_id : int | None
        The ID of the team the user is in
    fields : list
        The fields of the user
    place : int | None
        The placing of the user. Not returned by all endpoints
    score : int | None
        The score of the user. Not returned by all endpoints
    """

    place: int | None = None
    score: int | None = None

UserPrivateView

Bases: BaseUser

Represents a private view of a user in CTFd.

This is returned when viewing the user's own profile.

Parameters:

Name Type Description Default
id int

The ID of the user

 required
oauth_id int | None

The OAuth ID of the user

 required
name str

The name of the user

 required
email str

The email of the user

 required
language str | None

The language setting of the user

 required
website str | None

The website of the user

 required
affiliation str | None

The affiliation of the user

 required
country str | None

The country of the user

 required
bracket_id int | None

The ID of the bracket the user is in

 required
team_id int | None

The ID of the team the user is in

 required
fields list

The fields of the user

 required
place int

The placing of the user. Not returned by all endpoints

 required
score int

The score of the user. Not returned by all endpoints

 required

Attributes:

Name Type Description
id int

The ID of the user, read-only
oauth_id int | None

The OAuth ID of the user, read-only
name str

The name of the user
email str

The email of the user
language str | None

The language setting of the user
website str | None

The website of the user
affiliation str | None

The affiliation of the user
country str | None

The country of the user
bracket_id int | None

The ID of the bracket the user is in
team_id int | None

The ID of the team the user is in
fields list

The fields of the user
place int

The placing of the user. Not returned by all endpoints
score int

The score of the user. Not returned by all endpoints
Source code in ctfdpy\models\users.py 
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
class UserPrivateView(BaseUser):
    """
    Represents a private view of a user in CTFd.

    This is returned when viewing the user's own profile.

    Parameters
    ----------
    id : int
        The ID of the user
    oauth_id : int | None
        The OAuth ID of the user
    name : str
        The name of the user
    email : str
        The email of the user
    language : str | None
        The language setting of the user
    website : str | None
        The website of the user
    affiliation : str | None
        The affiliation of the user
    country : str | None
        The country of the user
    bracket_id : int | None
        The ID of the bracket the user is in
    team_id : int | None
        The ID of the team the user is in
    fields : list
        The fields of the user
    place : int
        The placing of the user. Not returned by all endpoints
    score : int
        The score of the user. Not returned by all endpoints

    Attributes
    ----------
    id : int
        The ID of the user, read-only
    oauth_id : int | None
        The OAuth ID of the user, read-only
    name : str
        The name of the user
    email : str
        The email of the user
    language : str | None
        The language setting of the user
    website : str | None
        The website of the user
    affiliation : str | None
        The affiliation of the user
    country : str | None
        The country of the user
    bracket_id : int | None
        The ID of the bracket the user is in
    team_id : int | None
        The ID of the team the user is in
    fields : list
        The fields of the user
    place : int
        The placing of the user. Not returned by all endpoints
    score : int
        The score of the user. Not returned by all endpoints
    """

    email: str
    language: str | None
    place: int | None = None
    score: int | None = None

UserAdminView

Bases: BaseUser

Represents an admin view of a user in CTFd.

This is returned when viewing a user as an admin.

Parameters:

Name Type Description Default
id int

The ID of the user, read-only

 required
oauth_id int | None

The OAuth ID of the user, read-only

 required
name str

The name of the user

 required
email str

The email of the user

 required
language str | None

The language setting of the user

 required
website str | None

The website of the user

 required
affiliation str | None

The affiliation of the user

 required
country str | None

The country of the user

 required
bracket_id int | None

The ID of the bracket the user is in

 required
team_id int | None

The ID of the team the user is in

 required
fields list

The fields of the user

 required
created datetime

The creation date of the user

 required
secret str

Not sure what this is

 required
type UserType

The type of the user

 required
banned bool

Whether the user is banned

 required
hidden bool

Whether the user is hidden

 required
verified bool

Whether the user is verified

 required
place int

The placing of the user. Not returned by all endpoints

 required
score int

The score of the user. Not returned by all endpoints

 required

Attributes:

Name Type Description
id int

The ID of the user, read-only
oauth_id int | None

The OAuth ID of the user, read-only
name str

The name of the user
email str

The email of the user
language str | None

The language setting of the user
website str | None

The website of the user
affiliation str | None

The affiliation of the user
country str | None

The country of the user
bracket_id int | None

The ID of the bracket the user is in
team_id int | None

The ID of the team the user is in
fields list

The fields of the user
created datetime

The creation date of the user
secret str

Not sure what this is
type UserType

The type of the user
banned bool

Whether the user is banned
hidden bool

Whether the user is hidden
verified bool

Whether the user is verified
place int

The placing of the user. Not returned by all endpoints
score int

The score of the user. Not returned by all endpoints
Source code in ctfdpy\models\users.py 
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
class UserAdminView(BaseUser):
    """
    Represents an admin view of a user in CTFd.

    This is returned when viewing a user as an admin.

    Parameters
    ----------
    id : int
        The ID of the user, read-only
    oauth_id : int | None
        The OAuth ID of the user, read-only
    name : str
        The name of the user
    email : str
        The email of the user
    language : str | None
        The language setting of the user
    website : str | None
        The website of the user
    affiliation : str | None
        The affiliation of the user
    country : str | None
        The country of the user
    bracket_id : int | None
        The ID of the bracket the user is in
    team_id : int | None
        The ID of the team the user is in
    fields : list
        The fields of the user
    created : datetime
        The creation date of the user
    secret : str
        Not sure what this is
    type : UserType
        The type of the user
    banned : bool
        Whether the user is banned
    hidden : bool
        Whether the user is hidden
    verified : bool
        Whether the user is verified
    place : int
        The placing of the user. Not returned by all endpoints
    score : int
        The score of the user. Not returned by all endpoints

    Attributes
    ----------
    id : int
        The ID of the user, read-only
    oauth_id : int | None
        The OAuth ID of the user, read-only
    name : str
        The name of the user
    email : str
        The email of the user
    language : str | None
        The language setting of the user
    website : str | None
        The website of the user
    affiliation : str | None
        The affiliation of the user
    country : str | None
        The country of the user
    bracket_id : int | None
        The ID of the bracket the user is in
    team_id : int | None
        The ID of the team the user is in
    fields : list
        The fields of the user
    created : datetime
        The creation date of the user
    secret : str
        Not sure what this is
    type : UserType
        The type of the user
    banned : bool
        Whether the user is banned
    hidden : bool
        Whether the user is hidden
    verified : bool
        Whether the user is verified
    place : int
        The placing of the user. Not returned by all endpoints
    score : int
        The score of the user. Not returned by all endpoints
    """

    email: str

    created: datetime
    secret: str  # not sure what this is

    type: UserType

    banned: bool
    hidden: bool
    verified: bool

    place: int | None = None
    score: int | None = None

CreateUserPayload

Bases: CreatePayloadModel

Represents a user create payload in CTFd.

Parameters:

Name Type Description Default
name str

The name of the user

 required
email str

The email of the user

 required
password str

The password of the user

 required
type UserType

The type of the user

 required
banned bool

Whether the user is banned

 required
hidden bool

Whether the user is hidden

 required
verified bool

Whether the user is verified

 required
language str | None

The language setting of the user

 required
website str | None

The website of the user

 required
affiliation str | None

The affiliation of the user

 required
country str | None

The country of the user

 required
bracket_id int | None

The ID of the bracket the user is in

 required
fields list

The fields of the user

 required
secret str | None

Not sure what this is

 required

Attributes:

Name Type Description
name str

The name of the user
email str

The email of the user
password str

The password of the user
type UserType

The type of the user
banned bool

Whether the user is banned
hidden bool

Whether the user is hidden
verified bool

Whether the user is verified
language str | None

The language setting of the user
website str | None

The website of the user
affiliation str | None

The affiliation of the user
country str | None

The country of the user
bracket_id int | None

The ID of the bracket the user is in
fields list

The fields of the user
secret str | None

Not sure what this is
Source code in ctfdpy\models\users.py 
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
class CreateUserPayload(CreatePayloadModel):
    """
    Represents a user create payload in CTFd.

    Parameters
    ----------
    name : str
        The name of the user
    email : str
        The email of the user
    password : str
        The password of the user
    type : UserType
        The type of the user
    banned : bool
        Whether the user is banned
    hidden : bool
        Whether the user is hidden
    verified : bool
        Whether the user is verified
    language : str | None
        The language setting of the user
    website : str | None
        The website of the user
    affiliation : str | None
        The affiliation of the user
    country : str | None
        The country of the user
    bracket_id : int | None
        The ID of the bracket the user is in
    fields : list
        The fields of the user
    secret : str | None
        Not sure what this is

    Attributes
    ----------
    name : str
        The name of the user
    email : str
        The email of the user
    password : str
        The password of the user
    type : UserType
        The type of the user
    banned : bool
        Whether the user is banned
    hidden : bool
        Whether the user is hidden
    verified : bool
        Whether the user is verified
    language : str | None
        The language setting of the user
    website : str | None
        The website of the user
    affiliation : str | None
        The affiliation of the user
    country : str | None
        The country of the user
    bracket_id : int | None
        The ID of the bracket the user is in
    fields : list
        The fields of the user
    secret : str | None
        Not sure what this is
    """

    name: str = Field(min_length=1, max_length=128)
    email: EmailStr = Field(min_length=1, max_length=128)
    password: str

    type: UserType = UserType.USER

    banned: bool = False
    hidden: bool = False
    verified: bool = False

    language: str | None = None
    website: AnyHttpUrl | None = None
    affiliation: str | None = None
    country: str | None = None

    bracket_id: int | None = None
    fields: list = Field(default_factory=list)
    secret: str | None = None

UpdateSelfUserPayload

Bases: UpdatePayloadModel

Represents a self user update payload in CTFd.

Parameters:

Name Type Description Default
name str

The name of the user

 required
email str

The email of the user

 required
password str

The password of the user

 required
confirm str

The old password of the user. Must be provided if password is provided and user is not an admin

 required
old_password str

Alias for confirm

 required
language str | None

The language setting of the user

 required
website str | None

The website of the user

 required
affiliation str | None

The affiliation of the user

 required
country str | None

The country of the user

 required
bracket_id int | None

The ID of the bracket the user is in

 required
fields list

The fields of the user

 required

Attributes:

Name Type Description
name str

The name of the user
email str

The email of the user
password str

The password of the user
confirm str

The old password of the user. Must be provided if password is provided and user is not an admin
old_password str

Alias for confirm
language str | None

The language setting of the user
website str | None

The website of the user
affiliation str | None

The affiliation of the user
country str | None

The country of the user
bracket_id int | None

The ID of the bracket the user is in
fields list

The fields of the user
Source code in ctfdpy\models\users.py 
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
class UpdateSelfUserPayload(UpdatePayloadModel):
    """
    Represents a self user update payload in CTFd.

    Parameters
    ----------
    name : str
        The name of the user
    email : str
        The email of the user
    password : str
        The password of the user
    confirm : str
        The old password of the user. Must be provided if `password` is provided and user is not an admin
    old_password : str
        Alias for `confirm`
    language : str | None
        The language setting of the user
    website : str | None
        The website of the user
    affiliation : str | None
        The affiliation of the user
    country : str | None
        The country of the user
    bracket_id : int | None
        The ID of the bracket the user is in
    fields : list
        The fields of the user

    Attributes
    ----------
    name : str
        The name of the user
    email : str
        The email of the user
    password : str
        The password of the user
    confirm : str
        The old password of the user. Must be provided if `password` is provided and user is not an admin
    old_password : str
        Alias for `confirm`
    language : str | None
        The language setting of the user
    website : str | None
        The website of the user
    affiliation : str | None
        The affiliation of the user
    country : str | None
        The country of the user
    bracket_id : int | None
        The ID of the bracket the user is in
    fields : list
        The fields of the user
    """

    name: str = Field(MISSING, min_length=1, max_length=128)
    email: EmailStr = Field(MISSING, min_length=1, max_length=128)

    password: str = MISSING
    confirm: str = Field(
        MISSING, validation_alias=AliasChoices("confirm", "old_password")
    )

    language: str | None = MISSING
    website: AnyHttpUrl | None = MISSING
    affiliation: str | None = MISSING
    country: str | None = MISSING

    bracket_id: int | None = MISSING
    fields: list = MISSING

UpdateUserPayload

Bases: UpdatePayloadModel

Represents a user update payload in CTFd.

Parameters:

Name Type Description Default
name str

The name of the user

 required
email str

The email of the user

 required
password str

The password of the user

 required
confirm str

The old password of the user.

 required
old_password str

Alias for confirm

 required
type UserType

The type of the user

 required
banned bool

Whether the user is banned

 required
hidden bool

Whether the user is hidden

 required
verified bool

Whether the user is verified

 required
language str | None

The language setting of the user

 required
website str | None

The website of the user

 required
affiliation str | None

The affiliation of the user

 required
country str | None

The country of the user

 required
bracket_id int | None

The ID of the bracket the user is in

 required
fields list

The fields of the user

 required
secret str | None

Not sure what this is

 required
type UserType

The type of the user

 required
banned bool

Whether the user is banned

 required
hidden bool

Whether the user is hidden

 required
verified bool

Whether the user is verified

 required

Attributes:

Name Type Description
name str

The name of the user
email str

The email of the user
password str

The password of the user
confirm str

The old password of the user.
old_password str

Alias for confirm
type UserType

The type of the user
banned bool

Whether the user is banned
hidden bool

Whether the user is hidden
verified bool

Whether the user is verified
language str | None

The language setting of the user
website str | None

The website of the user
affiliation str | None

The affiliation of the user
country str | None

The country of the user
bracket_id int | None

The ID of the bracket the user is in
fields list

The fields of the user
secret str | None

Not sure what this is
Source code in ctfdpy\models\users.py 
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
class UpdateUserPayload(UpdatePayloadModel):
    """
    Represents a user update payload in CTFd.

    Parameters
    ----------
    name : str
        The name of the user
    email : str
        The email of the user
    password : str
        The password of the user
    confirm : str
        The old password of the user.
    old_password : str
        Alias for `confirm`
    type : UserType
        The type of the user
    banned : bool
        Whether the user is banned
    hidden : bool
        Whether the user is hidden
    verified : bool
        Whether the user is verified
    language : str | None
        The language setting of the user
    website : str | None
        The website of the user
    affiliation : str | None
        The affiliation of the user
    country : str | None
        The country of the user
    bracket_id : int | None
        The ID of the bracket the user is in
    fields : list
        The fields of the user
    secret : str | None
        Not sure what this is
    type : UserType
        The type of the user
    banned : bool
        Whether the user is banned
    hidden : bool
        Whether the user is hidden
    verified : bool
        Whether the user is verified

    Attributes
    ----------
    name : str
        The name of the user
    email : str
        The email of the user
    password : str
        The password of the user
    confirm : str
        The old password of the user.
    old_password : str
        Alias for `confirm`
    type : UserType
        The type of the user
    banned : bool
        Whether the user is banned
    hidden : bool
        Whether the user is hidden
    verified : bool
        Whether the user is verified
    language : str | None
        The language setting of the user
    website : str | None
        The website of the user
    affiliation : str | None
        The affiliation of the user
    country : str | None
        The country of the user
    bracket_id : int | None
        The ID of the bracket the user is in
    fields : list
        The fields of the user
    secret : str | None
        Not sure what this is
    """

    name: str = Field(MISSING, min_length=1, max_length=128)
    email: EmailStr = Field(MISSING, min_length=1, max_length=128)

    password: str = MISSING
    confirm: str = Field(
        MISSING, validation_alias=AliasChoices("confirm", "old_password")
    )  # since this payload is only used in admin endpoints, technically we don't need this?

    type: UserType = MISSING

    banned: bool = MISSING
    hidden: bool = MISSING
    verified: bool = MISSING

    language: str | None = MISSING
    website: AnyHttpUrl | None = MISSING
    affiliation: str | None = MISSING
    country: str | None = MISSING

    bracket_id: int | None = MISSING
    fields: list = MISSING
    secret: str | None = MISSING