[Feature] API "shield off unshared albums"

[Refferic]

I have searched the existing feature requests, both open and closed, to make sure this is not a duplicate request.

• Yes

The feature

We're using Immich as a "media upload and management" tool. We're really fond of it, and use the API to "funnel" the pictures in our albums to our main website.

Currently there is no option to "hide" all the non-shared albums when you're making use of the API. It does give a "shared:true/false" boolean, however, when you have the API key, you can still see all the non-shared albums and contents.

Would it be a handy feature to have a "album.read.shared" option in the API which only returns the albums that are "shared:true", so that people misusing the API key won't be able to see the rest of the contents?

Thank you :)

Platform

• Server
• Web
• Mobile

[bo0tzz]

You should instead make shared album links and use the key from those (it's in the URL).

[Refferic]

That's exactly what we're doing; however, the API (on standard settings) shows all albums, not just the shared ones. Having the API return only shared albums on a specific endpoint would be an enormous help to us, since it would "hide" non-shared albums from the API endpoint.

[Refferic]

It's just, with over 10.000 pictures from events and over 40 albums (each edition), it's a nice "automatic" connection between Immich and our main website. A task that would be labour-intensive to keep all ID's from the albums and share them individually, since we have an endpoint that gives up all the album info from our Immich environment automatically.

[bo0tzz]

That's exactly what we're doing; however, the API (on standard settings) shows all albums

That doesn't sound right. A shared album's key doesn't have access to anything else.

A task that would be labour-intensive to keep all ID's from the albums and share them individually

You could automate creating the share links through the API maybe?

[Refferic]

The whole point of us using the API like this is to have the Immich content on our main website. E.g. clickable albums and our visitors could see the pictures on our own website without them having to login into Immich. Currently the API key will be exposed to the visitors of our website, which isn't a problem.

However, the getAllAlbums endpoint allows people to use the API key to return all albums, even the ones that we don't share with a link. Then they can get the Album ID and the contents of that album. So an endpoint which only returns the albums that have an "shared":true response, would help with filtering out all the albums that we don't want share with everyone who has the API key.

[bo0tzz]

Currently the API key will be exposed to the visitors of our website, which isn't a problem.
However, the getAllAlbums endpoint allows people to use the API key to return all albums, even the ones that we don't share with a link.

So is it a problem or not? If they have access to the API key they could go get those albums regardless of what filtering you're doing in your code, no?

Take a look at https://github.com/alangrainger/immich-public-proxy, it does pretty much exactly what I'm recommending you do too.