RemoteAdmin:admin acl list
From OpenSimulator
(Difference between revisions)
(Created page with "'''admin_acl_list''' remotely allows to retrieve a list of users who can access the region === Enabling admin_acl_list === If not all functions are enabled, use admin_acl_list...") |
JeffKelley (Talk | contribs) m (→PHP: Fixed broken Google Code link, replacing with internal page) |
||
| (6 intermediate revisions by 3 users not shown) | |||
| Line 33: | Line 33: | ||
! Values | ! Values | ||
|- | |- | ||
| − | | '' | + | | ''region_id'' |
| region uuid | | region uuid | ||
| | | | ||
|} | |} | ||
| − | |||
== Returned Parameters == | == Returned Parameters == | ||
| Line 52: | Line 51: | ||
| true when successfull | | true when successfull | ||
| true, false | | true, false | ||
| − | |||
| − | |||
| − | |||
| − | |||
|- | |- | ||
| ''users'' | | ''users'' | ||
| Line 61: | Line 56: | ||
| | | | ||
|} | |} | ||
| − | |||
=== Error messages === | === Error messages === | ||
| Line 72: | Line 66: | ||
== Example == | == Example == | ||
=== PHP === | === PHP === | ||
| + | This example needs the RemoteAdmin PHP Class file available [[RemoteAdmin:RemoteAdmin_Class|here]]. | ||
| + | |||
<source lang="php"> | <source lang="php"> | ||
<?php | <?php | ||
| Line 87: | Line 83: | ||
</source> | </source> | ||
| − | [[Category: | + | |
| + | [[Category:RemoteAdmin]] | ||
| + | [[Category:RemoteAdmin Commands]] | ||
Latest revision as of 11:36, 16 March 2021
admin_acl_list remotely allows to retrieve a list of users who can access the region
Contents |
[edit] Enabling admin_acl_list
If not all functions are enabled, use admin_acl_list to enable the function in the [RemoteAdmin] section
enabled_methods = admin_acl_list,...
[edit] Parameters
[edit] Required Parameters
These parameters are required
| parameter | Description | Values |
|---|---|---|
| region_name | Name of the new region, optionaly region_uuid |
[edit] Optional Parameters
These parameters are optional and do not need to be set
| parameter | Description | Values |
|---|---|---|
| region_id | region uuid |
[edit] Returned Parameters
[edit] Returned Parameters
These parameters are returned by Remote Admin
| parameter | Description | Values |
|---|---|---|
| success | true when successfull | true, false |
| users | list of users allowed access |
[edit] Error messages
No error messages
[edit] Notes
[edit] Example
[edit] PHP
This example needs the RemoteAdmin PHP Class file available here.
<?php // Including the RemoteAdmin PHP class. include('RemoteAdmin.php'); // Instantiate the class with parameters identical to the Python example above $myRemoteAdmin = new RemoteAdmin('127.0.0.1', 9000, 'secret'); // Invoke admin_acl_list (multiple parameters) $parameters = array('region_name' => 'My Plaza'); $myRemoteAdmin->SendCommand('admin_acl_list', $parameters); ?>
