Restricted access to public documentation

[zachheine]

I have set up the subdomain docs.ourdomain.com and would like to be able to publish our docs so that only logged-in team members can see them.

[zachheine]

This is to have a quick shortcut to the current collection page, rather than: https://company.postman.co/collections/6976389-266cf775-bb91-4635-b64f-d58749f607ba?version=latest&workspace=88e96b36-c21c-4778-a58b-cdd3e68577ba

[sankalp0o]

@zachheine Thanks for the input! Maybe a dumb question, but if you set up a redirect on that subdomain, would that not work?

[bskiefer]

@sankalp0o Not OP, but besides the custom domain, maybe just a short URL such as https://company.postman.co/workspace-slug/collection-slug

[zachheine]

@sankalp0o I set it up as a custom domain in Postman and ideally it would just be the canonical URL for the docs and would also give the formatting that public publishing has

[bwinchester]

I really, really, really need some way of sharing published API docs to private clients. What is the sales pitch or value of this service for B2B customers if I cant share my private app API to clients? Most software is not consumer-based or wanted to be public-facing. Please allow private access that doesn't hit your team member cost subscription, or save as static assets for me to deploy on my own. Come on, its just some HTML and JS. I'm paying a pretty penny for this service with the promise of API documentation, don't tell me you didn't think about B2B clients or internal apps.

[zachheine]

+1m

On Thu, Mar 19, 2020 at 3:26 PM Brandon Winchester notifications@github.com wrote:

I really, really, really need some way of sharing published API docs to private clients. What is the sales pitch or value of this service for B2B customers if I cant share my private app API to clients? Most software is not consumer-based or wanted to be public-facing. Please allow private access that doesn't hit your team member cost subscription, or save as static assets for me to deploy on my own. Come on, its just some HTML and JS. I'm paying a pretty penny for this service with the promise of API documentation, don't tell me you didn't think about B2B clients or internal apps.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/postmanlabs/postman-app-support/issues/6681#issuecomment-601445762, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAGJXQPEQXQQL3BJUFA4EKLRIKLX7ANCNFSM4HWHYKKA .

--

Zachary R. Heineman zach.is

[robertatcd]

I've just completed documenting a private-use API in Postman, only to find that I apparently can't share that documentation without making it completely public — very disappointing.

I think Postman really needs a way to export the documentation so that it can be used elsewhere, by whatever private means the API creator needs.

[kryspetrie]

I'm work in a B2B software company that deals with secure data (think: medical) ... we really need this feature, bad. We don't want to be exposing our API documentation to anyone aside from our Pharma / HCO customers. Come on, Postman. First, you can't even integrate with Client Credentials in Auth0 properly (no audience field!?) and now this!

[yosepkim]

Is this something that is on your roadmap to be implemented any time soon? If we can't password-protect the API doc on Postman, I need to find some other alternative.

Thanks.

[ahsandev2019]

This feature must be implementation immediately, we need publishing our api privately to only our client

[ahsandev2019]

We just need pin/password to prptect our api, its better than custom domain

[bwinchester]

@postman @Raja-Simha . This was marked 'Later' 7 months ago? Any update? Coming up on renewal and I'm going to ditch you and roll our own if I can't get a commitment on this by the end of this year. I pay more for this service than a continuous delivery server, and can't even publish my documentation privately. Absurd.

[bwinchester]

In the meantime...I'm supplementing Postmans total lack of commitment to their lion share of users with a library that takes JSON exports from Postman and generates docs with curl copy/paste snippets.

Postmanerator

[massivespace]

Since this has been a feature request for about 3+ years now, it looks like it just won't happen. I was looking into using postman, but will be directing my employer to a different technology for our upcoming stack as this is a critical basic need.

[dtsio]

+1, indeed weird this is not a default feature.

[Raja-Simha]

We are moving towards enabling not just sharing but real time collaboration with your partners.

We just released public workspaces(in public beta) which will allow teams to collaborate with anyone outside your team. More details in this blogpost - https://blog.postman.com/introducing-postman-public-workspaces. Also, checkout some public workspaces here - https://www.postman.com/explore.

We will soon be extending this for collaboration with partners through partner workspaces - workspaces with restricted access to partners. Do let us know if this might not solve your usecases.

[fuzemobi]

Hi, I don't see any direct answers to this issue. Is there currently a solution for protecting documentation behind a user/password or private workspaces? I believe this is as simple as providing the equivalent of an .htaccess file that we can edit for access controls.

What is recommended by postman for secure access to non-public apis? The partners we are working with simply need a shared API document. Could this be an markdown document or pdf print of the page with the appropriate formatting?

[dimmduh]

Any changes? It should be default feature.

[pranav08]

It is surprising, they don't have this feature!

[AlexanderKaran]

Any update on this? Really need this feature one of the reason we invested in post. Very sad to find out it is not possible.

[Sushi21]

Same here we are investing a lot in Postman but we need that feature on our private APIs

