Apache CouchDB

Overview

Use Apache CouchDB credentials to make authenticated API calls through Alter Vault without exposing API keys in code.

Property	Value
Template ID	couchdb
Category	Database
Credential Type	Base64 Credentials

Step 1: Get Credentials

Create a CouchDB user

Follow the CouchDB security guide to create a user with access to the databases the integration needs.

Encode the credentials

Base64-encode the credentials: echo -n 'username:password' | base64.

Paste the encoded string

Paste the encoded string into the credential field.

Warning

Never share credentials publicly. Store them securely and only enter them in the Alter Vault Developer Portal.

Step 2: Add to Alter Vault

Open the Developer Portal

Go to portal.alterauth.com and navigate to the application.

Add Apache CouchDB

Go to Managed Secrets > Add Provider > Apache CouchDB.

Enter credentials

Paste the Base64 Credentials into the credential field.

Save

Click Save. You’ll receive a grant_id to use with the SDK.

Using in Code

response = await alter_app.request(
    HttpMethod.POST,
    "https://YOUR-COUCHDB-HOST/mydb/_find",
    grant_id="YOUR_GRANT_ID",
    json={"selector": {"type": "user"}, "limit": 5},
)

Notes

• CouchDB uses HTTP Basic authentication — the stored value is injected as Authorization: Basic <encoded>.

Policy-cataloged operations

Alter policy rules can target these attested operations and families for operation-level and parameter-aware controls.

Operation ID	Families	Method	Provider path	Notes
server/info	read	GET	/	—
server/up	read	GET	/_up	—
server/all_dbs	read	GET	/_all_dbs	—
server/active_tasks	read	GET	/_active_tasks	—
server/replicate	admin, write	POST	/_replicate	—
session/create	admin	POST	/_session	refused by default: leaves the caller holding a provider credential (a credential_minting rule can allow it)
session/get	read	GET	/_session	—
db/get	read	GET	/{db}	—
db/head	read	HEAD	/{db}	—
db/create	write	PUT	/{db}	—
db/delete	delete	DELETE	/{db}	—
db/create_doc	write	POST	/{db}	—
db/compact	admin	POST	/{db}/_compact	—
db/all_docs	read	GET	/{db}/_all_docs	—
db/all_docs_queries	read	POST	/{db}/_all_docs	—
db/bulk_docs	delete, write	POST	/{db}/_bulk_docs	—
db/bulk_get	read	POST	/{db}/_bulk_get	—
db/find	read	POST	/{db}/_find	—
db/changes	read	GET	/{db}/_changes	—
db/index/create	write	POST	/{db}/_index	—
db/index/list	read	GET	/{db}/_index	—
db/security/get	read	GET	/{db}/_security	—
db/security/put	admin	PUT	/{db}/_security	—
doc/get	read	GET	/{db}/{docid}	—
doc/put	delete, write	PUT	/{db}/{docid}	—
doc/delete	delete	DELETE	/{db}/{docid}	—
view/query	read	GET	/{db}/_design/{ddoc}/_view/{view}	—