🚀 Feature: API Key authentication #448

Closed
opened 2025-10-08 00:09:03 +03:00 by OVERLORD · 3 comments
Owner

Originally created by @fallenleavesgocrunch on GitHub.

Originally assigned to: @kmendell on GitHub.

Feature description

The ability for a backend application to create pocket-id users through a REST API.

Pitch

I'd also love to integrate pocket-id in to software I'm writing; but for that to work I cannot manually administer adding users. I'd love it if there were some kind of REST api where I can submit a new user to pocket-id and have it send out the authenticate email with one-time setup link and a redirect back to my app when it's setup.

app.backend -> pocket-id.backend/add-user?username=xxxx?group=zzzzz&returnto=urlurlurl

pocket-id would then create the user, add them to the group, and email them out the one-time invite. When the user has authenticated their email and added a passkey it would then redirect them to the returnto url.

Originally created by @fallenleavesgocrunch on GitHub. Originally assigned to: @kmendell on GitHub. ### Feature description The ability for a backend application to create pocket-id users through a REST API. ### Pitch I'd also love to integrate pocket-id in to software I'm writing; but for that to work I cannot manually administer adding users. I'd love it if there were some kind of REST api where I can submit a new user to pocket-id and have it send out the authenticate email with one-time setup link and a redirect back to my app when it's setup. app.backend -> pocket-id.backend/add-user?username=xxxx?group=zzzzz&returnto=urlurlurl pocket-id would then create the user, add them to the group, and email them out the one-time invite. When the user has authenticated their email and added a passkey it would then redirect them to the returnto url.
OVERLORD added the feature label 2025-10-08 00:09:03 +03:00
Author
Owner

@stonith404 commented on GitHub:

Adding users via the rest API is already possible but you would need your access token for authentication which is suboptimal for automations as the access token is only short lived.

We would have to add support for API key authentication where the user can create and revoke them in the admin UI and then use the key for authentication. Because of that I'll rename this feature request to "API Key authentication".

@stonith404 commented on GitHub: Adding users via the rest API is already possible but you would need your access token for authentication which is suboptimal for automations as the access token is only short lived. We would have to add support for API key authentication where the user can create and revoke them in the admin UI and then use the key for authentication. Because of that I'll rename this feature request to "API Key authentication".
Author
Owner

@stonith404 commented on GitHub:

This is now available in v0.39.0. Thanks @kmendell.

@stonith404 commented on GitHub: This is now available in `v0.39.0`. Thanks @kmendell.
Author
Owner

@kamilkosek commented on GitHub:

Hi,
I´d love to see a way to interact with the API.
What I like to build is a "landing page" or call it "portal" where users can see all the apps and services which are available for their authenticated identity.

@kamilkosek commented on GitHub: Hi, I´d love to see a way to interact with the API. What I like to build is a "landing page" or call it "portal" where users can see all the apps and services which are available for their authenticated identity.
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/pocket-id-pocket-id-1#448