UserAccountService - Revision history

Justincc: /* Introduction */

2014-07-31T19:32:48Z

‎Introduction

Justincc: forgot to put LastName parameter in createuser call example

2012-12-07T19:44:38Z

forgot to put LastName parameter in createuser call example

Justincc at 02:26, 15 November 2012

2012-11-15T02:26:55Z

Justincc: /* Sample scripts */

2012-11-15T02:26:24Z

‎Sample scripts

Justincc: /* Sample scripts */

2012-11-15T02:26:01Z

‎Sample scripts

Justincc: Undo revision 31244 by Justincc (talk)

2012-11-15T02:25:46Z

Undo revision 31244 by Justincc (talk)

Justincc: /* Sample scripts */

2012-11-15T02:25:26Z

‎Sample scripts

Justincc: /* getaccount */

2012-11-13T01:42:31Z

‎getaccount

Justincc: /* Calls */

2012-11-13T01:40:32Z

‎Calls

Justincc: /* Introduction */

2012-11-01T01:25:01Z

‎Introduction

← Older revision		Revision as of 19:32, 31 July 2014
Line 4:		Line 4:

	This documentation is not complete yet - some more information can be found at [[UserManipulation]].		This documentation is not complete yet - some more information can be found at [[UserManipulation]].
−
−	~~'''TODO: Document getaccount operation'''.~~

	=API=		=API=

@@ Line 240: / Line 240: @@
 import urllib
-params = urllib.urlencode({'METHOD':'setaccount', 'FirstName':'Tyrion', 'PrincipalID':'3a1c8128-908f-4455-8157-66c96a46f75e'})
+params = urllib.urlencode({'METHOD':'setaccount', 'FirstName':'Tyrion', 'LastName':'Snow', 'PrincipalID':'3a1c8128-908f-4455-8157-66c96a46f75e'})
 conn = httplib.HTTPConnection("localhost", 8003);
 conn.request("POST", "/accounts", params)

← Older revision		Revision as of 02:26, 15 November 2012
Line 168:		Line 168:

	in Robust.ini. This can currently only safely be done on closed grids (i.e. where you control all simulators).		in Robust.ini. This can currently only safely be done on closed grids (i.e. where you control all simulators).
		+
		+	Here's an example python program to call this. It assumes that your ROBUST services are running on localhost.
		+
		+	<source lang="python">
		+	#!/usr/bin/python
		+
		+	import httplib
		+	import urllib
		+
		+	params = urllib.urlencode({'METHOD':'setaccount', 'FirstName':'Tyrion', 'PrincipalID':'3a1c8128-908f-4455-8157-66c96a46f75e'})
		+	conn = httplib.HTTPConnection("localhost", 8003);
		+	conn.request("POST", "/accounts", params)
		+	response = conn.getresponse()
		+	print response.read();
		+	</source>
		+
		+	PrincipalID is the unique ID of the user. Here, it is used to identify the user that we set up earlier.
		+
		+	If everything goes well, you should get back
		+
		+	<source lang="xml">
		+	<?xml version="1.0"?>
		+	<ServerResponse>
		+	<result type="List">
		+	<FirstName>Tyrion</FirstName>
		+	<LastName>Snow</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>
		+	</source>
		+
		+	Note that the first name has now changed from Jon to Tyrion.
		+
		+	If the call fails you will get the response
		+
		+	<source lang="xml">
		+	<?xml version="1.0"?>
		+	<ServerResponse>
		+	<result>Failure</result>
		+	</ServerResponse>
		+	</source>
		+
		+	=== createuser ===
		+
		+	This is only available if you have explicitly set
		+
		+	[UserAccountService]
		+	AllowCreateUser = true
		+
		+	in Robust.ini. This can currently only safely be done on closed grids (i.e. where you control all simulators).
		+
		+	You may also want to make sure that you have
		+
		+	[UserAccountService]
		+	CreateDefaultAvatarEntries = true
		+
		+	set so that a new user will have the initial minimal body-part/clothing set (skin, shape, eyes, hair, pants, shirt) required for them to appear as anything other than a gas-cloud on Viewer 3 and related third party viewers (viewer version 1 and related third party viewers will show a default "Ruth" avatar instead).

	Here's an example python program to call this. It assumes that your ROBUST services are running on localhost.		Here's an example python program to call this. It assumes that your ROBUST services are running on localhost.

