Update existing group

Changed on

Allows you to modify an existing group by updating its name, description, or changing the members in the group. To keep existing members in the group, you must include their IDs in the list.

Parameters:

  • companyKey (string, required) - The company's secret key.
  • groupId (string, required) – The unique identifier of the group.
  • name (string, optional) – The name of the new group.
  • description (string, optional) – A description for the group.
  • memberIds (array of strings, optional) – A list of user IDs to be added or removed from the group. To keep existing members in the group, you must include their IDs in the list.
post/change-group

Request

  • Base URL
    https://external-api.identomat.com
  • Auth
    none declared

Request body

companyKeystring
groupIdstring
namestring
descriptionstring
memberIdsstring[]

Example request

{
  "companyKey": "your-company-secret-key",
  "groupId": "64a50a0c6c2ff7f9a1f12833",
  "name": "Group 1",
  "description": "Group 1 description",
  "memberIds": [
    "user1_id",
    "user2_id"
  ]
}

Response

Success

ChangeGroupResponse required

Example response

{}

Changes

    • breaking

      added subschema #3 to the response body oneOf list for the response status

    • info

      added the new optional request property