Skip to content

PodWacGroupsService

This service, automatically created by the AppService with the key pod-wac-groups, allows you to manage WAC groups. See this page for usage examples.

Actions

The following service actions are available.

get

Get the members of a group.

Parameters

PropertyTypeDescription
groupUriStringURI of the group
groupSlugStringSlug of the group. Used to find the groupUri if not provided.
actorUriStringWebID of the Pod on which the action should be done

Return value

An array with the WebID of the group members.

list

Get the list of all available groups on the Pod.

Parameters

PropertyTypeDescription
actorUriStringWebID of the Pod on which the action should be done

Return value

An array with the URI of all the groups on the Pod.

create

Create a new WAC group on the Pod.

Parameters

PropertyTypeDescription
groupSlugStringDesired slug for the group. Will be “slugified” if necessary.
actorUriStringWebID of the Pod on which the action should be done

Return value

The URI of the newly-created group, e.g. http://localhost:3000/_groups/{username}/{group-slug}

delete

Delete a WAC group from the Pod.

Parameters

PropertyTypeDescription
groupUriStringURI of the group
groupSlugStringSlug of the group. Used to find the groupUri if not provided.
actorUriStringWebID of the Pod on which the action should be done

Return value

True if the operation succeeded.

addMember

Add a member to a WAC group.

Parameters

PropertyTypeDescription
groupUriStringURI of the group
groupSlugStringSlug of the group. Used to find the groupUri if not provided
memberUriStringURI of an agent to be added to the group
actorUriStringWebID of the Pod on which the action should be done

Return value

True if the operation succeeded.

removeMember

Remove a member from a WAC group.

Parameters

PropertyTypeDescription
groupUriStringURI of the group
groupSlugStringSlug of the group. Used to find the groupUri if not provided
memberUriStringURI of an agent to be removed from the group
actorUriStringWebID of the Pod on which the action should be done

Return value

True if the operation succeeded.