v1

latestOpenAPI 3.0.02026-07-17166300328.1 KB

Users

Get user by ID

get/admin/users/view/{userId}

Path parameters

userIdstring required

Example:12345

Numeric ID of the user

Response

Extended user response

idstring

org_idstring

server_idstring

emailstring email

autoalertboolean

authkeystring nullable

API auth key used for the API, only set if MISP setting Security.advanced_authkeys is set to false.

invited_bystring

gpgkeystring nullable

certif_publicstring nullable

nids_sidstring

termsacceptedboolean

newsreadstring

role_idstring

change_pw'0' | '1'

Password change required.

contactalertboolean

disabledboolean

expirationstring date-time nullable

current_loginstring

last_loginstring

force_logoutboolean

date_createdstring

date_modifiedstring

Example response

{
  "id": "12345",
  "org_id": "12345",
  "server_id": "12345",
  "authkey": "894c8d095180c7ea28789092e96ca6424199aa4f",
  "invited_by": "12345",
  "nids_sid": "4000000",
  "newsread": "1617875568",
  "role_id": "3",
  "current_login": "1617875568",
  "last_login": "1617875568",
  "date_created": "1617875568",
  "date_modified": "1617875568",
  "User": {
    "id": "12345",
    "org_id": "12345",
    "server_id": "12345",
    "authkey": "894c8d095180c7ea28789092e96ca6424199aa4f",
    "invited_by": "12345",
    "nids_sid": "4000000",
    "newsread": "1617875568",
    "role_id": "3",
    "current_login": "1617875568",
    "last_login": "1617875568",
    "date_created": "1617875568",
    "date_modified": "1617875568"
  },
  "Role": {
    "id": "3",
    "name": "ORGNAME",
    "permission": "3",
    "permission_description": "publish"
  },
  "UserSetting": {
    "dashboard": [
      {
        "widget": "MispStatusWidget",
        "position": {
          "x": "0",
          "y": "0",
          "width": "2",
          "height": "2"
        }
      }
    ],
    "homepage": {
      "path": "/events/index"
    },
    "event_index_hide_columns": [
      "clusters"
    ]
  }
}