Changes between Version 25 and Version 26 of SPIDocs


Ignore:
Timestamp:
Sep 26, 2014 3:58:23 PM (7 years ago)
Author:
faber
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • SPIDocs

    v25 v26  
    379379Whenever a user is created, a circle, [wiki:SPIDocs#CircleNames named] ''userid'':''userid'', is also created containing only that user.  One can use this circle to assign rights to a user and only that user. This circle behaves like all other circles, but may seem special because of the membership and [wiki:SPIDocs#CirclePermissions permissions] assigned to it.  There is only the one member, and that member does not have the rights to modify the circle membership.  The system removes this circle when and if the user is removed.
    380380
     381Finally, each user is a member of the world circle, named 'system:world'.  A user cannot remove themselves from this circle, and it is not returned when `viewCircles` is used to [wiki:SPIDocs#ViewingCircles view circles].  The presence of the circle allows other users to easily make experiments and libraries visible to all other users.
     382
    381383==== Circle Names ====
    382384
     
    440442A user that has both `ADD_USER` and `REMOVE_USER` permissions to a circle can change the permissions granted to a user in the circle.  The `changePermissions` operation in the `Circles` service is used to do this.  It takes a circleid, a list of users, and a new set of permissions.  It returns an array of results indicating the outcome of each requested change.
    441443
    442 ==== Project Profile Management ====
     444==== Circle Profile Management ====
    443445
    444446The `Circles` [wiki:SPIDocs#Services service] supports the operations described in the [wiki:SPIDocs#Profiles profiles] description to allow applications to manipulate project profiles.  Only the owner of a circle can change the contents of its profile.
     
    449451
    450452The `viewCircles` operation takes the user doing the search and an optional [http://en.wikipedia.org/wiki/Regular_expression regular expression] that scopes the search.  If the regular expression is given, only circleids matching it are returned.  Administrators can use `viewCircles` to get a list of circle descriptions visible to a given user.
     453
     454The `system:world` circle is never returned by `viewCircles` but all users are members of that circle.
    451455
    452456==== Administrative Operations ====
     
    554558
    555559
    556 
    557 
     560==== Viewing Experiments ====
     561
     562A user can always view circles that they can read.  The `viewExperiments` operation on the `Experiments` [wiki:SPIDocs#Services service] returns summaries of the various experiments.  Experiment descriptions contain more information than the descriptions of circles.  Specifically aspects and ACLs can be selected individually to be shown for each experiment returned.
     563
     564The `viewExperiments` operation takes the following parameters:
     565
     566||= Parameter =||= Meaning =||
     567|| uid || Return experiments this user can read. Admins may successfully view experiments as another user, but most users can only specify their own userid here. ||
     568|| lib || Restrict returned experiments to those in this [wiki:SPIDocs#Libraries library] ||
     569|| regex || Restrict returned experiments to those that have an experimentid that matches the given [http://en.wikipedia.org/wiki/Regular_expression regular expression]
     570
     571
     572
     573The description
     574
     575The `viewCircles` operation takes the user doing the search and an optional [http://en.wikipedia.org/wiki/Regular_expression regular expression] that scopes the search.  If the regular expression is given, only circleids matching it are returned.  Administrators can use `viewCircles` to get a list of circle descriptions visible to a given user.
     576