A GroupManager RESTful api spec

 
eid = an experiment name
gid = a group name
uid = a user name
 
 
 
Keywords:
users, groups, experiments, subgroups, direct, indirect, exp
 
 
Reserved characters:
';' ','
 
No users, groups, or experiments may be named one of the keywords.
Names should not use HTTP reserved characters.
 
Users Resource


Create user
POST /users
name=jim


Get all user groups (with experiments)
GET /users/{uid}/groups
[
  {"experiment":"SRS",
   "groups":[
        "DatacatAdmin",
        "PipelineAdmin"
      ]
   },
  {"experiment":"EXO",
   "groups":[
        "DatacatAdmin",
        "PipelineAdmin"
      ]
   }
]

GET /users/{uid}/experiments
[ "SRS", "EXO" ]
 
GET /users/{uid}/{experiment}/groups               // Includes the groups the user is directly in and any children
GET /users/{uid}/{experiment}/groups;direct        // Includes only groups the user is directly in
GET /users/{uid}/{experiment}/groups;indirect      // Only groups the user is indirectly in.
["DatacatAdmin", "PipelineAdmin" ]
 
Get a the user list
GET /exp/{eid}/userlist
 
Creates a group
POST /exp/{eid}/groups

Get an experiment's groups
GET /exp/{eid}/groups


Create a group in an experiment
POST /exp/{eid}/groups
name=DatacatAdmin


Get an experiment's group
GET /exp/{eid}/groups/{gid}


Get an experiment's group
GET /exp/{eid}/groups/{gid}

Get all users in an experiment's group
GET /exp/{eid}/groups/{gid}/users


Add a user to a group
POST /exp/{eid}/groups/{gid}/users
name=jim


Check if user is in group
GET /exp/{eid}/groups/{gid}/users/{uid}                // User in this group directly or indirectly
GET /exp/{eid}/groups/{gid}/users/{uid};direct         // Directly in this group
GET /exp/{eid}/groups/{gid}/users/{uid};indirect       // Indirectly in this group


Add a group to a group (must already exist)
POST /exp/{eid}/groups/{gid}/subgroups
name=DatacatAdmin


Check if group is in group
GET /exp/{eid}/groups/{gid}/subgroups/{gid}            // Group in this group directly or indirectly
GET /exp/{eid}/groups/{gid}/subgroups/{gid};direct     // Group is directly in this group
GET /exp/{eid}/groups/{gid}/subgroups/{gid};indirect   // Group is indirectly in this group



Get children of group
GET /exp/{eid}/groups/{gid}/subgroups               // All, includes children's children
GET /exp/{eid}/groups/{gid}/subgroups;direct        // Direct Children
GET /exp/{eid}/groups/{gid}/subgroups;indirect      // Only children's children
["DatacatAdmin", "PipelineAdmin"]



NOTE:
/exp/{eid} may be omitted if x-srs-experiment header set in request.