Skip to main content

Overview

Organizations enable teams to securely share vault items, manage users, and enforce security policies.

Get Organization

Retrieve organization details.
string
required
Organization ID

Response

string
required
Organization unique identifier
string
required
Organization name
string
Legal business name
string
required
Email for billing notifications
number
required
Subscription plan type
number
Number of user seats
number
Maximum collections allowed
boolean
Groups feature enabled
boolean
Directory sync enabled
boolean
Event logs enabled
boolean
TOTP 2FA enabled
boolean
Organization 2FA policy enabled
boolean
API access enabled
boolean
Policies feature enabled
boolean
SSO authentication enabled
boolean
Secrets Manager enabled

List User’s Organizations

Retrieve all organizations the authenticated user belongs to.

Response

Returns a list of organizations with the user’s role and permissions.

Create Organization

Create a new organization (Cloud only).
string
required
Organization name
string
Legal business name
string
required
Billing email address
number
required
Plan type (0=Free, 1=FamiliesAnnually, etc.)
string
required
Encrypted organization key
object
Organization key pair
string
Initial collection name
This endpoint is only available on Bitwarden Cloud, not self-hosted instances.

Update Organization

Update organization information.
string
required
Organization ID
string
required
Organization name
string
Legal business name
string
Billing email (requires subscription editing permission)
string
Organization identifier for SSO
Changing the billing email requires the EditSubscription permission.

Get Auto-Enroll Status

Check if organization has auto-enroll policy enabled.
string
required
Organization identifier

Response

string
Organization ID
boolean
Whether auto-enroll is enabled

Leave Organization

Remove yourself from an organization.
string
required
Organization ID
You cannot leave an organization if:
  • You are the only owner
  • You use Key Connector SSO
  • Your account is claimed by the organization

Delete Organization

Permanently delete an organization.
string
required
Organization ID
string
required
Master password hash for verification
This permanently deletes the organization and all associated data. This action cannot be undone.

Organization API Keys

Get API Key

Retrieve organization API key.
string
required
Organization ID
string
required
Master password hash

Rotate API Key

Generate a new API key.
string
required
Organization ID
string
required
Master password hash

License Management

Apply License

Apply or update organization license (Self-hosted only).
string
required
License file contents

Download License

Download organization license file.
string
required
Organization ID
string
required
Installation ID

Storage Management

Add Storage

Purchase additional storage for organization (Cloud only).
string
required
Organization ID
number
required
GB to add (can be negative to reduce)

SSO Configuration

Delete SSO User

Remove SSO link for a user in the organization.
string
required
Organization ID

Organization Types

User Roles

Plan Types


Permissions

Custom users can have granular permissions: