For security purposes, the GET USERS CDD Vault API command documented here is only available for Vault Administrators.
GET /api/v1/vaults/<vault_id>/users
Returns a list of CDD Vault members.
Query Parameters (all optional):
include_projects |
Boolean If true, each user’s Vault role and an array of project memberships are returned |
Example:
curl -H "X-CDD-Token: $TOKEN" https://app.collaborativedrug.com/api/v1/vaults/<vault_id>/users
Returns:
[
{
"id": 1111,
"first_name": "Mad",
"last_name": "Scientist",
"email": "mscientist@someemail.com",
"role_name": "vault admin",
"can_witness_eln": true
},
{
"id": 22222,
"first_name": "Beth",
"last_name": "Frankenstein",
"email": "BFrank@someemail.com",
"role_name": "vault admin",
"can_witness_eln": true
}
][
{
"id": 1234,
"first_name": "Barbara",
"last_name": "Biologist"
},
{
"id": 9876,
"first_name": "Carlos",
"last_name": "Chemist"
}
]
curl -H "X-CDD-Token: $TOKEN" https://app.collaborativedrug.com/api/v1/vaults/<vault_id>/users?include_projects=true
Returns:
[
{
"id": 1111,
"first_name": "Mad",
"last_name": "Scientist",
"email": "mscientist@someemail.com",
"role_name": "vault admin",
"can_witness_eln": true,
"projects": [
{
"name": "Training Project",
"id": 9999,
"can_manage_project": true,
"can_edit_data": true,
"hidden": false
},
{
"name": "Active Registry",
"id": 8888,
"can_manage_project": true,
"can_edit_data": true,
"hidden": false
},
.
.
.
Noteworthy Tips
- Only Vault Administrators can use this GET Users API call.
- This API call is useful to identify the Members' IDs of users for use in the GET ELN Entries API call.