cURL
curl --request POST \
--url https://api.useanima.sh/v1/vault/credentials \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"agentId": "<string>",
"notes": "<string>",
"login": {
"username": "<string>",
"password": "<string>",
"uris": [
{
"uri": "<string>"
}
],
"totp": "<string>"
},
"generatePassword": {
"length": 68,
"uppercase": true,
"lowercase": true,
"number": true,
"special": true
},
"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>"
},
"fields": [
{
"name": "<string>",
"value": "<string>"
}
],
"favorite": false,
"folderId": "<string>",
"organizationId": "<string>",
"collectionIds": [
"<string>"
]
}
'import requests
url = "https://api.useanima.sh/v1/vault/credentials"
payload = {
"name": "<string>",
"agentId": "<string>",
"notes": "<string>",
"login": {
"username": "<string>",
"password": "<string>",
"uris": [{ "uri": "<string>" }],
"totp": "<string>"
},
"generatePassword": {
"length": 68,
"uppercase": True,
"lowercase": True,
"number": True,
"special": True
},
"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>"
},
"fields": [
{
"name": "<string>",
"value": "<string>"
}
],
"favorite": False,
"folderId": "<string>",
"organizationId": "<string>",
"collectionIds": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
agentId: '<string>',
notes: '<string>',
login: {
username: '<string>',
password: '<string>',
uris: [{uri: '<string>'}],
totp: '<string>'
},
generatePassword: {length: 68, uppercase: true, lowercase: true, number: true, special: true},
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>'
},
fields: [{name: '<string>', value: '<string>'}],
favorite: false,
folderId: '<string>',
organizationId: '<string>',
collectionIds: ['<string>']
})
};
fetch('https://api.useanima.sh/v1/vault/credentials', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'agentId' => '<string>',
'notes' => '<string>',
'login' => [
'username' => '<string>',
'password' => '<string>',
'uris' => [
[
'uri' => '<string>'
]
],
'totp' => '<string>'
],
'generatePassword' => [
'length' => 68,
'uppercase' => true,
'lowercase' => true,
'number' => true,
'special' => true
],
'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>'
],
'fields' => [
[
'name' => '<string>',
'value' => '<string>'
]
],
'favorite' => false,
'folderId' => '<string>',
'organizationId' => '<string>',
'collectionIds' => [
'<string>'
]
]),
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"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"agentId\": \"<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 \"generatePassword\": {\n \"length\": 68,\n \"uppercase\": true,\n \"lowercase\": true,\n \"number\": true,\n \"special\": true\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 \"fields\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"favorite\": false,\n \"folderId\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"collectionIds\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.useanima.sh/v1/vault/credentials")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"agentId\": \"<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 \"generatePassword\": {\n \"length\": 68,\n \"uppercase\": true,\n \"lowercase\": true,\n \"number\": true,\n \"special\": true\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 \"fields\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"favorite\": false,\n \"folderId\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"collectionIds\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.useanima.sh/v1/vault/credentials")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"agentId\": \"<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 \"generatePassword\": {\n \"length\": 68,\n \"uppercase\": true,\n \"lowercase\": true,\n \"number\": true,\n \"special\": true\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 \"fields\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"favorite\": false,\n \"folderId\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"collectionIds\": [\n \"<string>\"\n ]\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
Post vaultcredentials
POST
/
vault
/
credentials
cURL
curl --request POST \
--url https://api.useanima.sh/v1/vault/credentials \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"agentId": "<string>",
"notes": "<string>",
"login": {
"username": "<string>",
"password": "<string>",
"uris": [
{
"uri": "<string>"
}
],
"totp": "<string>"
},
"generatePassword": {
"length": 68,
"uppercase": true,
"lowercase": true,
"number": true,
"special": true
},
"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>"
},
"fields": [
{
"name": "<string>",
"value": "<string>"
}
],
"favorite": false,
"folderId": "<string>",
"organizationId": "<string>",
"collectionIds": [
"<string>"
]
}
'import requests
url = "https://api.useanima.sh/v1/vault/credentials"
payload = {
"name": "<string>",
"agentId": "<string>",
"notes": "<string>",
"login": {
"username": "<string>",
"password": "<string>",
"uris": [{ "uri": "<string>" }],
"totp": "<string>"
},
"generatePassword": {
"length": 68,
"uppercase": True,
"lowercase": True,
"number": True,
"special": True
},
"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>"
},
"fields": [
{
"name": "<string>",
"value": "<string>"
}
],
"favorite": False,
"folderId": "<string>",
"organizationId": "<string>",
"collectionIds": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
agentId: '<string>',
notes: '<string>',
login: {
username: '<string>',
password: '<string>',
uris: [{uri: '<string>'}],
totp: '<string>'
},
generatePassword: {length: 68, uppercase: true, lowercase: true, number: true, special: true},
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>'
},
fields: [{name: '<string>', value: '<string>'}],
favorite: false,
folderId: '<string>',
organizationId: '<string>',
collectionIds: ['<string>']
})
};
fetch('https://api.useanima.sh/v1/vault/credentials', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'agentId' => '<string>',
'notes' => '<string>',
'login' => [
'username' => '<string>',
'password' => '<string>',
'uris' => [
[
'uri' => '<string>'
]
],
'totp' => '<string>'
],
'generatePassword' => [
'length' => 68,
'uppercase' => true,
'lowercase' => true,
'number' => true,
'special' => true
],
'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>'
],
'fields' => [
[
'name' => '<string>',
'value' => '<string>'
]
],
'favorite' => false,
'folderId' => '<string>',
'organizationId' => '<string>',
'collectionIds' => [
'<string>'
]
]),
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"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"agentId\": \"<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 \"generatePassword\": {\n \"length\": 68,\n \"uppercase\": true,\n \"lowercase\": true,\n \"number\": true,\n \"special\": true\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 \"fields\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"favorite\": false,\n \"folderId\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"collectionIds\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.useanima.sh/v1/vault/credentials")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"agentId\": \"<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 \"generatePassword\": {\n \"length\": 68,\n \"uppercase\": true,\n \"lowercase\": true,\n \"number\": true,\n \"special\": true\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 \"fields\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"favorite\": false,\n \"folderId\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"collectionIds\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.useanima.sh/v1/vault/credentials")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"agentId\": \"<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 \"generatePassword\": {\n \"length\": 68,\n \"uppercase\": true,\n \"lowercase\": true,\n \"number\": true,\n \"special\": true\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 \"fields\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"favorite\": false,\n \"folderId\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"collectionIds\": [\n \"<string>\"\n ]\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
Body
application/json
Input for creating a new vault credential
Type of credential to create
Available options:
login, secure_note, card, identity, oauth_token, api_key, certificate Display name for the credential
Minimum string length:
1Agent identifier. Optional when using an agent API key (resolved automatically); required when using a master key.
Pattern:
^[0-9a-z]+$Free-form notes to attach
Login data, required when type is login
Show child attributes
Show child attributes
Generate the login password server-side instead of supplying login.password. Only valid when type is 'login'; mutually exclusive with login.password. The response contains only the credential ref with masked fields — retrieve the password via the vault token flow (scope 'autofill') or master-key reveal.
Show child attributes
Show child attributes
Card data, required when type is card
Show child attributes
Show child attributes
Identity data, required when type is identity
Show child attributes
Show child attributes
OAuth token data, required when type is oauth_token
Show child attributes
Show child attributes
API key data, required when type is api_key
Show child attributes
Show child attributes
Certificate data, required when type is certificate
Show child attributes
Show child attributes
Custom fields to attach
Show child attributes
Show child attributes
Mark the credential as a favorite
Folder to place the credential in
Organization to scope the credential to
Collections to share the credential with
Reveal policy for this credential. When omitted, agent-key-created logins default to 'brokered' and everything else follows the org's defaultRevealPolicy setting (itself defaulting to 'standard').
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