Skip to main content

Detail User Groups

This API returns the group permissions assigned to a specific user, identified by the user ID.

Endpoint Details

URL/v1/auth/users/id/groups
MethodGET
AuthorizationBearer Token

Request Headers

HeaderTypeDescription
Content-TypeStringMust be application/json

Request Path

To retrieve the group permissions of a specific user, use the following request format:

/v1/auth/users/c777977b-7a32-4040-b7b0-ee51721433fd/groups

Path Parameter

ParameterTypeDescription
idUUIDUnique identifier of the user

Response

Here is an example response after the request has been successfully processed:

Response
{
"group_permissions": [
{
"id": "aad56b5c-9900-40bf-b2cb-2c593f16e944",
"tenant_id": "5ebde17c-01a1-4394-977b-9e611250cf5d",
"group_id": "5ff4e1da-3d8d-4fde-9d01-52bde2b3bd3f",
"user_id": "c777977b-7a32-4040-b7b0-ee51721433fd",
"permission_id": "fb5f82f5-78d0-4189-884a-dd23c2e0df84",
"permission_type": "CUSTOM",
"created_by": "414a45e9-f194-4a8a-9876-97abb990d4d9",
"created_at": 1780039806
}
]
}

Field Descriptions

FieldTypeDescription
group_permissionsArrayList of group permissions assigned to the user
idUUIDUnique identifier of the group permission
tenant_idUUIDIdentifier of the tenant that owns the group permission
group_idUUIDIdentifier of the group the user belongs to
user_idUUIDIdentifier of the user
permission_idUUIDIdentifier of the permission granted to the user
permission_typeStringType of the permission
created_byUUIDIdentifier of the user who created the group permission
created_atIntegerCreation timestamp in Unix format

info
  • A valid Bearer Token is required to access this endpoint.
  • The id path parameter must reference an existing user.
  • The response list group the user belongs to along with their associated permissions.
  • Unix timestamp fields can be converted to a human-readable date and time format as needed.