cURL
curl --request PUT \
--url https://api.useanima.sh/v1/vault/credentials/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"agentId": "<string>",
"reveal": false,
"name": "<string>",
"notes": "<string>",
"login": {
"username": "<string>",
"password": "<string>",
"uris": [
{
"uri": "<string>"
}
],
"totp": "<string>"
},
"card": {
"cardholderName": "<string>",
"brand": "<string>",
"number": "<string>",
"expMonth": "<string>",
"expYear": "<string>",
"code": "<string>"
},
"identity": {
"firstName": "<string>",
"lastName": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"address1": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>",
"company": "<string>",
"ssn": "<string>"
},
"oauthToken": {
"provider": "<string>",
"accessToken": "<string>",
"refreshToken": "<string>",
"tokenEndpoint": "<string>",
"clientId": "<string>",
"clientSecret": "<string>",
"scopes": [
"<string>"
],
"expiresAt": "2023-11-07T05:31:56Z",
"autoRefresh": true,
"allowedHosts": [
"<string>"
]
},
"apiKey": {
"provider": "<string>",
"key": "<string>",
"prefix": "<string>",
"expiresAt": "2023-11-07T05:31:56Z",
"scopes": [
"<string>"
],
"allowedHosts": [
"<string>"
],
"authHeader": "<string>",
"authScheme": "<string>"
},
"certificate": {
"certificate": "<string>",
"privateKey": "<string>",
"chain": [
"<string>"
],
"expiresAt": "2023-11-07T05:31:56Z"
},
"fields": [
{
"name": "<string>",
"value": "<string>"
}
],
"favorite": true
}
'import requests
url = "https://api.useanima.sh/v1/vault/credentials/{id}"
payload = {
"agentId": "<string>",
"reveal": False,
"name": "<string>",
"notes": "<string>",
"login": {
"username": "<string>",
"password": "<string>",
"uris": [{ "uri": "<string>" }],
"totp": "<string>"
},
"card": {
"cardholderName": "<string>",
"brand": "<string>",
"number": "<string>",
"expMonth": "<string>",
"expYear": "<string>",
"code": "<string>"
},
"identity": {
"firstName": "<string>",
"lastName": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"address1": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>",
"company": "<string>",
"ssn": "<string>"
},
"oauthToken": {
"provider": "<string>",
"accessToken": "<string>",
"refreshToken": "<string>",
"tokenEndpoint": "<string>",
"clientId": "<string>",
"clientSecret": "<string>",
"scopes": ["<string>"],
"expiresAt": "2023-11-07T05:31:56Z",
"autoRefresh": True,
"allowedHosts": ["<string>"]
},
"apiKey": {
"provider": "<string>",
"key": "<string>",
"prefix": "<string>",
"expiresAt": "2023-11-07T05:31:56Z",
"scopes": ["<string>"],
"allowedHosts": ["<string>"],
"authHeader": "<string>",
"authScheme": "<string>"
},
"certificate": {
"certificate": "<string>",
"privateKey": "<string>",
"chain": ["<string>"],
"expiresAt": "2023-11-07T05:31:56Z"
},
"fields": [
{
"name": "<string>",
"value": "<string>"
}
],
"favorite": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
agentId: '<string>',
reveal: false,
name: '<string>',
notes: '<string>',
login: {
username: '<string>',
password: '<string>',
uris: [{uri: '<string>'}],
totp: '<string>'
},
card: {
cardholderName: '<string>',
brand: '<string>',
number: '<string>',
expMonth: '<string>',
expYear: '<string>',
code: '<string>'
},
identity: {
firstName: '<string>',
lastName: '<string>',
email: 'jsmith@example.com',
phone: '<string>',
address1: '<string>',
city: '<string>',
state: '<string>',
postalCode: '<string>',
country: '<string>',
company: '<string>',
ssn: '<string>'
},
oauthToken: {
provider: '<string>',
accessToken: '<string>',
refreshToken: '<string>',
tokenEndpoint: '<string>',
clientId: '<string>',
clientSecret: '<string>',
scopes: ['<string>'],
expiresAt: '2023-11-07T05:31:56Z',
autoRefresh: true,
allowedHosts: ['<string>']
},
apiKey: {
provider: '<string>',
key: '<string>',
prefix: '<string>',
expiresAt: '2023-11-07T05:31:56Z',
scopes: ['<string>'],
allowedHosts: ['<string>'],
authHeader: '<string>',
authScheme: '<string>'
},
certificate: {
certificate: '<string>',
privateKey: '<string>',
chain: ['<string>'],
expiresAt: '2023-11-07T05:31:56Z'
},
fields: [{name: '<string>', value: '<string>'}],
favorite: true
})
};
fetch('https://api.useanima.sh/v1/vault/credentials/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.useanima.sh/v1/vault/credentials/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'agentId' => '<string>',
'reveal' => false,
'name' => '<string>',
'notes' => '<string>',
'login' => [
'username' => '<string>',
'password' => '<string>',
'uris' => [
[
'uri' => '<string>'
]
],
'totp' => '<string>'
],
'card' => [
'cardholderName' => '<string>',
'brand' => '<string>',
'number' => '<string>',
'expMonth' => '<string>',
'expYear' => '<string>',
'code' => '<string>'
],
'identity' => [
'firstName' => '<string>',
'lastName' => '<string>',
'email' => 'jsmith@example.com',
'phone' => '<string>',
'address1' => '<string>',
'city' => '<string>',
'state' => '<string>',
'postalCode' => '<string>',
'country' => '<string>',
'company' => '<string>',
'ssn' => '<string>'
],
'oauthToken' => [
'provider' => '<string>',
'accessToken' => '<string>',
'refreshToken' => '<string>',
'tokenEndpoint' => '<string>',
'clientId' => '<string>',
'clientSecret' => '<string>',
'scopes' => [
'<string>'
],
'expiresAt' => '2023-11-07T05:31:56Z',
'autoRefresh' => true,
'allowedHosts' => [
'<string>'
]
],
'apiKey' => [
'provider' => '<string>',
'key' => '<string>',
'prefix' => '<string>',
'expiresAt' => '2023-11-07T05:31:56Z',
'scopes' => [
'<string>'
],
'allowedHosts' => [
'<string>'
],
'authHeader' => '<string>',
'authScheme' => '<string>'
],
'certificate' => [
'certificate' => '<string>',
'privateKey' => '<string>',
'chain' => [
'<string>'
],
'expiresAt' => '2023-11-07T05:31:56Z'
],
'fields' => [
[
'name' => '<string>',
'value' => '<string>'
]
],
'favorite' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.useanima.sh/v1/vault/credentials/{id}"
payload := strings.NewReader("{\n \"agentId\": \"<string>\",\n \"reveal\": false,\n \"name\": \"<string>\",\n \"notes\": \"<string>\",\n \"login\": {\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"uris\": [\n {\n \"uri\": \"<string>\"\n }\n ],\n \"totp\": \"<string>\"\n },\n \"card\": {\n \"cardholderName\": \"<string>\",\n \"brand\": \"<string>\",\n \"number\": \"<string>\",\n \"expMonth\": \"<string>\",\n \"expYear\": \"<string>\",\n \"code\": \"<string>\"\n },\n \"identity\": {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"address1\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"company\": \"<string>\",\n \"ssn\": \"<string>\"\n },\n \"oauthToken\": {\n \"provider\": \"<string>\",\n \"accessToken\": \"<string>\",\n \"refreshToken\": \"<string>\",\n \"tokenEndpoint\": \"<string>\",\n \"clientId\": \"<string>\",\n \"clientSecret\": \"<string>\",\n \"scopes\": [\n \"<string>\"\n ],\n \"expiresAt\": \"2023-11-07T05:31:56Z\",\n \"autoRefresh\": true,\n \"allowedHosts\": [\n \"<string>\"\n ]\n },\n \"apiKey\": {\n \"provider\": \"<string>\",\n \"key\": \"<string>\",\n \"prefix\": \"<string>\",\n \"expiresAt\": \"2023-11-07T05:31:56Z\",\n \"scopes\": [\n \"<string>\"\n ],\n \"allowedHosts\": [\n \"<string>\"\n ],\n \"authHeader\": \"<string>\",\n \"authScheme\": \"<string>\"\n },\n \"certificate\": {\n \"certificate\": \"<string>\",\n \"privateKey\": \"<string>\",\n \"chain\": [\n \"<string>\"\n ],\n \"expiresAt\": \"2023-11-07T05:31:56Z\"\n },\n \"fields\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"favorite\": true\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.useanima.sh/v1/vault/credentials/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"agentId\": \"<string>\",\n \"reveal\": false,\n \"name\": \"<string>\",\n \"notes\": \"<string>\",\n \"login\": {\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"uris\": [\n {\n \"uri\": \"<string>\"\n }\n ],\n \"totp\": \"<string>\"\n },\n \"card\": {\n \"cardholderName\": \"<string>\",\n \"brand\": \"<string>\",\n \"number\": \"<string>\",\n \"expMonth\": \"<string>\",\n \"expYear\": \"<string>\",\n \"code\": \"<string>\"\n },\n \"identity\": {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"address1\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"company\": \"<string>\",\n \"ssn\": \"<string>\"\n },\n \"oauthToken\": {\n \"provider\": \"<string>\",\n \"accessToken\": \"<string>\",\n \"refreshToken\": \"<string>\",\n \"tokenEndpoint\": \"<string>\",\n \"clientId\": \"<string>\",\n \"clientSecret\": \"<string>\",\n \"scopes\": [\n \"<string>\"\n ],\n \"expiresAt\": \"2023-11-07T05:31:56Z\",\n \"autoRefresh\": true,\n \"allowedHosts\": [\n \"<string>\"\n ]\n },\n \"apiKey\": {\n \"provider\": \"<string>\",\n \"key\": \"<string>\",\n \"prefix\": \"<string>\",\n \"expiresAt\": \"2023-11-07T05:31:56Z\",\n \"scopes\": [\n \"<string>\"\n ],\n \"allowedHosts\": [\n \"<string>\"\n ],\n \"authHeader\": \"<string>\",\n \"authScheme\": \"<string>\"\n },\n \"certificate\": {\n \"certificate\": \"<string>\",\n \"privateKey\": \"<string>\",\n \"chain\": [\n \"<string>\"\n ],\n \"expiresAt\": \"2023-11-07T05:31:56Z\"\n },\n \"fields\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"favorite\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.useanima.sh/v1/vault/credentials/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"agentId\": \"<string>\",\n \"reveal\": false,\n \"name\": \"<string>\",\n \"notes\": \"<string>\",\n \"login\": {\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"uris\": [\n {\n \"uri\": \"<string>\"\n }\n ],\n \"totp\": \"<string>\"\n },\n \"card\": {\n \"cardholderName\": \"<string>\",\n \"brand\": \"<string>\",\n \"number\": \"<string>\",\n \"expMonth\": \"<string>\",\n \"expYear\": \"<string>\",\n \"code\": \"<string>\"\n },\n \"identity\": {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"address1\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"company\": \"<string>\",\n \"ssn\": \"<string>\"\n },\n \"oauthToken\": {\n \"provider\": \"<string>\",\n \"accessToken\": \"<string>\",\n \"refreshToken\": \"<string>\",\n \"tokenEndpoint\": \"<string>\",\n \"clientId\": \"<string>\",\n \"clientSecret\": \"<string>\",\n \"scopes\": [\n \"<string>\"\n ],\n \"expiresAt\": \"2023-11-07T05:31:56Z\",\n \"autoRefresh\": true,\n \"allowedHosts\": [\n \"<string>\"\n ]\n },\n \"apiKey\": {\n \"provider\": \"<string>\",\n \"key\": \"<string>\",\n \"prefix\": \"<string>\",\n \"expiresAt\": \"2023-11-07T05:31:56Z\",\n \"scopes\": [\n \"<string>\"\n ],\n \"allowedHosts\": [\n \"<string>\"\n ],\n \"authHeader\": \"<string>\",\n \"authScheme\": \"<string>\"\n },\n \"certificate\": {\n \"certificate\": \"<string>\",\n \"privateKey\": \"<string>\",\n \"chain\": [\n \"<string>\"\n ],\n \"expiresAt\": \"2023-11-07T05:31:56Z\"\n },\n \"fields\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"favorite\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"type": "login",
"name": "<string>",
"favorite": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"notes": "<string>",
"login": {
"username": "<string>",
"password": "<string>",
"uris": [
{
"uri": "<string>",
"match": "domain"
}
],
"totp": "<string>"
},
"card": {
"cardholderName": "<string>",
"brand": "<string>",
"number": "<string>",
"expMonth": "<string>",
"expYear": "<string>",
"code": "<string>"
},
"identity": {
"firstName": "<string>",
"lastName": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"address1": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>",
"company": "<string>",
"ssn": "<string>"
},
"oauthToken": {
"provider": "<string>",
"accessToken": "<string>",
"refreshToken": "<string>",
"tokenEndpoint": "<string>",
"clientId": "<string>",
"scopes": [
"<string>"
],
"expiresAt": "2023-11-07T05:31:56Z",
"clientSecret": "<string>",
"autoRefresh": true,
"allowedHosts": [
"<string>"
]
},
"apiKey": {
"provider": "<string>",
"key": "<string>",
"prefix": "<string>",
"rateLimit": {
"requests": 1,
"window": "<string>"
},
"expiresAt": "2023-11-07T05:31:56Z",
"scopes": [
"<string>"
],
"allowedHosts": [
"<string>"
],
"authHeader": "<string>",
"authScheme": "<string>"
},
"certificate": {
"format": "pem",
"certificate": "<string>",
"privateKey": "<string>",
"expiresAt": "2023-11-07T05:31:56Z",
"chain": [
"<string>"
]
},
"fields": [
{
"name": "<string>",
"value": "<string>",
"type": "text"
}
],
"folderId": "<string>",
"organizationId": "<string>",
"collectionIds": [
"<string>"
],
"revealPolicy": "standard"
}API Reference
Put vaultcredentials
PUT
/
vault
/
credentials
/
{id}
cURL
curl --request PUT \
--url https://api.useanima.sh/v1/vault/credentials/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"agentId": "<string>",
"reveal": false,
"name": "<string>",
"notes": "<string>",
"login": {
"username": "<string>",
"password": "<string>",
"uris": [
{
"uri": "<string>"
}
],
"totp": "<string>"
},
"card": {
"cardholderName": "<string>",
"brand": "<string>",
"number": "<string>",
"expMonth": "<string>",
"expYear": "<string>",
"code": "<string>"
},
"identity": {
"firstName": "<string>",
"lastName": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"address1": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>",
"company": "<string>",
"ssn": "<string>"
},
"oauthToken": {
"provider": "<string>",
"accessToken": "<string>",
"refreshToken": "<string>",
"tokenEndpoint": "<string>",
"clientId": "<string>",
"clientSecret": "<string>",
"scopes": [
"<string>"
],
"expiresAt": "2023-11-07T05:31:56Z",
"autoRefresh": true,
"allowedHosts": [
"<string>"
]
},
"apiKey": {
"provider": "<string>",
"key": "<string>",
"prefix": "<string>",
"expiresAt": "2023-11-07T05:31:56Z",
"scopes": [
"<string>"
],
"allowedHosts": [
"<string>"
],
"authHeader": "<string>",
"authScheme": "<string>"
},
"certificate": {
"certificate": "<string>",
"privateKey": "<string>",
"chain": [
"<string>"
],
"expiresAt": "2023-11-07T05:31:56Z"
},
"fields": [
{
"name": "<string>",
"value": "<string>"
}
],
"favorite": true
}
'import requests
url = "https://api.useanima.sh/v1/vault/credentials/{id}"
payload = {
"agentId": "<string>",
"reveal": False,
"name": "<string>",
"notes": "<string>",
"login": {
"username": "<string>",
"password": "<string>",
"uris": [{ "uri": "<string>" }],
"totp": "<string>"
},
"card": {
"cardholderName": "<string>",
"brand": "<string>",
"number": "<string>",
"expMonth": "<string>",
"expYear": "<string>",
"code": "<string>"
},
"identity": {
"firstName": "<string>",
"lastName": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"address1": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>",
"company": "<string>",
"ssn": "<string>"
},
"oauthToken": {
"provider": "<string>",
"accessToken": "<string>",
"refreshToken": "<string>",
"tokenEndpoint": "<string>",
"clientId": "<string>",
"clientSecret": "<string>",
"scopes": ["<string>"],
"expiresAt": "2023-11-07T05:31:56Z",
"autoRefresh": True,
"allowedHosts": ["<string>"]
},
"apiKey": {
"provider": "<string>",
"key": "<string>",
"prefix": "<string>",
"expiresAt": "2023-11-07T05:31:56Z",
"scopes": ["<string>"],
"allowedHosts": ["<string>"],
"authHeader": "<string>",
"authScheme": "<string>"
},
"certificate": {
"certificate": "<string>",
"privateKey": "<string>",
"chain": ["<string>"],
"expiresAt": "2023-11-07T05:31:56Z"
},
"fields": [
{
"name": "<string>",
"value": "<string>"
}
],
"favorite": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
agentId: '<string>',
reveal: false,
name: '<string>',
notes: '<string>',
login: {
username: '<string>',
password: '<string>',
uris: [{uri: '<string>'}],
totp: '<string>'
},
card: {
cardholderName: '<string>',
brand: '<string>',
number: '<string>',
expMonth: '<string>',
expYear: '<string>',
code: '<string>'
},
identity: {
firstName: '<string>',
lastName: '<string>',
email: 'jsmith@example.com',
phone: '<string>',
address1: '<string>',
city: '<string>',
state: '<string>',
postalCode: '<string>',
country: '<string>',
company: '<string>',
ssn: '<string>'
},
oauthToken: {
provider: '<string>',
accessToken: '<string>',
refreshToken: '<string>',
tokenEndpoint: '<string>',
clientId: '<string>',
clientSecret: '<string>',
scopes: ['<string>'],
expiresAt: '2023-11-07T05:31:56Z',
autoRefresh: true,
allowedHosts: ['<string>']
},
apiKey: {
provider: '<string>',
key: '<string>',
prefix: '<string>',
expiresAt: '2023-11-07T05:31:56Z',
scopes: ['<string>'],
allowedHosts: ['<string>'],
authHeader: '<string>',
authScheme: '<string>'
},
certificate: {
certificate: '<string>',
privateKey: '<string>',
chain: ['<string>'],
expiresAt: '2023-11-07T05:31:56Z'
},
fields: [{name: '<string>', value: '<string>'}],
favorite: true
})
};
fetch('https://api.useanima.sh/v1/vault/credentials/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.useanima.sh/v1/vault/credentials/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'agentId' => '<string>',
'reveal' => false,
'name' => '<string>',
'notes' => '<string>',
'login' => [
'username' => '<string>',
'password' => '<string>',
'uris' => [
[
'uri' => '<string>'
]
],
'totp' => '<string>'
],
'card' => [
'cardholderName' => '<string>',
'brand' => '<string>',
'number' => '<string>',
'expMonth' => '<string>',
'expYear' => '<string>',
'code' => '<string>'
],
'identity' => [
'firstName' => '<string>',
'lastName' => '<string>',
'email' => 'jsmith@example.com',
'phone' => '<string>',
'address1' => '<string>',
'city' => '<string>',
'state' => '<string>',
'postalCode' => '<string>',
'country' => '<string>',
'company' => '<string>',
'ssn' => '<string>'
],
'oauthToken' => [
'provider' => '<string>',
'accessToken' => '<string>',
'refreshToken' => '<string>',
'tokenEndpoint' => '<string>',
'clientId' => '<string>',
'clientSecret' => '<string>',
'scopes' => [
'<string>'
],
'expiresAt' => '2023-11-07T05:31:56Z',
'autoRefresh' => true,
'allowedHosts' => [
'<string>'
]
],
'apiKey' => [
'provider' => '<string>',
'key' => '<string>',
'prefix' => '<string>',
'expiresAt' => '2023-11-07T05:31:56Z',
'scopes' => [
'<string>'
],
'allowedHosts' => [
'<string>'
],
'authHeader' => '<string>',
'authScheme' => '<string>'
],
'certificate' => [
'certificate' => '<string>',
'privateKey' => '<string>',
'chain' => [
'<string>'
],
'expiresAt' => '2023-11-07T05:31:56Z'
],
'fields' => [
[
'name' => '<string>',
'value' => '<string>'
]
],
'favorite' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.useanima.sh/v1/vault/credentials/{id}"
payload := strings.NewReader("{\n \"agentId\": \"<string>\",\n \"reveal\": false,\n \"name\": \"<string>\",\n \"notes\": \"<string>\",\n \"login\": {\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"uris\": [\n {\n \"uri\": \"<string>\"\n }\n ],\n \"totp\": \"<string>\"\n },\n \"card\": {\n \"cardholderName\": \"<string>\",\n \"brand\": \"<string>\",\n \"number\": \"<string>\",\n \"expMonth\": \"<string>\",\n \"expYear\": \"<string>\",\n \"code\": \"<string>\"\n },\n \"identity\": {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"address1\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"company\": \"<string>\",\n \"ssn\": \"<string>\"\n },\n \"oauthToken\": {\n \"provider\": \"<string>\",\n \"accessToken\": \"<string>\",\n \"refreshToken\": \"<string>\",\n \"tokenEndpoint\": \"<string>\",\n \"clientId\": \"<string>\",\n \"clientSecret\": \"<string>\",\n \"scopes\": [\n \"<string>\"\n ],\n \"expiresAt\": \"2023-11-07T05:31:56Z\",\n \"autoRefresh\": true,\n \"allowedHosts\": [\n \"<string>\"\n ]\n },\n \"apiKey\": {\n \"provider\": \"<string>\",\n \"key\": \"<string>\",\n \"prefix\": \"<string>\",\n \"expiresAt\": \"2023-11-07T05:31:56Z\",\n \"scopes\": [\n \"<string>\"\n ],\n \"allowedHosts\": [\n \"<string>\"\n ],\n \"authHeader\": \"<string>\",\n \"authScheme\": \"<string>\"\n },\n \"certificate\": {\n \"certificate\": \"<string>\",\n \"privateKey\": \"<string>\",\n \"chain\": [\n \"<string>\"\n ],\n \"expiresAt\": \"2023-11-07T05:31:56Z\"\n },\n \"fields\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"favorite\": true\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.useanima.sh/v1/vault/credentials/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"agentId\": \"<string>\",\n \"reveal\": false,\n \"name\": \"<string>\",\n \"notes\": \"<string>\",\n \"login\": {\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"uris\": [\n {\n \"uri\": \"<string>\"\n }\n ],\n \"totp\": \"<string>\"\n },\n \"card\": {\n \"cardholderName\": \"<string>\",\n \"brand\": \"<string>\",\n \"number\": \"<string>\",\n \"expMonth\": \"<string>\",\n \"expYear\": \"<string>\",\n \"code\": \"<string>\"\n },\n \"identity\": {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"address1\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"company\": \"<string>\",\n \"ssn\": \"<string>\"\n },\n \"oauthToken\": {\n \"provider\": \"<string>\",\n \"accessToken\": \"<string>\",\n \"refreshToken\": \"<string>\",\n \"tokenEndpoint\": \"<string>\",\n \"clientId\": \"<string>\",\n \"clientSecret\": \"<string>\",\n \"scopes\": [\n \"<string>\"\n ],\n \"expiresAt\": \"2023-11-07T05:31:56Z\",\n \"autoRefresh\": true,\n \"allowedHosts\": [\n \"<string>\"\n ]\n },\n \"apiKey\": {\n \"provider\": \"<string>\",\n \"key\": \"<string>\",\n \"prefix\": \"<string>\",\n \"expiresAt\": \"2023-11-07T05:31:56Z\",\n \"scopes\": [\n \"<string>\"\n ],\n \"allowedHosts\": [\n \"<string>\"\n ],\n \"authHeader\": \"<string>\",\n \"authScheme\": \"<string>\"\n },\n \"certificate\": {\n \"certificate\": \"<string>\",\n \"privateKey\": \"<string>\",\n \"chain\": [\n \"<string>\"\n ],\n \"expiresAt\": \"2023-11-07T05:31:56Z\"\n },\n \"fields\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"favorite\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.useanima.sh/v1/vault/credentials/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"agentId\": \"<string>\",\n \"reveal\": false,\n \"name\": \"<string>\",\n \"notes\": \"<string>\",\n \"login\": {\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"uris\": [\n {\n \"uri\": \"<string>\"\n }\n ],\n \"totp\": \"<string>\"\n },\n \"card\": {\n \"cardholderName\": \"<string>\",\n \"brand\": \"<string>\",\n \"number\": \"<string>\",\n \"expMonth\": \"<string>\",\n \"expYear\": \"<string>\",\n \"code\": \"<string>\"\n },\n \"identity\": {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"address1\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"company\": \"<string>\",\n \"ssn\": \"<string>\"\n },\n \"oauthToken\": {\n \"provider\": \"<string>\",\n \"accessToken\": \"<string>\",\n \"refreshToken\": \"<string>\",\n \"tokenEndpoint\": \"<string>\",\n \"clientId\": \"<string>\",\n \"clientSecret\": \"<string>\",\n \"scopes\": [\n \"<string>\"\n ],\n \"expiresAt\": \"2023-11-07T05:31:56Z\",\n \"autoRefresh\": true,\n \"allowedHosts\": [\n \"<string>\"\n ]\n },\n \"apiKey\": {\n \"provider\": \"<string>\",\n \"key\": \"<string>\",\n \"prefix\": \"<string>\",\n \"expiresAt\": \"2023-11-07T05:31:56Z\",\n \"scopes\": [\n \"<string>\"\n ],\n \"allowedHosts\": [\n \"<string>\"\n ],\n \"authHeader\": \"<string>\",\n \"authScheme\": \"<string>\"\n },\n \"certificate\": {\n \"certificate\": \"<string>\",\n \"privateKey\": \"<string>\",\n \"chain\": [\n \"<string>\"\n ],\n \"expiresAt\": \"2023-11-07T05:31:56Z\"\n },\n \"fields\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"favorite\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"type": "login",
"name": "<string>",
"favorite": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"notes": "<string>",
"login": {
"username": "<string>",
"password": "<string>",
"uris": [
{
"uri": "<string>",
"match": "domain"
}
],
"totp": "<string>"
},
"card": {
"cardholderName": "<string>",
"brand": "<string>",
"number": "<string>",
"expMonth": "<string>",
"expYear": "<string>",
"code": "<string>"
},
"identity": {
"firstName": "<string>",
"lastName": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"address1": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>",
"company": "<string>",
"ssn": "<string>"
},
"oauthToken": {
"provider": "<string>",
"accessToken": "<string>",
"refreshToken": "<string>",
"tokenEndpoint": "<string>",
"clientId": "<string>",
"scopes": [
"<string>"
],
"expiresAt": "2023-11-07T05:31:56Z",
"clientSecret": "<string>",
"autoRefresh": true,
"allowedHosts": [
"<string>"
]
},
"apiKey": {
"provider": "<string>",
"key": "<string>",
"prefix": "<string>",
"rateLimit": {
"requests": 1,
"window": "<string>"
},
"expiresAt": "2023-11-07T05:31:56Z",
"scopes": [
"<string>"
],
"allowedHosts": [
"<string>"
],
"authHeader": "<string>",
"authScheme": "<string>"
},
"certificate": {
"format": "pem",
"certificate": "<string>",
"privateKey": "<string>",
"expiresAt": "2023-11-07T05:31:56Z",
"chain": [
"<string>"
]
},
"fields": [
{
"name": "<string>",
"value": "<string>",
"type": "text"
}
],
"folderId": "<string>",
"organizationId": "<string>",
"collectionIds": [
"<string>"
],
"revealPolicy": "standard"
}Authorizations
BearerAuthApiKeyAuth
JWT Bearer token obtained from authentication. Pass as: Authorization: Bearer
Path Parameters
Credential identifier
Body
application/json
Agent identifier. Optional when using an agent API key (resolved automatically); required when using a master key.
Pattern:
^[0-9a-z]+$Return unmasked plaintext fields. Requires master key auth. Audit-logged as 'access_reveal'.
Updated display name
Minimum string length:
1Updated notes
Login patch. Fields you omit keep their stored values; a masked echo (e.g. '****') of password/totp also counts as unchanged.
Show child attributes
Show child attributes
Updated card data
Show child attributes
Show child attributes
Updated identity data
Show child attributes
Show child attributes
OAuth token patch. Omitted fields keep their stored values; masked echoes of accessToken/refreshToken/clientSecret count as unchanged.
Show child attributes
Show child attributes
API key patch. Omitted fields keep their stored values (edit allowedHosts without resending the key); a masked echo of key counts as unchanged.
Show child attributes
Show child attributes
Certificate patch. Omitted fields keep their stored values; a masked echo of privateKey counts as unchanged.
Show child attributes
Show child attributes
Updated custom fields
Show child attributes
Show child attributes
Updated favorite status
Change the reveal policy. Upgrading standard → brokered needs UPDATE access; downgrading brokered → standard requires master-key auth and is audited.
Available options:
standard, brokered Response
200 - application/json
OK
Full credential record returned from the vault
Unique credential identifier
Credential type
Available options:
login, secure_note, card, identity, oauth_token, api_key, certificate User-defined credential name
Whether the credential is marked as a favorite
Timestamp when the credential was created
Timestamp when the credential was last updated
Free-form notes attached to the credential
Login credential data, present when type is login
Show child attributes
Show child attributes
Card credential data, present when type is card
Show child attributes
Show child attributes
Identity credential data, present when type is identity
Show child attributes
Show child attributes
OAuth token data, present when type is oauth_token
Show child attributes
Show child attributes
API key data, present when type is api_key
Show child attributes
Show child attributes
Certificate data, present when type is certificate
Show child attributes
Show child attributes
Custom fields attached to the credential
Show child attributes
Show child attributes
Folder the credential belongs to
Organization the credential is scoped to
Collections the credential is shared with
Reveal policy governing whether plaintext may be returned (default 'standard')
Available options:
standard, brokered ⌘I