32 lines
1.5 KiB
Plaintext
32 lines
1.5 KiB
Plaintext
# Proposer (object)
|
|
Representation of an app user who proposed an awarding or a promotion
|
|
|
|
## Properties
|
|
|
|
+ _id: `5abf5064861d950f157c4a09` (string, required) - unique id of the app user
|
|
+ username: `hardiready` (string, required) - username of the app user
|
|
+ squad: `591470249e9fae286e308e41` (string, required) - squad id associated with the app user
|
|
|
|
# AppUser (Proposer)
|
|
An app user instance with populated squad
|
|
|
|
## Properties
|
|
+ activated: true (boolean, required) - account activation status
|
|
+ password: `$1s23$1$H7dl7RTFZUBIBNUZ213IIOUasdNEI571sMuzXmzi4` (string, required) - password hash value
|
|
+ permission: 1 (number, required) - permission level
|
|
+ secret: `I like tacos` (string, required) - secret used for account activation comparison
|
|
+ squad (Squad, required, nullable) - squad the app user is responsible for
|
|
+ timestamp: `2017-08-02T07:48:56.378Z` (string, required) - creation timestamp
|
|
+ updatedAt: `2017-08-02T08:07:20.929Z` (string, required) - version timestamp
|
|
+ __v: 3 (number, required) - version number
|
|
|
|
# UpdateAppUser (Proposer)
|
|
An app user instance for PATCH updating
|
|
|
|
## Properties
|
|
+ activated: true (boolean, optional) - account activation status
|
|
+ password: `$1s23$1$H7dl7RTFZUBIBNUZ213IIOUasdNEI571sMuzXmzi4` (string, optional) - password hash value
|
|
+ permission: 1 (number, optional) - permission level
|
|
+ secret: `I like tacos` (string, optional) - secret used for account activation comparison
|
|
+ squad: `5abe166f8b7488392a623f12` (string, optional) - id of squad the app user is responsible for
|