Example URLs:

  • https://url.edu/v2/Groups/id:fh4n5htugjdk3ksxncj3/Members
  • https://url.edu/v2/Groups/name:institution:community:employee/Members

Parameters:

  • membershipType: all (default), or immediate

Parameters:

Parameter name
Required?
Cardinality
Type
Possible values
Description
membershipTypeoptionalsinglestring
Param
Description
 all (default)all members of the group will be returned
immediateimmediate members will be returned (i.e. assigned to the group, not a membership due to a membership in a group which is a member of the group. Note, if a member is immediate and nonImmediate that member will also be returned
nonImmediatenonImmediate members will be returned (i.e. assigned to a group which is a member of this group. Note, could be any number of levels nested. Note, if a member is immediate and nonImmediate that member will also be returned
Describes the membership type of the returned members. Only the values listed are allowed.
memberTypeoptionalsinglestring
Param
Description
usersmembers that are returned in the Users resource
groupsmembers that are returned in the Groups resource
systemsmembers that represent applications or devices (which resource?)
all (default)all members are returned
type of members returned. Site specific values (named something that wont be defined by tier later) are allowed

 

Representation

 

 {
     "schemas": ["urn:ietf:params:scim:api:messages:2.0:ListResponse", "urn:edu:internet2:tier:2.0:UserListResponse"],
     "totalResults":100,
     "itemsPerPage":10,
     "startIndex":1,
     "Resources":[
       {
         "id":"2819c223-7f76-413861904646",
         "userName":"jsmith",
         "edu:internet2:tier:User:netId": "jsmith", 
         "displayName":"Smith, James"
       },
       {
         "id":"c8596b90-7539-4f20968d1908",
         "userName":"alice123"
         "edu:internet2:tier:User:netId": "asmith", 
         "displayName":"Smith, Alice"
       },
        ...
     ]
   }

 

 

  • No labels