Custom Storage
This endpoint allows the user to create a document in their custom store.
Authorizations
Body
itemany ofRequired
or
Responses
200
Successful response
application/json
Responseboolean
400
Invalid input data
application/json
401
Authorization not provided
application/json
403
Insufficient access
application/json
500
Internal server error
application/json
post
POST /api/custom-storage/create HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 368
{
"item": {
"encryptedRecord": {
"protected": "text",
"iv": "text",
"ciphertext": "text",
"tag": "text",
"aad": "text",
"recipients": [
{
"header": {
"alg": "text",
"iv": "text",
"tag": "text",
"epk": {
"kty": "text",
"crv": "text",
"x": "text",
"y": "text",
"n": "text",
"d": "text"
},
"kid": "text",
"apv": "text",
"apu": "text"
},
"encrypted_key": "text"
}
]
},
"fields": [
"text"
],
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}
true
This endpoint allows the user to create a document in their custom store.
Authorizations
Body
itemsany ofRequired
or
Responses
200
Successful response
application/json
Responseboolean
400
Invalid input data
application/json
401
Authorization not provided
application/json
403
Insufficient access
application/json
500
Internal server error
application/json
post
POST /api/custom-storage/create-many HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 371
{
"items": [
{
"encryptedRecord": {
"protected": "text",
"iv": "text",
"ciphertext": "text",
"tag": "text",
"aad": "text",
"recipients": [
{
"header": {
"alg": "text",
"iv": "text",
"tag": "text",
"epk": {
"kty": "text",
"crv": "text",
"x": "text",
"y": "text",
"n": "text",
"d": "text"
},
"kid": "text",
"apv": "text",
"apu": "text"
},
"encrypted_key": "text"
}
]
},
"fields": [
"text"
],
"ANY_ADDITIONAL_PROPERTY": "anything"
}
]
}
true
This endpoint allows the user to query for documents in their custom store.
Authorizations
Body
limitnumberOptionalDefault:
25
cursorstringOptional
queryany ofOptional
or
encryptbooleanOptionalDefault:
true
includeAssociatedDidsbooleanOptionalDefault:
true
Responses
200
Successful response
application/json
Responseany of
or
400
Invalid input data
application/json
401
Authorization not provided
application/json
403
Insufficient access
application/json
500
Internal server error
application/json
post
POST /api/custom-storage/read HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 119
{
"limit": 25,
"cursor": "text",
"query": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"encrypt": true,
"includeAssociatedDids": true
}
{
"cursor": "text",
"hasMore": true,
"records": [
{
"encryptedRecord": {
"protected": "text",
"iv": "text",
"ciphertext": "text",
"tag": "text",
"aad": "text",
"recipients": [
{
"header": {
"alg": "text",
"iv": "text",
"tag": "text",
"epk": {
"kty": "text",
"crv": "text",
"x": "text",
"y": "text",
"n": "text",
"d": "text"
},
"kid": "text",
"apv": "text",
"apu": "text"
},
"encrypted_key": "text"
}
]
},
"fields": [
"text"
],
"ANY_ADDITIONAL_PROPERTY": "anything"
}
]
}
This endpoint allows the user to count documents in their custom store.
Authorizations
Body
queryany ofOptional
anyOptional
includeAssociatedDidsbooleanOptionalDefault:
true
Responses
200
Successful response
application/json
Responsenumber
400
Invalid input data
application/json
401
Authorization not provided
application/json
403
Insufficient access
application/json
500
Internal server error
application/json
post
POST /api/custom-storage/count HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 43
{
"query": null,
"includeAssociatedDids": true
}
1
This endpoint allows the user to update documents in their custom store.
Authorizations
Body
queryany ofOptional
anyOptional
updateany ofRequired
or
includeAssociatedDidsbooleanOptionalDefault:
true
Responses
200
Successful response
application/json
Responsenumber
400
Invalid input data
application/json
401
Authorization not provided
application/json
403
Insufficient access
application/json
500
Internal server error
application/json
post
POST /api/custom-storage/update HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 412
{
"query": null,
"update": {
"encryptedRecord": {
"protected": "text",
"iv": "text",
"ciphertext": "text",
"tag": "text",
"aad": "text",
"recipients": [
{
"header": {
"alg": "text",
"iv": "text",
"tag": "text",
"epk": {
"kty": "text",
"crv": "text",
"x": "text",
"y": "text",
"n": "text",
"d": "text"
},
"kid": "text",
"apv": "text",
"apu": "text"
},
"encrypted_key": "text"
}
]
},
"fields": [
"text"
],
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"includeAssociatedDids": true
}
1
This endpoint allows the user to delete documents in their custom store.
Authorizations
Body
queryany ofOptional
anyOptional
includeAssociatedDidsbooleanOptionalDefault:
true
Responses
200
Successful response
application/json
Responseany of
numberOptional
boolean · enumOptionalPossible values:
400
Invalid input data
application/json
401
Authorization not provided
application/json
403
Insufficient access
application/json
500
Internal server error
application/json
post
POST /api/custom-storage/delete HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 43
{
"query": null,
"includeAssociatedDids": true
}
1
Was this helpful?