RemoteAdmin:admin authenticate user - Revision history

JeffKelley: /* Examples */ Edited PHP example tu use RemoteAdmin PHP class instead of dead module

2021-03-16T20:09:24Z

‎Examples: Edited PHP example tu use RemoteAdmin PHP class instead of dead module

Fritigern at 23:18, 24 October 2015

2015-10-24T23:18:16Z

Kira Komarov: /* Examples */

2013-11-22T14:42:38Z

‎Examples

Kira Komarov at 14:40, 22 November 2013

2013-11-22T14:40:59Z

Kira Komarov at 12:56, 22 November 2013

2013-11-22T12:56:05Z

Kira Komarov: /* Error messages */

2013-11-22T12:54:09Z

‎Error messages

Kira Komarov: Created page with " '''admin_authenticate_user''' remotely allows to authenticate an user remotely. This feature is part of the development branch, after the 0.7.6 OpenSim release. === Enabling a..."

2013-11-22T12:53:12Z

Created page with " '''admin_authenticate_user''' remotely allows to authenticate an user remotely. This feature is part of the development branch, after the 0.7.6 OpenSim release. === Enabling a..."

New page

'''admin_authenticate_user''' remotely allows to authenticate an user remotely. This feature is part of the development branch, after the 0.7.6 OpenSim release.

=== Enabling admin_authenticate_user ===
If not all functions are enabled, use admin_authenticate_user to enable the function in the [RemoteAdmin] section
<source lang="csharp">
enabled_methods = admin_authenticate_user,...
</source>

== Parameters ==
=== Required Parameters ===
These parameters are required
{| cellspacing="0" cellpadding="4" border="1"
|-
! parameter
! Description
! Values
|-
| ''user_firstname''
| first name of user
|
|-
| ''user_lastname''
| last name of user
|-
| ''user_password''
| and MD5 hash of the user's password
|-
| ''token_lifetime''
| the lifetime of the authentication token (max: 30s)
|
|}

== Returned Parameters ==
=== Returned Parameters ===
These parameters are returned by Remote Admin

{| cellspacing="0" cellpadding="4" border="1"
|-
! parameter
! Description
! Values
|-
| ''success''
| true when successful
| true, false
|-
|''error''
| the error that occurred (ie: authentication failed messages)
|-
|''token''
| the authentication token
|
|}

=== Error messages ===
''error'' is set to "scene does not exist" in case no scene is available.
''error'' is set to "avatar FIRSTNAME LASTNAME does not exist" in case the avatar with FIRSTNAME LASTNAME does not exist.
''error'' is set to "no password provided for FIRSTNAME LASTNAME" in case the call did not include a password for the avatar named FISTNAME LASTNAME.
''error'' is set to "no token lifetime provided for FISTNAME LASTNAME" if the ''token'' parameter has been omitted from the call.
''error'' is set to "token lifetime longer than 30s for FISTNAME LASTNAME" in case the request asked for ''token_lifetime'' larger than 30.
''error'' is set to "no authentication module loaded" in case no authentication module could be loaded.
''error'' is set to "authentication failed for FIRSTNAME LASTNAME" in case the authentication failed for user FISTNAME LASTNAME.

[[RemoteAdmin]]
[[RemoteAdmin:Commands]]

@@ Line 76: / Line 76: @@
 = Examples =
-Using the ''wasRemoteAdmin'' class from [http://was.fm/opensim:remote_admin Wizardry and Steamworks remote admin page], a call can be made to ''admin_authenticate_user'' to authenticate the avatar ''Kira Komarov'' using Remote Admin:
+This example needs the RemoteAdmin PHP Class file available [[RemoteAdmin:RemoteAdmin_Class|here]].
 <source lang="php">
 <?php
-	# include the KOS class
-	require_once 'wasRemoteAdmin.php';
+// Including the RemoteAdmin PHP class.
-	# create a new connection to the OpenSim server
+include('RemoteAdmin.php');
-	# with the hostname "OPENSIM" and port "10000"
-	# using the password "password"
+// Instantiate the class with parameters identical to the Python example above
-	$req = new wasRemoteAdmin('http://OPENSIM:10000', 'password');
+$myRemoteAdmin = new RemoteAdmin('127.0.0.1', 9000, 'secret');
-	# send the console command "show info" to OpenSim
-	print $req->admin_authenticate_user('Kira', 'Komarov', 'mypassword', '10');
+// Invoke admin_authenticate_user (multiple parameters)
 </source>

@@ Line 76: / Line 76: @@
 = Examples =
-Using the ''wasRemoteAdmin'' class from [http://was.fm/opensim:remote_admin|Wizardry and Steamworks remote admin page], a call can be made to ''admin_authenticate_user'' to authenticate the avatar ''Kira Komarov'' using Remote Admin:
+Using the ''wasRemoteAdmin'' class from [http://was.fm/opensim:remote_admin Wizardry and Steamworks remote admin page], a call can be made to ''admin_authenticate_user'' to authenticate the avatar ''Kira Komarov'' using Remote Admin:
 <source lang="php">

@@ Line 155: / Line 155: @@
 </source>
 [[RemoteAdmin]]
-[[RemoteAdmin:Commands]]

@@ Line 59: / Line 59: @@
-=== Error messages ===
+=== Error Messages ===
 ''error'' is set to "scene does not exist" in case no scene is available.
@@ Line 73: / Line 73: @@
 ''error'' is set to "authentication failed for FIRSTNAME LASTNAME" in case the authentication failed for user FISTNAME LASTNAME.
 [[RemoteAdmin]]
 [[RemoteAdmin:Commands]]

@@ Line 1: / Line 1: @@
 '''admin_authenticate_user''' remotely allows to authenticate an user remotely. This feature is part of the development branch, after the 0.7.6 OpenSim release.
@@ Line 25: / Line 24: @@
 | ''user_lastname''
 | last name of user
 |-
 | ''user_password''
 | and MD5 hash of the user's password
 |-
 | ''token_lifetime''
@@ Line 50: / Line 51: @@
 |''error''
 | the error that occurred (ie: authentication failed messages)
 |-
 |''token''