UserManipulation

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
(Use)
m (Use: Source highlighting)
Line 17: Line 17:
 
Setting AllowCreateUser = true will expose the create user XMLRPC function. Here's an example python program of how to call this.  It assumes that your ROBUST services are running on localhost.
 
Setting AllowCreateUser = true will expose the create user XMLRPC function. Here's an example python program of how to call this.  It assumes that your ROBUST services are running on localhost.
  
<pre>
+
<source lang="python">
 
#!/usr/bin/python
 
#!/usr/bin/python
  
Line 28: Line 28:
 
response = conn.getresponse()
 
response = conn.getresponse()
 
print response.read();
 
print response.read();
</pre>
+
</source>
  
 
PrincipalID is the unique ID of the user.
 
PrincipalID is the unique ID of the user.
Line 34: Line 34:
 
If everything goes well, you should get back
 
If everything goes well, you should get back
  
<pre>
+
<source lang="xml">
 
<?xml version="1.0"?>
 
<?xml version="1.0"?>
 
<ServerResponse>
 
<ServerResponse>
Line 49: Line 49:
 
   </result>
 
   </result>
 
</ServerResponse>
 
</ServerResponse>
</pre>
+
</source>
  
 
Don't worry about ScopeID, this is used for allow multiple grids to co-exist inside a single database.  Created is a unix timestamp of the time the user was created.  UserLevel determines whether the user is a god (>= 200) or can log in at all (<0).  ServiceURLs are HyperGrid related and do not concern us here.
 
Don't worry about ScopeID, this is used for allow multiple grids to co-exist inside a single database.  Created is a unix timestamp of the time the user was created.  UserLevel determines whether the user is a god (>= 200) or can log in at all (<0).  ServiceURLs are HyperGrid related and do not concern us here.
Line 55: Line 55:
 
If the call fails you will get the response
 
If the call fails you will get the response
  
<pre>
+
<source lang="xml">
 
<?xml version="1.0"?>
 
<?xml version="1.0"?>
 
<ServerResponse>
 
<ServerResponse>
 
   <result>Failure</result>
 
   <result>Failure</result>
 
</ServerResponse>
 
</ServerResponse>
</pre>
+
</source>

Revision as of 23:59, 16 March 2012

Contents

Introduction

Normally, users are created in OpenSimulator via the "create user" command on the region console (in standalone configuration) or on the ROBUST service console (in grid configuration). However, users can also be created by making an XMLRPC call directly to the ROBUST service. This facility has been available since OpenSimulator 0.7.3. It can currently only be used in grid configuration.

Setup

The listener for the createuser XMLRPC call on ROBUST has to be explicitly enabled. In the [UserAccountService] section of Robust.ini, set AllowCreateUser = true like so.

[UserAccountService]
AllowCreateUser = true

Please be aware that this will expose the call on the UserAccountServiceConnector as listed in the ServiceConnectiors parameter in the [Startup] section at the top of the file. The default port used (8003) is one that should not be exposed to other users. For logging into OpenSimulator you only need to expose the port that is running the LLLoginServiceInConnector (8002 by default).

Use

Setting AllowCreateUser = true will expose the create user XMLRPC function. Here's an example python program of how to call this. It assumes that your ROBUST services are running on localhost.

#!/usr/bin/python
 
import httplib
import urllib
 
params = urllib.urlencode({'METHOD':'createuser', 'FirstName':'Fred', 'LastName':'Flintstone', 'Password':'test', 'PrincipalID':'3a1c8128-908f-4455-8157-66c96a46f75e'})
conn = httplib.HTTPConnection("localhost", 8003);
conn.request("POST", "/accounts", params)
response = conn.getresponse()
print response.read();

PrincipalID is the unique ID of the user.

If everything goes well, you should get back

<?xml version="1.0"?>
<ServerResponse>
  <result type="List">
    <FirstName>Fred</FirstName>
    <LastName>Flintstone</LastName>
    <Email/>
    <PrincipalID>3a1c8128-908f-4455-8157-66c96a46f75e</PrincipalID>
    <ScopeID>00000000-0000-0000-0000-000000000000</ScopeID>
    <Created>1318974501</Created>
    <UserLevel>0</UserLevel>
    <UserFlags>0</UserFlags>
    <ServiceURLs>HomeURI*;GatekeeperURI*;InventoryServerURI*;AssetServerURI*;</ServiceURLs>
  </result>
</ServerResponse>

Don't worry about ScopeID, this is used for allow multiple grids to co-exist inside a single database. Created is a unix timestamp of the time the user was created. UserLevel determines whether the user is a god (>= 200) or can log in at all (<0). ServiceURLs are HyperGrid related and do not concern us here.

If the call fails you will get the response

<?xml version="1.0"?>
<ServerResponse>
  <result>Failure</result>
</ServerResponse>
Personal tools
General
About This Wiki