Auth key
Get auth keys:
POST
https://misp.local/auth_keys
Request:
[
{
"AuthKey": {
"id": "12345",
"uuid": "c99506a6-1255-4b71-afa5-7b8ba48c3b1b",
"authkey_start": "stri",
"authkey_end": "stri",
"created": "1617875568",
"expiration": "1970-01-01 00:00:00",
"read_only": true,
"user_id": "12345",
"comment": "string",
"allowed_ips": [
"127.0.0.1"
],
"last_used": "1617875568"
},
"User": {
"id": "12345",
"email": "[email protected]"
}
}
]Response:
200:
[
{
"Log": {
"id": "12345",
"title": "Attribute (448272) from Event (1): Other/text foo",
"created": "string",
"model": "AdminSetting",
"model_id": "12345",
"action": "accept",
"user_id": "12345",
"change": "name () => (ORGNAME)",
"email": "[email protected]",
"org": "ORGNAME",
"description": "Organisation \"ORGNAME\" (1) added by User \"SYSTEM\" (0).",
"ip": "10.0.0.10"
}
}
]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"
}Search auth keys:
POST
https://misp.local/auth_keys
Request:
{
"page": 1,
"limit": 0,
"id": "12345",
"uuid": "c99506a6-1255-4b71-afa5-7b8ba48c3b1b",
"authkey_start": "string",
"authkey_end": "string",
"created": "string",
"expiration": "string",
"read_only": true,
"user_id": "12345",
"comment": "string",
"allowed_ips": "[\"127.0.0.1\",\"127.0.0.2\"]",
"last_used": "string"
}Response:
200:
[
{
"AuthKey": {
"id": "12345",
"uuid": "c99506a6-1255-4b71-afa5-7b8ba48c3b1b",
"authkey_start": "stri",
"authkey_end": "stri",
"created": "1617875568",
"expiration": "1970-01-01 00:00:00",
"read_only": true,
"user_id": "12345",
"comment": "string",
"allowed_ips": [
"127.0.0.1"
],
"last_used": "1617875568"
},
"User": {
"id": "12345",
"email": "[email protected]"
}
}
]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 auth keys:
POST
https://misp.local/auth_keys/add/{userId}
Request:
{
"uuid": "c99506a6-1255-4b71-afa5-7b8ba48c3b1b",
"read_only": true,
"user_id": "12345",
"comment": "string",
"allowed_ips": [
"127.0.0.1"
]
}Response:
200:
{
"AuthKey": {
"id": "12345",
"uuid": "c99506a6-1255-4b71-afa5-7b8ba48c3b1b",
"authkey_start": "stri",
"authkey_end": "stri",
"created": "1617875568",
"expiration": "1970-01-01 00:00:00",
"read_only": true,
"user_id": "12345",
"comment": "string",
"allowed_ips": [
"127.0.0.1"
],
"last_used": "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"
}View auth key:
GET
https://misp.local/auth_keys/add/{userId}
Response:
200:
{
"AuthKey": {
"id": "12345",
"uuid": "c99506a6-1255-4b71-afa5-7b8ba48c3b1b",
"authkey_start": "stri",
"authkey_end": "stri",
"created": "1617875568",
"expiration": "1970-01-01 00:00:00",
"read_only": true,
"user_id": "12345",
"comment": "string",
"allowed_ips": [
"127.0.0.1"
],
"last_used": "1617875568"
},
"User": {
"id": "12345",
"org_id": "12345",
"email": "[email protected]"
}
}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 auth key:
POST
https://misp.local/auth_keys/add/{userId}
Request:
{
"read_only": true,
"comment": "string",
"allowed_ips": [
"127.0.0.1"
]
}Response:
200:
{
"AuthKey": {
"id": "12345",
"uuid": "c99506a6-1255-4b71-afa5-7b8ba48c3b1b",
"authkey_start": "stri",
"authkey_end": "stri",
"created": "1617875568",
"expiration": "1970-01-01 00:00:00",
"read_only": true,
"user_id": "12345",
"comment": "string",
"allowed_ips": [
"127.0.0.1"
],
"last_used": "1617875568"
},
"User": {
"id": "12345",
"org_id": "12345",
"email": "[email protected]"
}
}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 auth key:
DELETE
https://misp.local/auth_keys/delete/{authKeyId}
Response:
200:
{
"saved": true,
"success": true,
"name": "AuthKey deleted.",
"message": "AuthKey deleted.",
"url": "/auth_keys/delete/1234"
}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"
}