Method: Delete User

Description

Delete a StoredSafe user.

Note

This requires Admin capabilities.

URL Syntax

/api/{version}/user/:user-id

HTTP Method

DELETE

Successful HTTP Response

200

Parameters

Parameter name Description Parameter type Type Requirements Mandatory Comment
X-Http-Token StoredSafe token HTTP Header String   1) Preferred method
token StoredSafe token JSON-encoded String   1) Legacy method
user-id User-ID URL-parameter Integer   Yes  

Note

1) One of the methods is required.

Response Attributes

Attribute Description Type
CALLINFO.errorcodes Number of errors Integer
CALLINFO.errors Number of errors Integer
CALLINFO.general Information Array
CALLINFO.handler Handler used String
CALLINFO.status SUCCESS or FAIL String
CALLINFO.statusbits.userbits.(capability) Statusbits (users) Integer
CALLINFO.statusbits.vaultbits.(permission) Statusbits (vaults) Integer
CALLINFO.token StoredSafe token to be used in subsequent calls String
DATA Supplied data in prior API-call String
HEADERS.(headers) HTTP Headers String
PARAMS Route parameters (empty) Array
ERRORCODES Error code and text (Only present if errors) Object
ERRORS Error code and text (Only present if errors) Array

Examples

Delete the user, Mr Foo Manchu, User-ID 149

Request

DELETE /api/1.0/user/149
x-http-token: your_storedsafe_token

Response

FIXME

HTTP/2 201
Content-type: application/json; charset=UTF-8
{
    "CALLINFO": {
        "errorcodes": 0,
        "errors": 0,
        "general": [],
        "handler": "UserHandler",
        "status": "SUCCESS",
        "token": "rotated_storedsafe_token",
        "user_created": "Foo Manchu"
    },
    "DATA": {
        "token": "your_storedsafe_token",
    },
    "HEADERS": {
        "Accept": "*/*",
        "Content-Length": "169",
        "Content-Type": "application/json",
        "Host": "safe.domain.cc",
        "User-Agent": "curl/7.64.1",
        "X-Http-Token": "your_storedsafe_token"
    },
    "PARAMS": []
}