Bitwarden

App · 22 actions

Manage Bitwarden organization members, groups and collections, and inspect policies and event logs.

Actions

ActionWhat it does
Create groupCreate a group.
Delete groupPermanently delete a group.
Get collectionGet the details of one collection by its ID.
Get groupGet the details of one group by its ID.
Get group membersGet the IDs of every member in a group.
Get memberGet the details of one member of your organization by their ID.
Get member groupsGet the IDs of every group a member belongs to.
Get policyGet the details of one policy.
Get subscriptionGet your organization's subscription details.
List collectionsList your organization's collections, without the groups that can access them.
List eventsList your organization's event logs, one page at a time.
List groupsList your organization's groups, with the collections each can access.
List membersList your organization's members, with the collections each can access.
List policiesList your organization's policies.
Reinvite memberSend a member their invitation email again.
Restore memberRestore a member whose access was revoked.
Revoke memberRevoke a member's access to your organization.
Set group membersSet which members belong to a group.
Set member groupsSet which groups a member belongs to.
Update collectionUpdate a collection.
Update groupUpdate a group.
Update memberUpdate a member.

Create group

Create a group.

Inputs

NamenametextRequired
The name of the group.
External idexternal_idtext
External identifier for reference or linking this group to another system, such as a user directory.
Collectionscollectionslist
The associated collections that this group can access.

Outputs

dataobject
A user group.
Example output
{
  "data": {
    "collections": [],
    "externalId": "example",
    "id": "example",
    "name": "example",
    "object": "example"
  }
}

Delete group

Permanently delete a group. This cannot be undone.

Inputs

IdidtextRequired
The identifier of the group to be deleted.

Outputs

dataobject
Response.
Example output
{
  "data": {}
}

Get collection

Get the details of one collection by its ID.

Inputs

IdidtextRequired
The identifier of the collection to be retrieved.

Outputs

dataobject
A collection.
Example output
{
  "data": {
    "externalId": "example",
    "groups": [],
    "id": "example",
    "object": "example"
  }
}

Get group

Get the details of one group by its ID.

Inputs

IdidtextRequired
The identifier of the group to be retrieved.

Outputs

dataobject
A user group.
Example output
{
  "data": {
    "collections": [],
    "externalId": "example",
    "id": "example",
    "name": "example",
    "object": "example"
  }
}

Get group members

Get the IDs of every member in a group.

Inputs

IdidtextRequired
The identifier of the group to be retrieved.

Outputs

datalist
Response.
Example output
{
  "data": []
}

Get member

Get the details of one member of your organization by their ID.

Inputs

IdidtextRequired
The identifier of the member to be retrieved.

Outputs

dataobject
An organization member.
Example output
{
  "data": {
    "collections": [],
    "email": "example",
    "externalId": "example",
    "id": "example",
    "name": "example",
    "object": "example",
    "permissions": {
      "accessEventLogs": false,
      "accessImportExport": false,
      "accessReports": false,
      "createNewCollections": false,
      "deleteAnyCollection": false,
      "editAnyCollection": false,
      "manageAccessRules": false,
      "manageGroups": false,
      "managePolicies": false,
      "manageResetPassword": false,
      "manageScim": false,
      "manageSso": false,
      "manageUsers": false
    },
    "resetPasswordEnrolled": false,
    "ssoExternalId": "example",
    "status": 0,
    "twoFactorEnabled": false,
    "type": 0,
    "userId": "example"
  }
}

Get member groups

Get the IDs of every group a member belongs to.

Inputs

IdidtextRequired
The identifier of the member to be retrieved.

Outputs

datalist
Response.
Example output
{
  "data": []
}

Get policy

Get the details of one policy.

Inputs

TypetypenumberRequired
The type of policy to be retrieved.One of: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, and 13 more.

Outputs

dataobject
A policy.
Example output
{
  "data": {
    "data": {},
    "enabled": false,
    "id": "example",
    "object": "example",
    "type": 0
  }
}

Get subscription

Get your organization's subscription details.

Inputs

None.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "passwordManager": {
      "maxAutoScaleSeats": 1,
      "seats": 1,
      "storage": 1
    },
    "secretsManager": {
      "maxAutoScaleSeats": 1,
      "maxAutoScaleServiceAccounts": 1,
      "seats": 1,
      "serviceAccounts": 1
    }
  }
}

List collections

List your organization's collections, without the groups that can access them.

Inputs

None.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "data": [],
    "object": "example"
  }
}

List events

List your organization's event logs, one page at a time. With no dates it returns the last 30 days; with only a start date, events from then until now; with only an end date, the 30 days before it. The range can be at most 367 days.

