opt-cc/api/apib/data_structures/_app-user.apib

32 lines
1.5 KiB
Plaintext
Raw Normal View History

2018-03-25 20:44:19 +02:00
# Proposer (object)
Representation of an app user who proposed an awarding or a promotion
## Properties
2018-04-01 16:01:43 +02:00
+ _id: `5abf5064861d950f157c4a09` (string, required) - unique id of the app user
2018-03-25 20:44:19 +02:00
+ username: `hardiready` (string, required) - username of the app user
+ squad: `591470249e9fae286e308e41` (string, required) - squad id associated with the app user
2018-04-01 16:01:43 +02:00
# AppUser (Proposer)
An app user instance with populated squad
## Properties
+ activated: true (boolean, required) - account activation status
2018-04-02 10:38:16 +02:00
+ password: `$1s23$1$H7dl7RTFZUBIBNUZ213IIOUasdNEI571sMuzXmzi4` (string, required) - password hash value
2018-04-01 16:01:43 +02:00
+ permission: 1 (number, required) - permission level
2018-04-02 10:38:16 +02:00
+ secret: `I like tacos` (string, required) - secret used for account activation comparison
2018-04-01 16:01:43 +02:00
+ 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
2018-04-02 10:38:16 +02:00
+ password: `$1s23$1$H7dl7RTFZUBIBNUZ213IIOUasdNEI571sMuzXmzi4` (string, optional) - password hash value
2018-04-01 16:01:43 +02:00
+ permission: 1 (number, optional) - permission level
2018-04-02 10:38:16 +02:00
+ secret: `I like tacos` (string, optional) - secret used for account activation comparison
2018-04-01 16:01:43 +02:00
+ squad: `5abe166f8b7488392a623f12` (string, optional) - id of squad the app user is responsible for