← Older revision		Revision as of 02:26, 15 November 2012
Line 158:		Line 158:

	?>		?>
		+	</source>

	=== setaccount ===		=== setaccount ===

← Older revision		Revision as of 02:26, 15 November 2012
Line 158:		Line 158:

	?>		?>
−
−	~~=== createuser ===~~
−
−	~~This is only available if you have explicitly set~~
−
−	~~[UserAccountService]~~
−	~~AllowCreateUser = true~~
−
−	~~in Robust.ini. This can currently only safely be done on closed grids (i.e. where you control all simulators).~~
−
−	~~Here's an example python program to call this. It assumes that your ROBUST services are running on localhost.~~
−
−	~~<source lang="python">~~
−	~~#!/usr/bin/python~~
−
−	~~import httplib~~
−	~~import urllib~~
−
−	~~params = urllib.urlencode({'METHOD':'createuser', 'FirstName':'Jon', 'LastName':'Snow', 'Password':'test', 'PrincipalID':'3a1c8128-908f-4455-8157-66c96a46f75e'})~~
−	~~conn = httplib.HTTPConnection("localhost", 8003);~~
−	~~conn.request("POST", "/accounts", params)~~
−	~~response = conn.getresponse()~~
−	~~print response.read();~~
−	~~</source>~~
−
−	~~PrincipalID is the unique ID of the user.~~
−
−	~~If everything goes well, you should get back~~
−
−	~~<source lang="xml">~~
−	~~<?xml version="1.0"?>~~
−	~~<ServerResponse>~~
−	~~<result type="List">~~
−	~~<FirstName>Jon</FirstName>~~
−	~~<LastName>Snow</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>~~
−	~~</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.
−
−	~~If the call fails you will get the response~~
−
−	~~<source lang="xml">~~
−	~~<?xml version="1.0"?>~~
−	~~<ServerResponse>~~
−	~~<result>Failure</result>~~
−	~~</ServerResponse>~~
−	~~</source>~~

	=== setaccount ===		=== setaccount ===

← Older revision		Revision as of 02:25, 15 November 2012
Line 158:		Line 158:

	?>		?>
		+
		+	=== createuser ===
		+
		+	This is only available if you have explicitly set
		+
		+	[UserAccountService]
		+	AllowCreateUser = true
		+
		+	in Robust.ini. This can currently only safely be done on closed grids (i.e. where you control all simulators).
		+
		+	Here's an example python program to call this. It assumes that your ROBUST services are running on localhost.
		+
		+	<source lang="python">
		+	#!/usr/bin/python
		+
		+	import httplib
		+	import urllib
		+
		+	params = urllib.urlencode({'METHOD':'createuser', 'FirstName':'Jon', 'LastName':'Snow', 'Password':'test', 'PrincipalID':'3a1c8128-908f-4455-8157-66c96a46f75e'})
		+	conn = httplib.HTTPConnection("localhost", 8003);
		+	conn.request("POST", "/accounts", params)
		+	response = conn.getresponse()
		+	print response.read();
		+	</source>
		+
		+	PrincipalID is the unique ID of the user.
		+
		+	If everything goes well, you should get back
		+
		+	<source lang="xml">
		+	<?xml version="1.0"?>
		+	<ServerResponse>
		+	<result type="List">
		+	<FirstName>Jon</FirstName>
		+	<LastName>Snow</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>
		+	</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.
		+
		+	If the call fails you will get the response
		+
		+	<source lang="xml">
		+	<?xml version="1.0"?>
		+	<ServerResponse>
		+	<result>Failure</result>
		+	</ServerResponse>
		+	</source>

	=== setaccount ===		=== setaccount ===

@@ Line 54: / Line 54: @@
   FirstName=tom&LastName=thumb&METHOD=getaccount
-where
+If requesting a user account by UUID, then the POST field is encoded like so
 If successful, a server response like

@@ Line 47: / Line 47: @@
 == Calls ==
 === getaccounts ===
 This gets 0 or more user accounts that match a given name query.  This is an extremely old query and so has a few strange features.  POST field is a urlencoded string like so

@@ Line 5: / Line 5: @@
 This documentation is not complete yet - some more information can be found at [[UserManipulation]].
-'''TODO: Document remaining operations'''.
+'''TODO: Document getaccount operation'''.
 =API=