# cPanel API 2 Functions - MysqlFE::userdbprivs Warning: The cPanel API 2 system is deprecated. We **strongly** recommend that you use [UAPI](/cpanel/introduction) instead of cPanel API 2. ## Description This function lists a user's privileges on a MySQL® database. Warning: - This function is currently deprecated and does not function. We **strongly** recommend that you use the [`MysqlFE::getdbuserprivileges`](/cpanel-api-2/cpanel-api-2-modules-mysqlfe/cpanel-api-2-functions-mysqlfe-getdbuserprivileges/) function. - We **strongly** recommend that you use [UAPI](/cpanel/introduction/) instead of cPanel API 2. However, no equivalent UAPI function exists. Important: When you disable the [*MySQL/MariaDB* role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles) **and** remote MySQL is **not** already configured, the system **disables** this function. ## Examples ### WHM API (JSON) ```undefined syntaxhighlighter-pre https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=MysqlFE&cpanel_jsonapi_func=userdbprivs&db=example_db1&dbuser=example_user1 ``` Note: For more information, read our [Calls from the WHM API](/whm/use-whm-api-to-call-cpanel-api-and-uapi) documentation. ### LiveAPI PHP Class ```undefined syntaxhighlighter-pre $cpanel = new CPANEL(); // Connect to cPanel - only do this once. // List privileges for "example_user1" on "example_db1" $list_privs = $cpanel->api2( 'MysqlFE', 'userdbprivs', array( 'db' => 'example_db1', 'dbuser' => 'example_user1', ) ); ``` Note: For more information, read our [Guide to the LiveAPI System](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system). ### LiveAPI Perl Module ```undefined syntaxhighlighter-pre my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once. # List privileges for "example_user1" on "example_db1" my $list_privs = $cpliveapi->api2( 'MysqlFE', 'userdbprivs', { 'db' => 'example_db1', 'dbuser' => 'example_user1', } ); ``` Note: For more information, read our [Guide to the LiveAPI System](/guides/guide-to-the-liveapi-system). ### cPanel Tag System (deprecated) Warnings: - cPanel tags are **deprecated**. We **strongly** recommend that you **only** use the [LiveAPI](/guides/guide-to-the-liveapi-system) system to call the cPanel APIs. Examples are **only** present in order to help developers move from the old cPanel tag system to our [LiveAPI](/guides/guide-to-the-liveapi-system). - cPanel API 2 calls that use cPanel tags vary in code syntax and in their output. - For more information, read our [Deprecated cPanel Tag Usage](/cpanel-api-2/cpanel-api-2-deprecate-cpanel-tag-usage/) documentation. ### Command Line ```undefined syntaxhighlighter-pre cpapi2 --user=username MysqlFE userdbprivs db=example_db1 dbuser=example_user1 ``` div Notes: - You **must** URI-encode values. - `username` represents your account-level username. - If you run this command as the `root` user, you **must** include the `--user=username` option. - For more information and additional output options, read our [Guide to cPanel API 2](/cpanel-api-2/) documentation or run the `cpapi2 --help` command. - If you run CloudLinux™, you **must** use the full path of the `cpapi2` command: ```undefined syntaxhighlighter-pre /usr/local/cpanel/bin/cpapi2 ``` br ### Output (JSON) ```undefined syntaxhighlighter-pre { "cpanelresult": { "apiversion": 2, "func": "userdbprivs", "data": [ { "DELETE": 1, "EXECUTE": 1 } ], "event": { "result": 1 }, "module": "MysqlFE" } } ``` Note: Use cPanel's *[API Shell](https://docs.cpanel.net/cpanel/advanced/api-shell-for-cpanel)* interface (*cPanel >> Home >> Advanced >> API Shell*) to directly test cPanel API calls. ## Parameters table thead tr th strong Parameter th strong Type th strong Description th strong Possible values th strong Example tbody tr td code db td em string td p strong Required p The database name. td A valid database name. td code example_db1 tr td code dbuser td em string td p strong Required p The database username. td A valid database username td code example_user1 ## Returns Note: This function's Boolean values only return if the database user has privileges for that database. If the value is `0`, the function will not return that value. table thead tr th strong Return th strong Type th strong Description th strong Possible values th strong Example tbody tr td code ALL PRIVILEGES td em Boolean td Whether the user has all privileges on the database. td ul li code 1 — The user has all privileges. td code 1 tr td code ALTER td em Boolean td Whether the user has this privilege on the database. td ul li code 1 — The user has this privilege. td code 1 tr td p code ALTER ROUTINE td em Boolean td Whether the user has this privilege on the database. td ul li code 1 — The user has this privilege. td code 1 tr td code CREATE td em Boolean td Whether the user has this privilege on the database. td ul li code 1 — The user has this privilege. td code 1 tr td code CREATE ROUTINE td em Boolean td Whether the user has this privilege on the database. td ul li code 1 — The user has this privilege. td code 1 tr td code CREATE TEMPORARY TABLES td em Boolean td Whether the user has this privilege on the database. td ul li code 1 — The user has this privilege. td code 1 tr td code CREATE VIEW td em Boolean td Whether the user has this privilege on the database. td ul li code 1 — The user has this privilege. td code 1 tr td code DELETE td em Boolean td Whether the user has this privilege on the database. td ul li code 1 — The user has this privilege. td code 1 tr td code DROP td em Boolean td Whether the user has this privilege on the database. td ul li code 1 — The user has this privilege. td code 1 tr td code EVENT td em Boolean td Whether the user has this privilege on the database. td ul li code 1 — The user has this privilege. td code 1 tr td code EXECUTE td em Boolean td Whether the user has this privilege on the database. td ul li code 1 — The user has this privilege. td code 1 tr td code INDEX td em Boolean td Whether the user has this privilege on the database. td ul li code 1 — The user has this privilege. td code 1 tr td code INSERT td em Boolean td Whether the user has this privilege on the database. td ul li code 1 — The user has this privilege. td code 1 tr td code LOCK TABLES td em Boolean td Whether the user has this privilege on the database. td ul li code 1 — The user has this privilege. td code 1 tr td code REFERENCES td em Boolean td Whether the user has this privilege on the database. td ul li code 1 — The user has this privilege. td code 1 tr td code SELECT td em Boolean td Whether the user has this privilege on the database. td ul li code 1 — The user has this privilege. td code 1 tr td p code SHOW VIEW td em Boolean td Whether the user has this privilege on the database. td ul li code 1 — The user has this privilege. td code 1 tr td code TRIGGER td em Boolean td Whether the user has this privilege on the database. td ul li code 1 — The user has this privilege. td code 1 tr td code UPDATE td em Boolean td Whether the user has this privilege on the database. td ul li code 1 — The user has this privilege. td code 1 tr td code reason td em string td p A reason for failure. p This function only returns a code reason value if it failed. td A string that describes the error. td code This is an error message. tr td code result td em Boolean td p Whether the function succeeded. td ul li code 1 — The function succeeded. li code 0 — The function failed. td code 1