cral.api.core.groups
create-groupclj
(create-group ticket body)(create-group ticket body query-params & [opts])Create a group.
The group id must start with "GROUP_". If this is omitted it will be added automatically.
This format is also returned when listing groups or group memberships. It should be noted that the other group-related operations also expect the id to start with "GROUP_".
If one or more parent-ids are specified then the group will be created and become a member of each of the specified parent groups.
If no parent-ids are specified then the group will be created as a root group.
The group will be created in the APP.DEFAULT and AUTH.ALF zones.
You must have admin rights to create a group.
More info here.
Create a group. The group id must start with "GROUP_". If this is omitted it will be added automatically. This format is also returned when listing groups or group memberships. It should be noted that the other group-related operations also expect the id to start with "GROUP_". If one or more **parent-ids** are specified then the group will be created and become a member of each of the specified parent groups. If no **parent-ids** are specified then the group will be created as a root group. The group will be created in the **APP.DEFAULT** and **AUTH.ALF** zones. You must have admin rights to create a group.\ More info [here](https://api-explorer.alfresco.com/api-explorer/?urls.primaryName=Core%20API#/groups/createGroup).
create-group-membershipclj
(create-group-membership ticket group-id body)(create-group-membership ticket group-id body query-params & [opts])Create a group membership (for an existing person or group) within a group group-id.
If the added group was previously a root group then it becomes a non-root group since it now has a parent.
It is an error to specify an id that does not exist.
You must have admin rights to create a group membership.
More info here.
Create a group membership (for an existing person or group) within a group `group-id`. If the added group was previously a root group then it becomes a non-root group since it now has a parent. It is an error to specify an id that does not exist. You must have admin rights to create a group membership.\ More info [here](https://api-explorer.alfresco.com/api-explorer/?urls.primaryName=Core%20API#/groups/createGroupMembership).
delete-groupclj
(delete-group ticket group-id)(delete-group ticket group-id query-params & [opts])Delete group group-id.
The option to cascade delete applies this recursively to any hierarchy of group members.
In this case, removing a group member does not delete the person or sub-group itself.
If a removed sub-group no longer has any parent groups then it becomes a root group.
You must have admin rights to delete a group.
More info here.
Delete group `group-id`. The option to cascade delete applies this recursively to any hierarchy of group members. In this case, removing a group member does not delete the person or sub-group itself. If a removed sub-group no longer has any parent groups then it becomes a root group. You must have admin rights to delete a group.\ More info [here](https://api-explorer.alfresco.com/api-explorer/?urls.primaryName=Core%20API#/groups/deleteGroup).
delete-group-membershipclj
(delete-group-membership ticket group-id group-member-id & [opts])Delete group member group-member-id (person or sub-group) from group group-id.
Removing a group member does not delete the person or sub-group itself.
If a removed sub-group no longer has any parent groups then it becomes a root group.
You must have admin rights to delete a group membership.
More info here.
Delete group member `group-member-id` (person or sub-group) from group `group-id`. Removing a group member does not delete the person or sub-group itself. If a removed sub-group no longer has any parent groups then it becomes a root group. You must have admin rights to delete a group membership.\ More info [here](https://api-explorer.alfresco.com/api-explorer/?urls.primaryName=Core%20API#/groups/deleteGroupMembership).
get-group-detailsclj
(get-group-details ticket group-id)(get-group-details ticket group-id query-params & [opts])Get details for group group-id.
You can use the include parameter in query-params to return additional information.
More info here.
Get details for group `group-id`. You can use the **include** parameter in `query-params` to return additional information.\ More info [here](https://api-explorer.alfresco.com/api-explorer/?urls.primaryName=Core%20API#/groups/getGroup).
list-group-membershipsclj
(list-group-memberships ticket group-id)(list-group-memberships ticket group-id query-params & [opts])Gets a list of the group memberships for the group group-id.
You can use the where parameter in query-params to filter the returned groups by member-type.
More info here.
Gets a list of the group memberships for the group `group-id`. You can use the **where** parameter in `query-params` to filter the returned groups by **member-type**.\ More info [here](https://api-explorer.alfresco.com/api-explorer/?urls.primaryName=Core%20API#/groups/listGroupMemberships).
list-groupsclj
(list-groups ticket)(list-groups ticket query-params & [opts])Gets a list of groups.
You can use the include parameter in query-params to return additional information.
More info here.
Gets a list of groups. You can use the **include** parameter in `query-params` to return additional information.\ More info [here](https://api-explorer.alfresco.com/api-explorer/?urls.primaryName=Core%20API#/groups/listGroups).
list-user-group-membershipsclj
(list-user-group-memberships ticket person-id)(list-user-group-memberships ticket person-id query-params & [opts])Gets a list of group membership information for person person-id.
You can use the -me- string in place of person-id to specify the currently authenticated user.
You can use the include parameter in query-params to return additional information.
More info here.
Gets a list of group membership information for person `person-id`. You can use the **-me-** string in place of `person-id` to specify the currently authenticated user. You can use the **include** parameter in `query-params` to return additional information.\ More info [here](https://api-explorer.alfresco.com/api-explorer/?urls.primaryName=Core%20API#/groups/listGroupMembershipsForPerson).
update-group-detailsclj
(update-group-details ticket group-id body)(update-group-details ticket group-id body query-params & [opts])Update details (display-name) for group group-id.
You must have admin rights to update a group.
More info here.
Update details (display-name) for group `group-id`. You must have admin rights to update a group.\ More info [here](https://api-explorer.alfresco.com/api-explorer/?urls.primaryName=Core%20API#/groups/updateGroup).
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close