membership /direct/membership/describe

Represents a user's membership in a location (site, group, etc.) in the system, works with the site/group entities and the user entities. In the documentation below, a membership ID is a string in the form USER_ID::LOCATION_REFERENCE (e.g., "aaronz::site:mySiteId").

/membership By default, retrieves a list of all site memberships for the current user. Optional query parameters: "includeSites=false" filters out site memberships; "includeGroups=true" retrieves group memberships; "_locationReference=LOCATION_REFERENCE" returns all memberships in the specified site or group; "user=USER_ID" (or "userId=USER_ID" or "_userReference=USER_REFERENCE") returns the given user's memberships; "includeMemberDetails=true" to return member full details of just the role of the user, cannot use this with includeGroups=true; "role=ROLE_STRING" (or "roleId=ROLE_STRING") restricts the list to the specified member role. /membership/new (POST) Add the membership specified by the ID. Alternatively, a POST to the simple "/membership" URL can specify "userId" and "locationReference" request parameters. In either case, optional request parameters are: "memberRole" string (default for joinable site memberships is the default joiner role); "active" Boolean value (default is true). Can do a batch add to the same location using the same role by specifying a "userIds" parameter (an array of user IDs). /membership/:ID: /membership/:ID:/edit (POST) Modify the membership specified by the ID. Alternatively, a POST to the "/membership" URL can specify "userId" and "locationReference" request parameters. In either case, optional request parameters are: "memberRole" string; "active" Boolean value. Can do a batch update to the same location using the same role and active setting by specifying a "userIds" parameter (an array of user IDs). /membership/:ID:/delete (DELETE) Delete the membership specified by the ID. Multiple memberships can be deleted from the same location by specifying a "userIds" parameter (an array of user IDs). site /direct/membership/site The URL format is "/membership/site/:SITE_ID:".
(GET) will return all memberships in the specified site.
(POST) will add one or more site memberships via an array of "userSearchValues" request parameters (each of which is a user ID, user EID, or email address), along with a "memberRole" string (default for joinable site memberships is the default joiner role) and "active" Boolean value (default is true). Response headers may include "x-warning-not-found" (for a list of invalid userSearchValues) and "x-warning-already-members" (for a list of userSearchValues which were already site members). unjoin /direct/membership/unjoin POST new Allows a user without permissions in a site to unjoin from it, works with the current user only: /membership/unjoin/site/siteId sitebyjson /direct/membership/sitebyjson POST new The URL format is "/membership/sitebyjson/:SITE_ID:".
(POST) will add one or more site memberships via an chunk of JSON supplied in the 'json' request parameter.

The JSON needs to be formatted like this:

[ {"id": "user1", "role": "access"}, {"id": "user2","role": "maintain"} ]

Three response headers will be set:

x-success-count, which contains the number of successful additions
x-warning-not-found, which contains a comma separated list of user ids which didn't exist
x-warning-already-members, which contains a comma separated list of user ids which were already in the site join /direct/membership/join POST new Allows a user without permissions in a site to join it, works with the current user only: /membership/join/site/siteId fastroles /direct/membership/fastroles Allows for retrieval of current role in site only quickly. Use the format "/membership/fastroles/:userId:" (or userEid) or current user if none specified. A shortcut for includeMemberDetail=false. group /direct/membership/group The URL format is "/membership/group/:groupId:"
(GET) will return all memberships for a group.
(POST) will update user group membership. Mandatory POST Parameters: 'userIds' a comma separated list of users (eid or id). 'action' can have values: update, add or remove. If update, replace the current membership with the provided list. If add, add the list to the existing membership, if remove, remove the list from the existing membership. html xml json form html xml json org.sakaiproject.entitybroker.providers.model.EntityMember bean active boolean true true id java.lang.String true false lastLoginTime java.util.Date true false locationReference java.lang.String true true memberRole java.lang.String true true provided boolean true true userDisplayId java.lang.String true false userDisplayName java.lang.String true false userEid java.lang.String true false userEmail java.lang.String true false userFirstName java.lang.String true false userId java.lang.String true true userLastName java.lang.String true false userSortName java.lang.String true false CoreEntityProvider org.sakaiproject.entitybroker.entityprovider.CoreEntityProvider EntityProvider org.sakaiproject.entitybroker.entityprovider.EntityProvider ActionsExecutable org.sakaiproject.entitybroker.entityprovider.capabilities.ActionsExecutable CRUDable org.sakaiproject.entitybroker.entityprovider.capabilities.CRUDable CollectionResolvable org.sakaiproject.entitybroker.entityprovider.capabilities.CollectionResolvable Createable org.sakaiproject.entitybroker.entityprovider.capabilities.Createable Deleteable org.sakaiproject.entitybroker.entityprovider.capabilities.Deleteable Describeable org.sakaiproject.entitybroker.entityprovider.capabilities.Describeable Inputable org.sakaiproject.entitybroker.entityprovider.capabilities.Inputable Outputable org.sakaiproject.entitybroker.entityprovider.capabilities.Outputable RESTful org.sakaiproject.entitybroker.entityprovider.capabilities.RESTful Redirectable org.sakaiproject.entitybroker.entityprovider.capabilities.Redirectable Resolvable org.sakaiproject.entitybroker.entityprovider.capabilities.Resolvable Sampleable org.sakaiproject.entitybroker.entityprovider.capabilities.Sampleable Saveable org.sakaiproject.entitybroker.entityprovider.capabilities.Saveable Updateable org.sakaiproject.entitybroker.entityprovider.capabilities.Updateable