Bitwarden
App · 22 actions
Manage Bitwarden organization members, groups and collections, and inspect policies and event logs.
Actions
| Action | What it does |
|---|---|
| Create group | Create a group. |
| Delete group | Permanently delete a group. |
| Get collection | Get the details of one collection by its ID. |
| Get group | Get the details of one group by its ID. |
| Get group members | Get the IDs of every member in a group. |
| Get member | Get the details of one member of your organization by their ID. |
| Get member groups | Get the IDs of every group a member belongs to. |
| Get policy | Get the details of one policy. |
| Get subscription | Get your organization's subscription details. |
| List collections | List your organization's collections, without the groups that can access them. |
| List events | List your organization's event logs, one page at a time. |
| List groups | List your organization's groups, with the collections each can access. |
| List members | List your organization's members, with the collections each can access. |
| List policies | List your organization's policies. |
| Reinvite member | Send a member their invitation email again. |
| Restore member | Restore a member whose access was revoked. |
| Revoke member | Revoke a member's access to your organization. |
| Set group members | Set which members belong to a group. |
| Set member groups | Set which groups a member belongs to. |
| Update collection | Update a collection. |
| Update group | Update a group. |
| Update member | Update a member. |
Create group
Create a group.
Inputs
- Name
nametextRequired - The name of the group.
- External id
external_idtext - External identifier for reference or linking this group to another system, such as a user directory.
- Collections
collectionslist - 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
- Id
idtextRequired - 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
- Id
idtextRequired - 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
- Id
idtextRequired - 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
- Id
idtextRequired - 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
- Id
idtextRequired - 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
- Id
idtextRequired - The identifier of the member to be retrieved.
Outputs
datalist- Response.
Example output
{
"data": []
}Get policy
Get the details of one policy.
Inputs
- Type
typenumberRequired - 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
- Start
startdate 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).
- End
enddate and time - The end date. If omitted, defaults to the current time.
- Acting user id
acting_user_idtext - The unique identifier of the user that performed the event.
- Item id
item_idtext - The unique identifier of the related item that the event describes.
- Secret id
secret_idtext - The unique identifier of the related secret that the event describes.
- Project id
project_idtext - The unique identifier of the related project that the event describes.
- Continuation token
continuation_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
- Id
idtextRequired - The identifier of the member to re-invite.
Outputs
dataobject- Response.
Example output
{
"data": {}
}Restore member
Restore a member whose access was revoked.
Inputs
- Id
idtextRequired - 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
- Id
idtextRequired - 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
- Id
idtextRequired - The identifier of the group to be updated.
- Member ids
member_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
- Id
idtextRequired - The identifier of the member to be updated.
- Group ids
group_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
- Id
idtextRequired - The identifier of the collection to be updated.
- External id
external_idtext - External identifier for reference or linking this collection to another system.
- Groups
groupslist - 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
- Id
idtextRequired - The identifier of the group to be updated.
- Name
nametextRequired - The name of the group.
- External id
external_idtext - External identifier for reference or linking this group to another system, such as a user directory.
- Collections
collectionslist - 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
- Id
idtextRequired - The identifier of the member to be updated.
- Type
typenumberRequired - Type.One of:
0,1,2,4. - External id
external_idtext - External identifier for reference or linking this member to another system, such as a user directory.
- Permissions
permissionsobject - Represents a member's custom permissions if the member has a Custom role.
- Collections
collectionslist - The associated collections that this member can access.
- Groups
groupslist - Ids of the associated groups that this member will belong to
- Email
emailtext - 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.
- Name
nametext - 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"
}
}