Changes between Version 8 and Version 9 of NewTestbedAPISpec

Timestamp:

Jul 21, 2013 7:48:18 AM (11 years ago)

Author:

faber

Comment:

--

NewTestbedAPISpec

@@ -254 +254 @@
    * None
 
-=== Creation ===
+=== Creation and Deletion ===
 
 Finally a user can request access to the testbed by creating a profile.  The user has no privileges and consumes minimal resources until they join a vetted project.  This is an unauthenticated call, but the user profile is not created until an automated e-mail exchange is made between the testbed and the proto-user.
 
  * '''Service:''' Users
- * '''Operation:''' getProfileDescription
- * '''Input Parameters:'''
-   * Userid - the requested userid
+ * '''Operation:''' createUser
+ * '''Input Parameters:'''
+   * Userid - the requested userid (optional)
    * A list of profile elements each containing
      * Name - a string, the element's name
      * StringValue - a string containing the element's value, unless it is binary/opaque
  * '''Return Values:'''
-  * None
+  * The userid actually created
 
 Note that all non-optional fields must be provided, so this is best preceeded by a call to getProfileDescription to learn the fields.
+
+A base userid is constructed, either from the userid presented or from a required field in the profile.  If that base userid is available, that a user with that userid is created.  Otherwise the userid is disambiguated until there are no collisions.  The userid actually created is returned.
+
+The user is created without membership in any projects and without a password.  A password reset challenge (equivalent to one issued by requestPasswordReset) is issued and the challenge e-mailed to the user at the address in the profile.
+
+Removing a user is accomplished using
+ * '''Service:''' Users
+ * '''Operation:''' removeUser
+ * '''Input Parameters:'''
+   * Userid - the requested userid
+ * '''Return Values:'''
+  * a boolean, true if the user was removed
+
+Most users are unlikely to use this service, and policy may allow only administrators to remove users.
 
 == Projects ==