Models - Hoodbluck/authum-doc GitHub Wiki
These represent common model structures for data interaction on the "Authum" app.
User
This model represents Authum users.
| Field | Type | Description |
|---|---|---|
userId |
long |
User's id. |
firstName |
string |
User's first name. |
lastName |
string |
User's last name. |
email |
string |
User's email. |
password |
string |
User's password. |
deviceToken |
string |
User's device token. |
Client
This model represents Authum clients (third-party applications).
| Field | Type | Description |
|---|---|---|
clientId |
string |
Client's id. |
name |
string |
Client's id. |
AuthumResponse
This is a generic response model returned for diverse API actions in Authum, targeted for the mobile applications.
| Field | Type | Description |
|---|---|---|
code |
integer |
Status of the action, -1 = failure, 0 = success, 1 = warning |
status |
string |
Response code, this code should be specified on the API process definition. |
value |
string |
Response value, this is an optional field to return information. |
Note: A status 1 means that the process did successfully executed but there is optional information that may be exposed to the user.