mirror of
https://github.com/bitwarden/help
synced 2026-01-06 02:23:22 +00:00
Staging (#294)
* jekyll redirect from * Organizations rev (#262) * Organizations revisions initial commit. * API doc updates * Fix absolute link causing build failure. * Add import to org article, and downstream order changes. * Bitwarden 101 videos: 1st steps toward proliferating these throughout /help. * Added 'Create Your Account' article, which references B101 Videos. * About SSO redirect & promote importing for orgs up the list * Create Org FAQs & trim Feature FAQs accordingly. * Image for Org FAQs * Move 'About the Business Portal' to Orgs category, and re-order accordingly. * Final edits. * Dchoi/bootstrap upgrade (#264) * bootstrap 4 upgrade and cleanup update gulp tasks * bootstrap package updates * renaming file convention * general outline of help outline * bitwarden help cleanup * article cleanup * article general styling complete * bootstrap help page upgrades * sidebar updates * Dchoi/bootstrap upgrade (#267) * bootstrap 4 upgrade and cleanup update gulp tasks * bootstrap package updates * renaming file convention * general outline of help outline * bitwarden help cleanup * article cleanup * article general styling complete * bootstrap help page upgrades * sidebar updates * toc dynamic and more updates * fix callout conditions * sidebar collapse functionality added * sidebar header toggle functionality * sidebar article fixes * Update sidebar.html Fix sidebar Release Notes link. * Update releasenotes.md Remove unnecessary category tag. * Delete release-notes.md Remove unnecessary category. * Update why-choose-bitwarden-for-your-team.md Test table image differentiation * Update why-choose-bitwarden-for-your-team.md Second image differentiation test * removed links from category breadcrumb and replaced with badges Co-authored-by: fred_the_tech_writer <69817454+fschillingeriv@users.noreply.github.com>
This commit is contained in:
@@ -16,18 +16,9 @@ The Public API is compatible with the OpenAPI Specification (OAS3) and publishes
|
||||
- For Public Cloud-hosted instances: [https://bitwarden.com/help/api/](https://bitwarden.com/help/api/){:target="\_blank"}
|
||||
- For Self-hosted instances: https://your.domain.com/api/docs/
|
||||
|
||||
{% note %}
|
||||
Access to the Bitwarden Public API is available for customers on the following plans, **Classic 2019 Enterprise Organizations**, current **Enterprise Organizations**, and current **Teams Organizations**. For more information, see [About Bitwarden Plans](https://bitwarden.com/help/article/about-bitwarden-plans/#compare-the-plans-1).
|
||||
{% endnote %}
|
||||
|
||||
### In This Article
|
||||
- [Endpoints](#endpoints)
|
||||
- [Authentication](#authentication)
|
||||
- [Content Types](#content-types)
|
||||
- [Sample Request](#sample-request)
|
||||
- [Status](#status)
|
||||
- [Response Codes](#response-codes)
|
||||
- [Further Reading](#further-reading)
|
||||
{% callout info %}
|
||||
Access to the Bitwarden Public API is available customers on the following plans, **Classic 2019 Enterprise Organizations**, current **Enterprise Organizations**, and current **Teams Organizations**. For more information, see [About Bitwarden Plans](https://bitwarden.com/help/article/about-bitwarden-plans/#compare-the-plans-1).
|
||||
{% endcallout %}
|
||||
|
||||
## Endpoints
|
||||
|
||||
@@ -49,9 +40,9 @@ The API uses bearer access tokens to authenticate with protected API endpoints.
|
||||
|
||||
Authentication requests take `client_id` and `client_secret` as required parameters. `client_id` and `client_secret` can be obtained by an **Owner** from the Web Vault by navigating to the **Settings** tab → **My Organization** and scrolling down to the **API Key** section.
|
||||
|
||||
{% warning %}
|
||||
{% callout warning %}
|
||||
Your API key enables full access to your Organization. Keep your API key private. If you believe your API key has been compromised, select the **Rotate API Key** button on this screen. Active uses of your current API key will need to be reconfigured with the new key before use.
|
||||
{% endwarning %}
|
||||
{% endcallout %}
|
||||
|
||||
### Bearer Access Tokens
|
||||
|
||||
|
||||
Reference in New Issue
Block a user