Summary

This PR adds an optional external_id field to each user account. This means other systems can set this field for the LNbits users and then it can query by it.

The external_id can have max 256 characters without space or new line characters. The value can be seen by a user, but a regular user cannot update its own external_id, only admins are allowed.

It is ALLOWED for more users to have the SAME external id. This allows third party systems to have a one-to-one or a one-to-many relation between their users and LNbits users.

It can be set/updated via the Admin UI or via the API.

Admin UI

API call

See API test: test_update_user_success

• update user external id
  • in this case two users have the same external_id, this is allowed

curl --location --request PUT 'http://localhost:5000/users/api/v1/user/8bb1c696640d4417a6f4ffde06020fa1' \
--header 'Cookie: cookie_access_token=eyJhbGc...' \
--header 'Content-Type: application/json' \
--data '{
    "id": "8bb1c696640d4417a6f4ffde06020fa1",
    "username": "empty",
    "external_id": "external_1234"
}'

• get users by external id:

curl --location --request GET 'http://localhost:5000/users/api/v1/user?external_id=external_id_two' \
--header 'Cookie: cookie_access_token=eyJhbGc...'

{
    "data": [
        {
            "id": "a8f1abc9c1ec4000ab2df560789963bd",
            "external_id": "external_id_two",
            "username": "admin",
            "extra": {...},
            ...
        },
        {
            "id": "edc30a66312543c0a1df5a10ca094111",
            "external_id": "external_id_two",           
            "extra": {...},
            ...
        }
    ],
    "total": 2
}