Creating regular users in CouchDB

Question

How can I create regular, non-admin users in CouchDB?

You might be interested in this wiki article. wiki.apache.org/couchdb/How_to_create_users_via_script — user2247543
What are the naming rules? I can't seem to find an answer anywhere. Can a username be an email address? — Costa Michailidis
Usernames can be absolutely any UTF-8 string. For example, that's the reason why couchdb_peruser needs to hash usernames to make database names. There is a couple of restrictions that you can find in the design doc for the users database: - usernames cannot begin with an underscore _ - usernames cannot contain a colon : _(It's still hard to find an answer to this online in 2019) — Leonid Shevtsov

Gjorgji Tashkovski Gjorgji Tashkovski · Accepted Answer · 2011-06-20T23:21:57

First you put the user in _users database. The ID of the document must be org.couchdb.user:username, e.g.

With CouchDB 1.2.0 or later use this:

{
    "_id": "org.couchdb.user:dbreader",
    "name": "dbreader",
    "type": "user",
    "roles": [],
    "password": "plaintext_password"
}

CouchDB will hash & salt the password for you on the server side and save the values in the fields password_sha and salt (see below).

With CouchDB < 1.2.0 the user document needs to look like this:

{
    "_id": "org.couchdb.user:dbreader",
    "name": "dbreader",
    "type": "user",
    "roles": [],
    "salt": "54935938852dd34f92c672ab31e397cedaf0946d",
    "password_sha": "42253ea4461a604f967813aaff90b139d7018806"
}

Note that CouchDB 1.3.0 and later will use PBKDF2 instead of aha & salt for hashing the password.

Then you can create per database authentication by creating document with id _security in specific database which is not versioned, e.g.

{
    "admins": {
        "names": ["dbadmin"],
        "roles": ["editor"]
    },
    "readers": {
        "names": ["dbreader"],
        "roles": ["reader"]
    }
}

This means that there are 2 users in _users besides the admin dbadmin and dbreader. That should do in case you are too lazy to read the document that has already been suggested.

Creating regular users in CouchDB

3 Answers