Child pages
  • UAPI Functions - Postgresql::list_users
Skip to end of metadata
Go to start of metadata

Description

This function lists an account's PostgreSQL® database users.

Important:

When you disable the Postgres role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

Examples 


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Postgresql/list_users


Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// List database users.
$list_users = $cpanel->uapi(
    'Postgresql', 'list_users'
);


Note:

For more information, read our Guide to the LiveAPI System.

 LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# List database users.
my $list_users = $cpliveapi->uapi(
    'Postgresql', 'list_users'
);


Note:

For more information, read our Guide to the LiveAPI System.

 Command Line
uapi --user=username Postgresql list_users


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • If you run CloudLinux™, you must use the full path of the uapi command:

    /usr/local/cpanel/bin/uapi


 Output (JSON)
{  
   "metadata":{  
      "transformed":1
   },
   "messages":null,
   "errors":null,
   "warnings":null,
   "data": [
         "example_user1",
         "example_user2"
      ],
   "status":1
}


Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

This function does not accept parameters.

Returns

Return TypeDescriptionPossible valuesExample

array of strings

An unnamed array of PostgreSQL database usernames.


An array of strings of database usernames.
"example_user1",
"example_user2"