[AlexanderKaran]

Hi Everyone.

I have found a temp workaround using Cloudflare that super easy to set up. Point your domain at Postman using Cloudflare, then use Cloudflare lock down access to IP address for your company office has or staff homes.

Not the best but works for now.

[pjhoberman]

+1 to adding this functionality

[vpedrosa]

Any ETA of this issue?

[WayneEld]

Also looking to implement a similar feature.

[cdolan92]

+1 this is needed, going to be using some work arounds to make our API accessible to authenticated users only.

[cghughes]

+1 being able to share documentation with a restricted audience is a big requirement

[jared-shepherd]

+1, this would be very useful

[rnhurt]

+1 We really like the Postman documentation feature, but we really need to restrict access to our API information. As many others have said on this thread, this feature is a pretty fundamental thing and does seem quite popular.

[jjyoh]

11th of January 2022 and still no feature released from Postman... Did anyone find an alternative to Postman that has this feature? We tried a hackish way with Cloudflare Access, you can now have a magic-link system on a subdomain through their proxy.

[fuzemobi]

11th of January 2022 and still not feature release from Postman... Did anyone find an alternative to Postman that has this feature? We tried a hackish way with Cloudflare Access, you can now have a magic-link system on a subdomain through their proxy.

I have used a couple of solutions to generate static documentation from my postman collections:

• https://github.com/karthiks3000/postman-doc-gen
• https://travis-ci.org/aubm/postmanerator

[WizzerWorks]

+1 I enjoy using this tool, BUT I definitely need a way to publish the document for private consumption. I will abandon this product at the end of this quarter (Mar 2022), if a solution can not be provided. This requirement is driven by my B2B clients.

[mikalai-okun]

Very much-needed feature!

[justneedham]

+1. My company has been trialing Postman and we want to share documentation across the entire company. We have lots of technical users. Scientists and technicians who need to view documentation but aren't engineers and won't be building/contributing. There needs to be a way to share documentation to them as a private consumer but not a producer. Either this or Postman needs to implement a "viewer" seat within the subscription. The Private APIs network could work but we shouldn't have to pay for seats if they are read only.

[beard-developer-arcadier]

im amaze that this was still not implemeted after 5 years.. the initial request was made last 2017.

[wahoho]

Very disappointed that I can't share some classified APIs to our partner. Not very B2B friendly IMO. Simple password could've suffice.

[allanbleakley]

I see that Akash Aydeo has self-assigned this - perhaps is this Postman working on this issue now?

[happycappie]

@Raja-Simha @abhinav-ravi @ajeet-postman I would be grateful if you could advise what direction this is headed and approx timing.

[akshaydeo]

Hi @conradpronto, we will be working on this in Q4 and would aim to release it by December 2022 🙇‍♂️

[ramji367]

We recently launched Partner workspaces which provides the ability to share specific workspaces - containing collections, documentation and other elements - with external partners. Partners need to be explicitly invited and sign in with a Postman account to access the workspace. Check out the blog here: https://blog.postman.com/introducing-partner-workspaces/

Please reach out using email or calendly if you want to learn more or try out this feature.

[rnhurt]

Excellent! Do these "partners" count against the user count or are they free?

[ramji367]

Partner workspaces is an Enterprise plan feature and each team will get 5 partner licenses to try it out. Beyond that you can do one of the following:

• If you are already on the Enterprise plan, please reach out to your Postman Customer Success manager
• Turn on auto-flex for flexible, automated billing or
• Get in touch with our Sales team to discuss your specific needs

[coccoinomane]

Partner workspaces is an Enterprise plan feature

Why do we need to pay for Enterprise seats for a basic password protect feature?

[margerabe]

Hi @akshaydeo is there any update on the release of this? :)

[arcataroger]

We just released public workspaces(in public beta) which will allow teams to collaborate with anyone outside your team. More details in this blogpost - blog.postman.com/introducing-postman-public-workspaces. Also, checkout some public workspaces here - postman.com/explore.

I think this is actually the opposite of what we need. This opens up not just the docs, but the Workspace itself, to more people.

What we're asking for is the ability to lock down documentation (by password, ideally, or at least a secret link) so internal APIs aren't opened up for the whole world to see. Is this really still not an option 4 years later with all these requests? :(

[preethammavin]

Hey, Postman Currently supports 1) Partner Workspaces for collaboration on APIs with your partners or specific users you want to share it with externally - read about it here 2) Postman also supports Collection viewer role if you need to share the API with your internal teams - this enables you to restrict access based on the Team Configured Auth - you can read more about it here

[coccoinomane]

Disappointing.

[ariadnavaldivia]

We need a way to share a link to documentation to only some people without using postman account. This is very important please

[AbdwGTK]

Unfortunately the final solution was nothing like what the author requested and it remains an Issue 4 years after the original post.

[duaneb69]

Come on postman... you're ignoring your customers here... remember Kodak? They didn't think digital was important... but their customers had other plans.