Controller: /siteworx/mysql/user

Required Permissions

MYSQL

Required Options

MySQL Users

Action: add

Added in Version

4.7.0-339

Description

Add a mysql user.

Input Parameters

Name

Type

Required?

Example Values

Default Values

Notes

name

string

Yes

password

string

Yes

confirm_password

string

Yes

Confirm the password field by providing it again. Must match the password provided.

encrypted

integer

No

1, 0

0

Action: delete

Added in Version

4.7.0-339

Description

Delete a mysql user.

Input Parameters

Name

Type

Required?

Example Values

Default Values

Notes

name

struct (string)

Yes

testuser

Action: edit

Added in Version

4.7.0-339

Description

Edit a mysql user.

Input Parameters

Name

Type

Required?

Example Values

Default Values

Notes

name

string

Yes

testuser

password

string

Yes

confirm_password

string

Yes

Confirm the password field by providing it again. Must match the password provided.

encrypted

integer

No

1, 0

0

Action: fail

Added in Version

n/a

Description

Magic function - test for failure mechanism.

Action: list

Added in Version

4.7.0-339

Description

List MySQL users.

Warning

This action has been deprecated as of version 4.8.0-393. 2010-12-03 use listMysqlUsers

Sample Output

array (
  'status' => 0,
  'payload' =>
  array (
    0 =>
    array (
      0 => 'testuser',
      1 => 'example_testuser',
    ),
  ),
  'reply_code' => 205,
)

Action: listMysqlUsers

Added in Version

4.8.0-393

Description

List MySQL users.

Sample Output

array (
  'status' => 0,
  'payload' =>
  array (
    0 =>
    array (
      'name' => 'testuser',
      'crypt_password' => '*7DD188BA9E3A519F68B0B7A0C60B486C686399D7',
      'fqun' => 'example_testuser',
      'databases' => 'example_mydb',
    ),
  ),
  'reply_code' => 205,
)

Action: queryEdit

Added in Version

5.1.0-838

Description

Displays the information available to the action “edit”.

Input Parameters

Name

Type

Required?

Example Values

Default Values

Notes

name

string

Yes

testuser

Action: reroute

Added in Version

n/a

Description

Action to re-route from the current controller to a different one.

Action: win

Added in Version

n/a

Description

Magic function - test for testing success mechanism.