Users
Reset user password:
POST
https://misp.local/users/initiatePasswordReset/{userId}/{firstTimeReset}
Response:
200:
{
"saved": true,
"success": "New credentials sent."
}403:
{
"name": "Authentication failed. Please make sure you pass the API key of an API enabled user along in the Authorization header.",
"message": "Authentication failed. Please make sure you pass the API key of an API enabled user along in the Authorization header.",
"url": "/attributes"
}404:
{
"name": "Invalid attribute",
"message": "Invalid attribute",
"url": "/attributes/1234"
}Default:
{
"name": "string",
"message": "string",
"url": "/attributes"
}Add user:
POST
https://misp.local/users/initiatePasswordReset/{userId}/{firstTimeReset}
Request:
{
"org_id": "12345",
"server_id": "12345",
"email": "[email protected]",
"autoalert": true,
"authkey": "894c8d095180c7ea28789092e96ca6424199aa4f",
"invited_by": "12345",
"gpgkey": "string",
"certif_public": "string",
"nids_sid": "4000000",
"termsaccepted": true,
"newsread": "1617875568",
"role_id": "3",
"change_pw": "0",
"contactalert": true,
"disabled": true,
"expiration": "2019-08-24T14:15:22Z",
"current_login": "1617875568",
"last_login": "1617875568",
"force_logout": true,
"date_created": "1617875568",
"date_modified": "1617875568"
}Response:
200:
{
"id": "12345",
"org_id": "12345",
"server_id": "12345",
"email": "[email protected]",
"autoalert": true,
"authkey": "894c8d095180c7ea28789092e96ca6424199aa4f",
"invited_by": "12345",
"gpgkey": "string",
"certif_public": "string",
"nids_sid": "4000000",
"termsaccepted": true,
"newsread": "1617875568",
"role_id": "3",
"change_pw": "0",
"contactalert": true,
"disabled": true,
"expiration": "2019-08-24T14:15:22Z",
"current_login": "1617875568",
"last_login": "1617875568",
"force_logout": true,
"date_created": "1617875568",
"date_modified": "1617875568"
}403:
{
"name": "Authentication failed. Please make sure you pass the API key of an API enabled user along in the Authorization header.",
"message": "Authentication failed. Please make sure you pass the API key of an API enabled user along in the Authorization header.",
"url": "/attributes"
}404:
{
"name": "Invalid attribute",
"message": "Invalid attribute",
"url": "/attributes/1234"
}Default:
{
"name": "string",
"message": "string",
"url": "/attributes"
}Edit user:
PUT
https://misp.local/admin/users/edit/{userId}
Request:
{
"id": "12345",
"org_id": "12345",
"server_id": "12345",
"email": "[email protected]",
"autoalert": true,
"authkey": "894c8d095180c7ea28789092e96ca6424199aa4f",
"invited_by": "12345",
"gpgkey": "string",
"certif_public": "string",
"nids_sid": "4000000",
"termsaccepted": true,
"newsread": "1617875568",
"role_id": "3",
"change_pw": "0",
"contactalert": true,
"disabled": true,
"expiration": "2019-08-24T14:15:22Z",
"current_login": "1617875568",
"last_login": "1617875568",
"force_logout": true,
"date_created": "1617875568",
"date_modified": "1617875568"
}Response:
200:
{
"id": "12345",
"org_id": "12345",
"server_id": "12345",
"email": "[email protected]",
"autoalert": true,
"authkey": "894c8d095180c7ea28789092e96ca6424199aa4f",
"invited_by": "12345",
"gpgkey": "string",
"certif_public": "string",
"nids_sid": "4000000",
"termsaccepted": true,
"newsread": "1617875568",
"role_id": "3",
"change_pw": "0",
"contactalert": true,
"disabled": true,
"expiration": "2019-08-24T14:15:22Z",
"current_login": "1617875568",
"last_login": "1617875568",
"force_logout": true,
"date_created": "1617875568",
"date_modified": "1617875568"
}403:
{
"name": "Authentication failed. Please make sure you pass the API key of an API enabled user along in the Authorization header.",
"message": "Authentication failed. Please make sure you pass the API key of an API enabled user along in the Authorization header.",
"url": "/attributes"
}404:
{
"name": "Invalid attribute",
"message": "Invalid attribute",
"url": "/attributes/1234"
}Default:
{
"name": "string",
"message": "string",
"url": "/attributes"
}Delete user:
DELETE
https://misp.local/admin/users/delete/{userId}
Response:
200:
{
"saved": true,
"success": true,
"name": "User deleted.",
"message": "User deleted.",
"url": "/admin/users/delete/1"
}403:
{
"name": "Authentication failed. Please make sure you pass the API key of an API enabled user along in the Authorization header.",
"message": "Authentication failed. Please make sure you pass the API key of an API enabled user along in the Authorization header.",
"url": "/attributes"
}404:
{
"name": "Invalid attribute",
"message": "Invalid attribute",
"url": "/attributes/1234"
}Default:
{
"name": "string",
"message": "string",
"url": "/attributes"
}Get users:
GET
https://misp.local/admin/users
Response:
200:
[
{
"User": {
"id": "12345",
"org_id": "12345",
"server_id": "12345",
"email": "[email protected]",
"autoalert": true,
"authkey": "894c8d095180c7ea28789092e96ca6424199aa4f",
"invited_by": "12345",
"gpgkey": "string",
"certif_public": "string",
"nids_sid": "4000000",
"termsaccepted": true,
"newsread": "1617875568",
"role_id": "3",
"change_pw": "0",
"contactalert": true,
"disabled": true,
"expiration": "2019-08-24T14:15:22Z",
"current_login": "1617875568",
"last_login": "1617875568",
"force_logout": true,
"date_created": "1617875568",
"date_modified": "1617875568"
},
"Role": {
"id": "3",
"name": "ORGNAME",
"perm_add": true,
"perm_modify": true,
"perm_modify_org": true,
"perm_publish": true,
"perm_delegate": true,
"perm_sync": true,
"perm_admin": true,
"perm_audit": true,
"perm_auth": true,
"perm_site_admin": true,
"perm_regexp_access": true,
"perm_tagger": true,
"perm_template": true,
"perm_sharing_group": true,
"perm_tag_editor": true,
"perm_sighting": true,
"perm_object_template": true,
"perm_publish_zmq": true,
"perm_publish_kafka": true,
"perm_decaying": true,
"perm_galaxy_editor": true,
"default_role": true,
"memory_limit": "string",
"max_execution_time": "string",
"restricted_to_site_admin": true,
"enforce_rate_limit": true,
"rate_limit_count": "string",
"permission": "3",
"permission_description": "publish"
},
"Organisation": {
"id": "12345",
"name": "ORGNAME"
}
}
]403:
{
"name": "Authentication failed. Please make sure you pass the API key of an API enabled user along in the Authorization header.",
"message": "Authentication failed. Please make sure you pass the API key of an API enabled user along in the Authorization header.",
"url": "/attributes"
}404:
{
"name": "Invalid attribute",
"message": "Invalid attribute",
"url": "/attributes/1234"
}Default:
{
"name": "string",
"message": "string",
"url": "/attributes"
}Get user by ID:
GET
https://misp.local/admin/users/view/{userId}
Response:
200:
{
"id": "12345",
"org_id": "12345",
"server_id": "12345",
"email": "[email protected]",
"autoalert": true,
"authkey": "894c8d095180c7ea28789092e96ca6424199aa4f",
"invited_by": "12345",
"gpgkey": "string",
"certif_public": "string",
"nids_sid": "4000000",
"termsaccepted": true,
"newsread": "1617875568",
"role_id": "3",
"change_pw": "0",
"contactalert": true,
"disabled": true,
"expiration": "2019-08-24T14:15:22Z",
"current_login": "1617875568",
"last_login": "1617875568",
"force_logout": true,
"date_created": "1617875568",
"date_modified": "1617875568",
"User": {
"id": "12345",
"org_id": "12345",
"server_id": "12345",
"email": "[email protected]",
"autoalert": true,
"authkey": "894c8d095180c7ea28789092e96ca6424199aa4f",
"invited_by": "12345",
"gpgkey": "string",
"certif_public": "string",
"nids_sid": "4000000",
"termsaccepted": true,
"newsread": "1617875568",
"role_id": "3",
"change_pw": "0",
"contactalert": true,
"disabled": true,
"expiration": "2019-08-24T14:15:22Z",
"current_login": "1617875568",
"last_login": "1617875568",
"force_logout": true,
"date_created": "1617875568",
"date_modified": "1617875568"
},
"Role": {
"id": "3",
"name": "ORGNAME",
"perm_add": true,
"perm_modify": true,
"perm_modify_org": true,
"perm_publish": true,
"perm_delegate": true,
"perm_sync": true,
"perm_admin": true,
"perm_audit": true,
"perm_auth": true,
"perm_site_admin": true,
"perm_regexp_access": true,
"perm_tagger": true,
"perm_template": true,
"perm_sharing_group": true,
"perm_tag_editor": true,
"perm_sighting": true,
"perm_object_template": true,
"perm_publish_zmq": true,
"perm_publish_kafka": true,
"perm_decaying": true,
"perm_galaxy_editor": true,
"default_role": true,
"memory_limit": "string",
"max_execution_time": "string",
"restricted_to_site_admin": true,
"enforce_rate_limit": true,
"rate_limit_count": "string",
"permission": "3",
"permission_description": "publish"
},
"UserSetting": {
"publish_alert_filter": [
{
"AND": [
{
"NOT": [
{
"EventTag.name": [
"%osint%"
]
}
]
},
{
"OR": [
{
"Tag.name": [
"tlp:green",
"tlp:amber",
"tlp:red",
"%privint%"
]
}
]
}
]
}
],
"dashboard_access": true,
"dashboard": [
{
"widget": "MispStatusWidget",
"position": {
"x": "0",
"y": "0",
"width": "2",
"height": "2"
}
}
],
"homepage": {
"path": "/events/index"
},
"default_restsearch_parameters": [
{
"AND": [
{
"NOT": [
{
"EventTag.name": [
"%osint%"
]
}
]
},
{
"OR": [
{
"Tag.name": [
"tlp:green",
"tlp:amber",
"tlp:red",
"%privint%"
]
}
]
}
]
}
],
"tag_numerical_value_override": [
{
"false-positive:risk='medium'": 99
}
],
"event_index_hide_columns": [
"clusters"
]
}
}403:
{
"name": "Authentication failed. Please make sure you pass the API key of an API enabled user along in the Authorization header.",
"message": "Authentication failed. Please make sure you pass the API key of an API enabled user along in the Authorization header.",
"url": "/attributes"
}404:
{
"name": "Invalid attribute",
"message": "Invalid attribute",
"url": "/attributes/1234"
}Default:
{
"name": "string",
"message": "string",
"url": "/attributes"
}Delete user TOTP:
DELETE
https://misp.local/users/totp_delete/{userId}
Response:
200:
{
"saved": true,
"success": true,
"name": "User TOTP deleted.",
"message": "User TOTP deleted.",
"url": "/users/totp_delete/1",
"id": "1"
}403:
{
"name": "Authentication failed. Please make sure you pass the API key of an API enabled user along in the Authorization header.",
"message": "Authentication failed. Please make sure you pass the API key of an API enabled user along in the Authorization header.",
"url": "/attributes"
}404:
{
"name": "Invalid user",
"message": "Invalid user",
"url": "/users/totp_delete/1"
}Default:
{
"name": "string",
"message": "string",
"url": "/attributes"
}