User APIs
Below is a comprehensive list of user-related APIs that serve various purposes such as user info and user update.
Update the user with either new data or update their own password.
| Key | Type | Example |
|---|---|---|
| authorization | string |
"Bearer 1Z1105da2bac3190b757792066e83f6f3aZ0efa92ae3aebdd6079fa2f328f4dfe2a" |
| Key | Type | Example |
|---|---|---|
| firstname | string |
"Joe" |
| lastname | string |
"Do" |
password optional |
string |
"newpassword" |
{
"username": "joe",
"firstname": "Joe",
"lastname": "Do",
"_meta": {
"guid": "39336c0c7cec1c89f617ed704b34c2ad39336c0c7cec1c89f617ed704b34c2ad"
}
}
{
"success": false,
"error": "ERROR_KEY"
}
| Error Code | Description |
|---|---|
| NO_BODY_GIVEN | The request did not include a body, so no updates were performed. |
| NO_MUTATIONS_GIVEN | No mutations were provided in the request, so no changes were applied. |
This requests a password reset for a user
| Key | Type | Example |
|---|---|---|
| username | string |
"Joe_do" |
string |
"Joe@example.com" |
|
| host | string |
"host.1" |
{
"msg": "ok"
}
{
"succes": false,
"error": "ERROR_KEY"
}
| Error Code | Description |
|---|---|
| INVALID_BODY | The request body does not meet the API's expected format. |
| EMPTY_BODY | The request body is missing |
| TOKEN_OR_EMAIL_NOT_SET | no postmark token or email was set in the settings |
users/me
GET
This request returns your own user document
{
"custom_scopes": [
"*"
],
"username": "JoeDo357",
"firstname": "Joe",
"lastname": "Do",
"email": "Joe_do@example.com",
"permissions_group": "developer",
"settings": [
{
"key": "blueprints_allow_run_prod_button",
"value": "on"
},
{
"key": "setting_edit_blueprints",
"value": "on"
},
{
"key": "setting_save_blueprints",
"value": "on"
},
{
"key": "setting_blueprint_view_all",
"value": "on"
},
{
"key": "setting_deploy_blueprints",
"value": "on"
},
{
"key": "system_cluster_stats",
"value": "on"
},
{
"key": "manage_local_devices",
"value": "on"
},
{
"key": "setting_deploy_blueprints_on_save",
"value": "on"
},
{
"key": "setting_activate_blueprints",
"value": "ons"
}
],
"require_twofactor_auth": false,
"last_activity_date": 1740493764,
"device_token": "a3f8d9c2b4e1f607a9b5d8c4e3a1f2b607c9d8e7a5f4b3c1d",
"device_type": "ios",
"last_activity": 1740878954,
"_meta": {
"guid": "b67c9a81f3d5e42a987b2c6d4f8e3a5c7d1f4b9a2c3e8d7a5f6b3c4e1d9f8a2b",
"expiry": -1,
"entity": 61,
"removed": 0,
"created": 1740493464,
"updated": 1740878954,
"ums": 1740878954166,
"cms": 1740493464393,
"update_hash": "9e4c6a3d8b1f2a7d5c8e4f3b9a2d7f6c1e3a5b8d4c2e7f9a1b6d3c4e8f7a5b2c"
},
"websocket_id": null
}
{
"succes": false,
"error": "ERROR_KEY"
}