v1

latestOpenAPI 3.1.02026-08-04751,1671.3 MB

User Groups

Get User Group

Retrieve user group details

get/api/v1/user-groups/{id}

Path parameters

idstring uuid required

ID of the user group to retrieve.

Response

Successful Response

idstring uuid required

The unique identifier of the object in the Fordefi platform.

created_atstring date-time required

The date and time when the object was created.

modified_atstring date-time required

The date and time when the object was last modified. Any change to any field of the resource is considered a modification.

namestring required

The name of the user group.

users_countinteger required

The number of users in the group.

admins_countinteger required

The number of admins in the group.

state'active' | 'deleted' required

Represents a user group state in the Fordefi platform

Example response

{
  "modified_by": {
    "name": "John Doe"
  },
  "proposed_change": {
    "created_by": {
      "name": "John Doe"
    },
    "added_users": [
      {
        "name": "John Doe"
      }
    ],
    "removed_users": [
      {
        "name": "John Doe"
      }
    ]
  }
}