Request
The primary key for each resource.
Body Params application/vnd.api+json
The primary key for each resource.
{
"data": {
"id": "FID001",
"type": "UserGroup",
"attributes": {
"name": "string",
"description": "string",
"attr": {},
"isArchived": true,
"membershipExpiryEnabled": true,
"membershipExpiryTimeToExpireInMs": 0
},
"relationships": {
"owner": {
"data": {
"id": "FID001",
"type": "User"
}
},
"userType": {
"data": {
"id": "FID001",
"type": "UserType"
}
},
"subPortal": {
"data": {
"id": "FID001",
"type": "SubPortal"
}
},
"parentGroup": {
"data": {
"id": "FID001",
"type": "UserGroup"
}
}
}
}
}
Request samples
curl --location --request PATCH 'https://api.synap.ac/v3/user-groups/' \
--header 'Content-Type: application/vnd.api+json' \
--data-raw '{
"data": {
"id": "FID001",
"type": "UserGroup",
"attributes": {
"name": "string",
"description": "string",
"attr": {},
"isArchived": true,
"membershipExpiryEnabled": true,
"membershipExpiryTimeToExpireInMs": 0
},
"relationships": {
"owner": {
"data": {
"id": "FID001",
"type": "User"
}
},
"userType": {
"data": {
"id": "FID001",
"type": "UserType"
}
},
"subPortal": {
"data": {
"id": "FID001",
"type": "SubPortal"
}
},
"parentGroup": {
"data": {
"id": "FID001",
"type": "UserGroup"
}
}
}
}
}'
Responses
The primary key for each resource.
{
"data": {
"id": "FID001",
"type": "UserGroup",
"attributes": {
"name": "string",
"description": "string",
"attr": {},
"isDefaultGroup": true,
"defaultGroupType": "string",
"isArchived": true,
"totalUsers": 0,
"parentId": "string",
"internal": true,
"membershipExpiryEnabled": true,
"membershipExpiryTimeToExpireInMs": 0
},
"relationships": {
"owner": {
"data": {
"id": "FID001",
"type": "User"
}
},
"userType": {
"data": {
"id": "FID001",
"type": "UserType"
}
},
"subPortal": {
"data": {
"id": "FID001",
"type": "SubPortal"
}
},
"parentGroup": {
"data": {
"id": "FID001",
"type": "UserGroup"
}
}
}
}
}
Modified at 2025-07-08 10:51:22