Credentials
List credentials (names/URIs only, no secrets; paged). Requires a user token (API keys are denied).
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| search | query | string | |
| page | query | integer | |
| limit | query | integer | |
| client_id | query | integer |
Example request
curl "https://YOUR-HOST/api/v1/credentials" \
-H "Authorization: Bearer $TOKEN"
import requests
response = requests.get(
"https://YOUR-HOST/api/v1/credentials",
headers={"Authorization": f"Bearer {TOKEN}"},
)
print(response.json())
const response = await fetch("https://YOUR-HOST/api/v1/credentials", {
method: "GET",
headers: { "Authorization": `Bearer ${TOKEN}` },
});
const data = await response.json();
$ch = curl_init("https://YOUR-HOST/api/v1/credentials");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => ["Authorization: Bearer $token"],
]);
$data = json_decode(curl_exec($ch), true);
Responses
200Paged credential list (no secrets)
| Field | Type | Description |
|---|---|---|
| data | array of object | |
| data[].id | integer | |
| data[].name | string | |
| data[].username | string | |
| data[].uri | string | |
| data[].client | string | |
| total | integer |
Example response
json
{
"data": [
{
"id": 1,
"name": "string",
"username": "string",
"uri": "string",
"client": "string"
}
],
"total": 1
}
403Authenticated but not permitted
| Field | Type | Description |
|---|---|---|
| error | string |
Decrypted credential detail — requires a signed biometric step-up challenge
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| idrequired | path | integer | |
| X-Biometric-Challenge-Tokenrequired | header | string | challengeToken from GET /auth |
| X-Biometric-Signaturerequired | header | string | base64 signature of the challenge bytes |
Example request
curl "https://YOUR-HOST/api/v1/credentials/1" \
-H "Authorization: Bearer $TOKEN"
import requests
response = requests.get(
"https://YOUR-HOST/api/v1/credentials/1",
headers={"Authorization": f"Bearer {TOKEN}"},
)
print(response.json())
const response = await fetch("https://YOUR-HOST/api/v1/credentials/1", {
method: "GET",
headers: { "Authorization": `Bearer ${TOKEN}` },
});
const data = await response.json();
$ch = curl_init("https://YOUR-HOST/api/v1/credentials/1");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => ["Authorization: Bearer $token"],
]);
$data = json_decode(curl_exec($ch), true);
Responses
200Credential with decrypted secrets
| Field | Type | Description |
|---|---|---|
| id | integer | |
| name | string | |
| username | string | |
| password | string | |
| uri | string | |
| uri_2 | string | |
| otp_secret | string | |
| note | string | |
| client | string |
Example response
json
{
"id": 1,
"name": "string",
"username": "string",
"password": "string",
"uri": "string",
"uri_2": "string",
"otp_secret": "string",
"note": "string",
"client": "string"
}
403Authenticated but not permitted
| Field | Type | Description |
|---|---|---|
| error | string |
404Resource not found
| Field | Type | Description |
|---|---|---|
| error | string |