Description

This function checks whether a PostgreSQL® database user exists.

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=userexists&user=example_user



$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Check whether user "example_user" exists in PostgreSQL
$cogito_ergosum = $cpanel->api2(
    'Postgres', 'userexists',
 array(
        'user'        => 'example_user', 
    ) 
);

 



my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Check whether user "example_user" exists in PostgreSQL
my $cogito_ergosum = $cpliveapi->api2(
    'Postgres', 'userexists',
    { 
        'user'        => 'example_user',
    }
);

 


 



cpapi2 --user=username Postgres userexists user=example_user



{
  "cpanelresult": {
    "apiversion": 2,
    "func": "userexists",
    "data": [
      {
        "userexists": "1"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Postgres"
  }
}



Parameters

ParameterTypeDescriptionPossible valuesExample
userstring

Required

The database user.

A valid string.

example_user

Returns

Return TypeDescriptionPossible valuesExample
userexistsBooleanWhether the database user exists.
  • 1 — User exists.
  • 0 — User does not exist.
1
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