Collections and Teams
Move an item to a Collection
POST /move/{itemid}/{organizationid}
Move an item to a Team by specifying an itemid and organizationid in the path, and specifying one or more collection identifiers in the request body.
Parameters:
itemid
- Unique identifier of the item to move.organizationid
- Unique identifier of the Team to move the item to.
Request body:
The request body must contain an array of one or more collection identifiers.
Example:
[ "75bb2724-abed-4f1f-aa4a-ae530106c958", "b64d6e40-adf2-4f46-b4d2-acd40147548a" ]
Request URL examples:
https://domain.com
Create a Collection for a specified Team
POST /object/org-collection
Create a collection for a specified Team by specifying a unique Organization identifier as a query parameter and collection information in the request body, including its "name": and an array of "groups": to add it to.
Parameters:
organizationid
- Unique identifier of the Team to move the item to.
Request body:
The request body must contain an object representing the collection to add. Specifying "groups": is optional.
Example:
{ "organizationid": "organization id", "name": "Logins", "externalid": null, "groups": [ { "id": "c4e31257-f3e1-4b13-895a-ae2700f9884e", "readOnly": false, "hidePasswords": false } ] }
Request URL examples:
https://domain.com
Edit a Collection in a specified Team
PUT /object/org-collection/{id}
Edit an existing collection in a specified Team by specifying the unique collection identifier in the path, an Organization identifier as a query parameter, and collection information in the request body.
Parameters:
Itemid
- Unique identifier of the collection.organizationid
- Unique identifier of the Team.
Request body:
The request body must contain an object representing the collection to edit. Specifying "groups": is optional.
Example:
{ "organizationid": "organization id", "name": "Shared Logins", "externalid": null, "groups": [ { "id": "c4e31257-f3e1-4b13-895a-ae2700f9884e", "readOnly": false, "hidePasswords": false } ] }
Request URL examples:
https://domain.com
Retrieve a Collection from a specified Team
GET /object/org-collection/{id}
Retrieve an existing collection from a specified Team by specifying the unique collection identifier in the path and a Team identifier as a query parameter.
Parameters:
Itemid
- Unique identifier of the collection.organizationid
- Unique identifier of the Team.
Request URL examples:
https://domain.com
Delete a Collection from a specified Team
DELETE /object/org-collection/{id}
Delete an existing collection from a specified Team by specifying the unique collection identifier in the path and an organization identifier as a query parameter.
Deleting a collection will not delete the items in it.
Parameters:
Itemid
- Unique identifier of the collection.
organizationid
- Unique identifier of the Team.
Request URL examples:
https://domain.com
List Collections from a specified Team
GET /list/object/org-collections
List existing collections from a specified Team by specifying an Organization identifier as a query parameter. Collections you do not have access to will not be listed.
By default, this will return a list of all collections, however you can specify search terms as additional query parameters to narrow list results.
Parameters:
organizationid
- Unique identifier of the Team.
search
- List only collections that contain this search term.
Request URL examples:
https://domain.com
List Collections from all member Teams
GET /list/object/collections
List collections from all Teams of which you are a member. Collections you do not have access to will not be listed.
By default, this will return a list of all collections, however you can specify search terms as query parameters to narrow list results.
Parameters:
search
- List only collections that contain this search term.
Request URL examples:
https://domain.com
List Teams of which you are a member
GET /list/object/organizations
List Teams of which you are a member. By default, this will return a list of all Teams , however you can specify search terms as query parameters to narrow list results.
Parameters:
search
- List only collections that contain this search term.
Request URL examples:
https://domain.com
List members of a specified Team
GET /list/object/org-members
List members of a specified Team by specifying an Organization identifier as a query parameter.
Parameters:
organizationid
- Unique identifier of the Team.
Request URL examples:
https://domain.com
Confirm a member to a specified Team
POST /confirm/org-member/{id}
Confirm a member to a specified Team by specifying a user identifier in the path and the Organization identifier as a query parameter.
Parameters:
id
- A unique identifier for the user to confirm.organizationid
- A unique identifier for the Team.
Request URL examples:
https://domain.com