List User Set Policies

This API returns a list of user set policies available within the tenant.

Endpoint Details

URL	/v1/config-agent/user-sets
Method	GET
Authorization	Bearer Token

---

Request Headers

Header	Type	Description
Content-Type	String	Must be application/json

---

Response

Here is an example of a response when viewing a list of data:

Response

{
    "data": [
        {
            "id": "95811aa4-5b61-46d3-a007-14d0a576ef60",
            "tenant_id": "5ebde17c-01a1-4394-977b-9e611250cf5d",
            "name": "Dummy User Sets",
            "users": [
                {
                    "uname": "dummy",
                    "gname": "dummy",
                    "uid": "1000",
                    "gid": "1000"
                }
            ],
            "created_by": "0a937c60-0ed4-4d06-870a-2e284b54287d",
            "created_by_name": "Admin Aplikasi",
            "updated_by": "0a937c60-0ed4-4d06-870a-2e284b54287d",
            "updated_by_name": "Admin Aplikasi",
            "created_at": 1785214953,
            "updated_at": 1785214953
        },
        {
            "id": "e3eaae0d-471c-4d34-ba13-9698f7d8955f",
            "tenant_id": "5ebde17c-01a1-4394-977b-9e611250cf5d",
            "name": "Basic User",
            "users": [
                {
                    "uname": "basicuser",
                    "gname": "basicuser",
                    "uid": "1004",
                    "gid": "1004"
                }
            ],
            "created_by": "414a45e9-f194-4a8a-9876-97abb990d4d9",
            "created_by_name": "Iqbal Adhi",
            "updated_by": "414a45e9-f194-4a8a-9876-97abb990d4d9",
            "updated_by_name": "Iqbal Adhi",
            "created_at": 1780654659,
            "updated_at": 1780654659
        },
        {
            "id": "6ae6ff00-18a0-46c9-b9b8-6561e008f5cf",
            "tenant_id": "5ebde17c-01a1-4394-977b-9e611250cf5d",
            "name": "Admin User Set",
            "users": [
                {
                    "uname": "adminuser",
                    "gname": "adminuser",
                    "uid": "1003",
                    "gid": "1003"
                }
            ],
            "created_by": "414a45e9-f194-4a8a-9876-97abb990d4d9",
            "created_by_name": "Iqbal Adhi",
            "updated_by": "414a45e9-f194-4a8a-9876-97abb990d4d9",
            "updated_by_name": "Iqbal Adhi",
            "created_at": 1780654551,
            "updated_at": 1780654551
        },
        {
            "id": "d0a6bc12-656f-4529-b413-805e9aa7f869",
            "tenant_id": "5ebde17c-01a1-4394-977b-9e611250cf5d",
            "name": "Super Admin",
            "users": [
                {
                    "uname": "superadmin",
                    "gname": "superadmin",
                    "uid": "1002",
                    "gid": "1002"
                }
            ],
            "created_by": "414a45e9-f194-4a8a-9876-97abb990d4d9",
            "created_by_name": "Iqbal Adhi",
            "updated_by": "414a45e9-f194-4a8a-9876-97abb990d4d9",
            "updated_by_name": "Iqbal Adhi",
            "created_at": 1780654432,
            "updated_at": 1780654432
        }
        {
            "id": "45a0ce7b-9f40-4dfb-bb28-8b592cb150d5",
            "tenant_id": "5ebde17c-01a1-4394-977b-9e611250cf5d",
            "name": "User Test 45677104",
            "users": [
                {
                    "uname": "usertest",
                    "gname": "usertest",
                    "uid": "1006",
                    "gid": "1006"
                }
            ],
            "created_by": "414a45e9-f194-4a8a-9876-97abb990d4d9",
            "created_by_name": "Iqbal Adhi",
            "updated_by": "414a45e9-f194-4a8a-9876-97abb990d4d9",
            "updated_by_name": "Iqbal Adhi",
            "created_at": 1780045687,
            "updated_at": 1780045723
        }
    ],
    "pagination": {
        "total": 5,
        "page_size": 5,
        "last_page": 1
    }
}

---

Field Descriptions

Field	Type	Description
id	UUID	Unique identifier of the user set policy
tenant_id	UUID	Identifier of the tenant that owns the user set policy
name	String	Name of the user set policy
description	String	Description of the user set policy
users	Array	List of users included in the policy
uname	String	Username of the user
gname	String	Group name of the user
uid	String	User ID (UID) of the user
gid	String	Group ID (GID) of the user
domain_os	String	Operating system domain that restricts the policy
created_by	UUID	Identifier of the user who created the policy
created_by_name	String	Display name of the user who created the policy
updated_by	UUID	Identifier of the user who last updated the policy
updated_by_name	String	Display name of the user who last updated the policy
created_at	Integer	Creation timestamp in Unix format
updated_at	Integer	Last update timestamp in Unix format
total	Integer	Total number of user set policies available
page_size	Integer	Number of records returned per page
last_page	Integer	Total number of available pages

---

info

• A valid Bearer Token is required to access this endpoint.
• The description field may not be present if the policy was created without a description.
• The domain_os field is only present when a domain restriction is configured for the user.
• Unix timestamp fields can be converted to a human-readable date and time format as needed.