Description

This function lists the users with access to a PostgreSQL® database.

Examples 




https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Postgres&cpanel_jsonapi_func=listusersindb&db=example_database



$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Generate a list of Postgres database users with access to "example_database"
$list_pgusers = $cpanel->api2(
    'Postgres', 'listusersindb',
 array(
        'db'        => 'example_database', 
    ) 
);

 



my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Generate a list of Postgres database users with access to "example_database"
my $list_pgusers = $cpliveapi->api2(
    'Postgres', 'listusersindb',
 { 
        'db'        => 'example_database',
    }
);

 




cpapi2 --user=username Postgres listusersindb db=example_database



{
  "cpanelresult": {
    "apiversion": 2,
    "func": "listusersindb",
    "data": [
      {
        "db": "example_database",
        "user": "example_pgdbuser1"
      },
      {
        "db": "example_database2",
        "user": "example_pgdbuser2"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Postgres"
  }
}



Parameters

ParameterTypeDescriptionPossible valuesExample
dbstring

The database name.

If you do not include this parameter, the function will return results for all databases.

A valid string.

example_database

Returns

ReturnTypeDescriptionPossible valuesExample
dbstringThe database name.A valid string.example_database
userstringThe database username.A valid string.example_pgdbuser1
reasonstring

A reason for failure.

This function only returns a reason value if it failed.


A string that describes the error.

This is an error message.
resultBoolean

Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.
1