Description

This function lists the server's database users.


On most servers, this function returns a large amount of output. We strongly suggest that you filter and sort the output. 

Examples 




https://hostname.example.com:2087/cpsess##########/json-api/list_database_users?api.version=1




https://hostname.example.com:2087/cpsess##########/xml-api/list_database_users?api.version=1




whmapi1 list_database_users



{
  "data": {
    "payload": [
      {
        "cpuser": "example"
        "engine": "postgresql",
        "name": "example_user1",
      },
      {
        "cpuser": "example"
        "engine": "postgresql",
        "name": "example_user2",
      },
    ]
  },
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": "1",
    "command": "list_database_users"
  }
}




<result>
    <data>
        <payload>
            <engine>postgresql</engine>
            <name>example_user1</name>
            <cpuser>example</cpuser>
        </payload>
        <payload>
            <engine>postgresql</engine>
            <name>example_user2</name>
            <cpuser>example</cpuser>
        </payload>
    </data>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>list_database_users</command>
    </metadata>
</result>



Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
payloadarray of hashesAn array of hashes of database data.This array includes the engine, name and cpuser returns. 

engine

string

The database user's database engine.

The function returns this value in the payload array.

  • mysql
  • postgresql
postgresql

name

string

The database user's name.

The function returns this value in the payload array.

A valid database name.example_user1

cpuser

string

The database user's owner.

The function returns this value in the payload array.

A valid username.example