Users
The MediaVault API provides endpoints to retrieve detailed user information. You can access a list of users associated with the MediaVault instance, along with their address information and security details. These endpoints enable efficient management of user profiles and their associated data within your application.
GET /users/basic-info
Retrieve list of users associated with MediaVault instance
Required Parameters
status string
User status in MediaVault. Possible values are [active, inactive, deleted, all]
curl -X 'GET' \
'https://api.mediavaultplus.com/users/basic-info?status=active' \
-H 'accept: application/json'{
"isError": false,
"errorMessage": null,
"data": [
{
"id": 1000,
"username": "jandoe",
"email_id": "jadoe@domain.com",
"title": null,
"first_name": "Jan",
"middle_name": null,
"last_name": "Doe",
"status": 1,
"group": "Sales",
"created_date": "2024-07-12T16:41:34.1821502-05:00",
"modified_date": null,
"phone_country_code": "1",
"phone_number": "xxx-xxx-xxxx",
"external_system_id": null
},
{
"id": 1002,
"username": "johndoe",
"email_id": "jhdoe@domain.com",
"title": null,
"first_name": "john",
"middle_name": null,
"last_name": "Doe",
"status": 1,
"group": "Accounts",
"created_date": "2024-07-09T16:41:34.1821562-05:00",
"modified_date": null,
"phone_country_code": "1",
"phone_number": "xxx-xxx-xxxx",
"external_system_id": null
},
{
"id": 1006,
"username": "manager1@domain.com",
"email_id": "manager1@domain.com",
"title": null,
"first_name": "Manager",
"middle_name": null,
"last_name": null,
"status": 1,
"group": "Executives",
"created_date": "2024-07-03T16:41:34.182157-05:00",
"modified_date": null,
"phone_country_code": "1",
"phone_number": "xxx-xxx-xxxx",
"external_system_id": null
}
]
}GET /users/address-info
Retrieve list of user address available in MediaVault
Required Parameters
user_id integer
User ID, which can be retrieved via basic-info API.
curl -X 'GET' \
'https://api.mediavaultplus.com/users/address-info?user_id=1' \
-H 'accept: application/json'{
"isError": false,
"errorMessage": null,
"data": [
{
"id": 100001,
"username": "jandoe",
"address": "001 some flat",
"city": "Kansas City",
"state": "MO",
"zip_code": "xxxxx",
"country": "US"
},
{
"id": 100002,
"username": "jandoe",
"address": "002 some flat",
"city": "Kansas City",
"state": "MO",
"zip_code": "xxxxx",
"country": "US"
}
]
}GET /users/security-info
Retrieve list of user security available in MediaVault
Required Parameters
user_id integer
User ID, which can be retrieved via basic-info API.
curl -X 'GET' \
'https://api.mediavaultplus.com/users/security-info?user_id=1' \
-H 'accept: application/json'{
"isError": false,
"errorMessage": null,
"data": [
{
"id": 200001,
"username": "jandoe",
"is_admin": false,
"allow_email_attachment": false,
"allow_download": false,
"allow_reports": false,
"allow_transmit": false,
"allow_dashboard": false,
"allow_all_campaigns": false,
"allowed_campaigns": [
"Campaign1",
"Campaign2"
],
"allow_all_skills": false,
"allowed_skills": [
"Skill1",
"skill2",
"skill3"
],
"allow_all_agents": true,
"allowed_agents": [],
"allow_all_groups": false,
"allowed_groups": [],
"allow_all_flags": true,
"allowed_flags": [],
"allow_all_secure01": false,
"allowed_secure01": [],
"allow_all_secure02": false,
"allowed_secure02": [],
"allow_all_secure03": false,
"allowed_secure03": [],
"allow_all_secure04": false,
"allowed_secure04": [],
"allow_all_secure05": false,
"allowed_secure05": [],
"allow_all_media": false,
"allowed_media": [],
"allow_all_services": false,
"allowed_services": [],
"allow_all_download_doc_type": true,
"allowed_download_doc_type": [],
"mfa_enabled": true,
"mfa_authy_enabled": true,
"search_rights": null
}
]
}