IDidentomat

List groups

Changed on

Retrieves a list of groups associated with the specified company. Each group includes its ID, name, description, and a list of its members.

Parameters:

  • companyKey (string, required) - The company's secret key.
post/list-groups

Request

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

Request body

companyKeystring

Example request

{
  "companyKey": "your-company-secret-key"
}

Response

Success

Example response

{
  "result": [
    {
      "id": "650976e8dc32104b8bb1757e",
      "name": "group-name",
      "description": "group-description",
      "memberUserIds": [
        "64f4d0ec35f5bb20a8022012",
        "64f4d10435f5bb20a8022013",
        "64f4d12335f5bb20a8022014"
      ]
    }
  ]
}

Changes