Skip to main content

Detail User Set Policy by ID

This API returns detailed information about a specific user set policy identified by ID.

Endpoint Details

URL/v1/config-agent/user-sets/id
MethodGET
AuthorizationBearer Token

Request Headers

HeaderTypeDescription
Content-TypeStringMust be application/json

Request Path

To retrieve the details of a specific user set policy, use the following request format:

/v1/config-agent/user-sets/95811aa4-5b61-46d3-a007-14d0a576ef60

Path Parameter

ParameterTypeDescription
idUUIDUnique identifier of the user set policy

Response

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

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
}
}

Field Descriptions

FieldTypeDescription
idUUIDUnique identifier of the user set policy
tenant_idUUIDIdentifier of the tenant that owns the user set policy
nameStringName of the user set policy
descriptionStringDescription of the user set policy
usersArrayList of users included in the policy
unameStringUsername of the user
gnameStringGroup name of the user
uidStringUser ID (UID) of the user
gidStringGroup ID (GID) of the user
domain_osStringOperating system domain that restricts the policy
created_byUUIDIdentifier of the user who created the policy
created_by_nameStringDisplay name of the user who created the policy
updated_byUUIDIdentifier of the user who last updated the policy
updated_by_nameStringDisplay name of the user who last updated the policy
created_atIntegerCreation timestamp in Unix format
updated_atIntegerLast update timestamp in Unix format

info
  • A valid Bearer Token is required to access this endpoint.
  • The id path parameter must reference an existing user set policy.
  • 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.