Inputs

Startstartdate and time
The start date. If omitted, defaults to 30 days before the end date (or 30 days ago when no end date is given).
Endenddate and time
The end date. If omitted, defaults to the current time.
Acting user idacting_user_idtext
The unique identifier of the user that performed the event.
Item iditem_idtext
The unique identifier of the related item that the event describes.
Secret idsecret_idtext
The unique identifier of the related secret that the event describes.
Project idproject_idtext
The unique identifier of the related project that the event describes.
Continuation tokencontinuation_tokentext
A cursor for use in pagination.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "continuationToken": "example",
    "data": [],
    "object": "example"
  }
}

List groups

List your organization's groups, with the collections each can access.

Inputs

None.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "data": [],
    "object": "example"
  }
}

List members

List your organization's members, with the collections each can access.

Inputs

None.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "data": [],
    "object": "example"
  }
}

List policies

List your organization's policies.

Inputs

None.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "data": [],
    "object": "example"
  }
}

Reinvite member

Send a member their invitation email again.

Inputs

IdidtextRequired
The identifier of the member to re-invite.

Outputs

dataobject
Response.
Example output
{
  "data": {}
}

Restore member

Restore a member whose access was revoked.

Inputs

IdidtextRequired
The identifier of the member to be restored.

Outputs

dataobject
Response.
Example output
{
  "data": {}
}

Revoke member

Revoke a member's access to your organization.

Inputs

IdidtextRequired
The ID of the member to be revoked.

Outputs

dataobject
Response.
Example output
{
  "data": {}
}

Set group members

Set which members belong to a group.

Inputs

IdidtextRequired
The identifier of the group to be updated.
Member idsmember_idslist
The associated member ids that have access to this object.

Outputs

dataobject
Response.
Example output
{
  "data": {}
}

Set member groups

Set which groups a member belongs to.

Inputs

IdidtextRequired
The identifier of the member to be updated.
Group idsgroup_idslist
The associated group ids that this object can access.

Outputs

dataobject
Response.
Example output
{
  "data": {}
}

Update collection

Update a collection. Any setting you leave blank is cleared, not kept.

Inputs

IdidtextRequired
The identifier of the collection to be updated.
External idexternal_idtext
External identifier for reference or linking this collection to another system.
Groupsgroupslist
The associated groups that this collection is assigned to.

Outputs

dataobject
A collection.
Example output
{
  "data": {
    "externalId": "example",
    "groups": [],
    "id": "example",
    "object": "example"
  }
}

Update group

Update a group. Any setting you leave blank is cleared, not kept.

Inputs

IdidtextRequired
The identifier of the group to be updated.
NamenametextRequired
The name of the group.
External idexternal_idtext
External identifier for reference or linking this group to another system, such as a user directory.
Collectionscollectionslist
The associated collections that this group can access.

Outputs

dataobject
A user group.
Example output
{
  "data": {
    "collections": [],
    "externalId": "example",
    "id": "example",
    "name": "example",
    "object": "example"
  }
}

Update member

Update a member. Any setting you leave blank is cleared, not kept.

Inputs

IdidtextRequired
The identifier of the member to be updated.
TypetypenumberRequired
Type.One of: 0, 1, 2, 4.
External idexternal_idtext
External identifier for reference or linking this member to another system, such as a user directory.
Permissionspermissionsobject
Represents a member's custom permissions if the member has a Custom role.
Collectionscollectionslist
The associated collections that this member can access.
Groupsgroupslist
Ids of the associated groups that this member will belong to
Emailemailtext
The member's email address. Can only be changed for a claimed member without a master password when the new address is on a domain verified by the organization.
Namenametext
The member's name. Can only be changed for a claimed member.

Outputs

dataobject
An organization member.
Example output
{
  "data": {
    "collections": [],
    "email": "example",
    "externalId": "example",
    "id": "example",
    "name": "example",
    "object": "example",
    "permissions": {
      "accessEventLogs": false,
      "accessImportExport": false,
      "accessReports": false,
      "createNewCollections": false,
      "deleteAnyCollection": false,
      "editAnyCollection": false,
      "manageAccessRules": false,
      "manageGroups": false,
      "managePolicies": false,
      "manageResetPassword": false,
      "manageScim": false,
      "manageSso": false,
      "manageUsers": false
    },
    "resetPasswordEnrolled": false,
    "ssoExternalId": "example",
    "status": 0,
    "twoFactorEnabled": false,
    "type": 0,
    "userId": "example"
  }
}

On this page