Creates a user group in Intel Exchange.
Body Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| name | string | required | Pass the name of the user group. |
| permissions | array | required | Pass the list of permissions associated with the user. This parameter expects a list of permission IDs. Use the Get List Components API to retrieve the list of permissions. |
| is_active | boolean | optional | Pass True if the user group is active, else pass False. |
| description | string | optional | Pass the description of the user group. |
Run it
Use the Request parameters panel to enter path IDs, query values, JSON body, and credentials. Then run any snippet below — all languages use the same values. Base URL: https://cs-testv2.cyware.com/ctixapi (change in API Settings).
Playground
Request parameters
Edit values here before running any snippet below (cURL, JavaScript, or Python). Code blocks are reference only — your inputs above are what gets sent.
Open API (HMAC signature) · Get credentials from Cyware Admin → Open API → Generate Credentials.
Signature and Expires are generated when you run a request. Access ID and Secret Key stay in memory for this tab only.
Credentials from Authentication auto-fill here for this product. If fields are empty after connecting, refresh this page or open the product docs again.
curl --request POST \
--url "https://cs-testv2.cyware.com/ctixapi/rest-auth/groups/?AccessID=%3Cyour%20access%20id%3E&Signature=%3Cyour%20signature%3E&Expires=%3Cyour%20expires%3E" \
--data '{
"name": "Test Group",
"permissions": [
{}
],
"is_active": true,
"description": "Test User Group"
}'View-only example — running live API calls requires a role with snippet testing access.
const url = "https://cs-testv2.cyware.com/ctixapi/rest-auth/groups/?AccessID=%3Cyour%20access%20id%3E&Signature=%3Cyour%20signature%3E&Expires=%3Cyour%20expires%3E";
const response = await fetch(url, {
method: "POST",
headers: {},
body: JSON.stringify({
"name": "Test Group",
"permissions": [
{}
],
"is_active": true,
"description": "Test User Group"
}),
});
const text = await response.text();
let data;
try { data = JSON.parse(text); } catch { data = text; }
console.log(response.status, data);View-only example — running live API calls requires a role with snippet testing access.
import requests
url = "https://cs-testv2.cyware.com/ctixapi/rest-auth/groups/"
params = {
"AccessID": "<your access id>",
"Signature": "<your signature>",
"Expires": "<your expires>"
}
headers = {}
payload = {
"name": "Test Group",
"permissions": [
{}
],
"is_active": true,
"description": "Test User Group"
}
response = requests.request("POST", url, params=params, headers=headers, json=payload)
print(response.status_code)
print(response.text)View-only example — running live API calls requires a role with snippet testing access.
{
"name": "Test Group",
"permissions": [
{}
],
"is_active": true,
"description": "Test User Group"
}View-only example — running live API calls requires a role with snippet testing access.
{
"details": "Successfully created"
}View-only example — running live API calls requires a role with snippet testing access.