Method: Add member to a Vault

Description

Add a member to a vault. Requires at least Admin privileges in the vault.

See User Capabilities and Vault Permission Bits for valid status bits.

URL Syntax

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

HTTP Method

POST

Successful HTTP Response

200

Parameters

Parameter name Description Parameter type Type Mandatory Comment
X-Http-Token StoredSafe token HTTP Header String 1) Preferred method
token StoredSafe token JSON-encoded String 1) Legacy method
vault-id Vault-id of the Vault URL-paramater Integer Yes  
user-id User-id of the new member URL-paramater Integer Yes  
status Permission for the new member JSON-encoded 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.message Message from handler (if successful) String
CALLINFO.token StoredSafe token to be used in subsequent calls String
DATA Supplied data in API-call Object
PARAMS PARAMS (empty) Object
ERRORCODES Error code and text (Only present if errors) Object
ERRORS Error code and text (Only present if errors) Array

Examples

Add a new member (userid 12) with Admin permission to the vault 178.

Request

POST /api/1.0/vault/178/member/12
x-http-token: your_storedsafe_token
{
  "status": 2
}

Response

HTTP/2 200
Content-type: application/json; charset=UTF-8
{
    "CALLINFO": {
        "errorcodes": 0,
        "errors": 0,
        "general": [],
        "handler": "VaultmembersHandler",
        "message": "User added",
        "status": "SUCCESS",
        "token": "rotated_storedsafe_token"
    },
    "DATA": {
        "status": 2,
        "token": "your_storedsafe_token"
    },
    "HEADERS": {
        "Accept": "*/*",
        "Content-Length": "15",
        "Content-Type": "application/x-www-form-urlencoded",
        "Host": "safe.domain.cc",
        "User-Agent": "curl/7.64.1",
        "X-Http-Token": "your_storedsafe_token"
    },
    "PARAMS": []
}