Skip to content

Group Management

Ahmed Glez edited this page Mar 30, 2023 · 1 revision

Group Management

The Cujae LDAP Manager provides a REST API for managing groups in an LDAP service. This page describes how to perform common group management tasks using the API.

Viewing Groups

To view a list of all groups in the LDAP service:

  1. Make a GET request to /groups.
  2. The list of all groups in the LDAP service will be returned in the response body.

Adding Groups

To add a new group to the LDAP service:

  1. Make a POST request to /groups.
  2. Include the group's details (e.g. group name, description, etc.) in the request body as JSON.
  3. The new group will be added to the LDAP service, and the group's details will be returned in the response body.

Updating Groups

To update an existing group in the LDAP service:

  1. Make a PUT request to /groups/{groupId}, where {groupId} is the ID of the group you want to update.
  2. Include the updated group details in the request body as JSON.
  3. The updated group details will be saved in the LDAP service, and the new group details will be returned in the response body.

Deleting Groups

To delete an existing group from the LDAP service:

  1. Make a DELETE request to /groups/{groupId}, where {groupId} is the ID of the group you want to delete.
  2. The group will be removed from the LDAP service.

Group Membership

The Cujae LDAP Manager allows users to be added to or removed from groups using the API. To add a user to a group:

  1. Make a PUT request to /groups/{groupId}/users/{userId}, where {groupId} is the ID of the group you want to add the user to, and {userId} is the ID of the user you want to add.
  2. The user will be added to the group.

To remove a user from a group:

  1. Make a DELETE request to /groups/{groupId}/users/{userId}, where {groupId} is the ID of the group you want to remove the user from, and {userId} is the ID of the user you want to remove.
  2. The user will be removed from the group.

Note: Authentication is required for all requests that modify data (e.g. POST, PUT, DELETE). Please refer to the authentication documentation for more information.

Clone this wiki locally