Set a user's groups

POST/auth/users/{user_id}/groups/

manage Delete and money: deletes, credits, servers or panel settings. Scopes

Put an account in these groups instead of its current ones. A reseller sets only groups they manage, on accounts below them; the account's other groups are kept.

Path parameters

user_idstring (uuid)required

Body

group_idsinteger[]required

Response

200 OK

messagestringrequired
userobjectrequired
An account: its details, status, groups, permissions and credits.
- idstring (uuid)requiredread-only
- usernamestringrequired
- emailstring (email)can be null
- first_namestring
- last_namestring
- phone_numberstringcan be null
- phone_country_codestringcan be null
- is_staffboolean
  Designates whether the user can log into this admin site.
- is_superuserboolean
  Designates that this user has all permissions without explicitly assigning them.
- is_activeboolean
- groupsinteger[]
- groups_displaystring[]requiredread-only
- can_customize_packagesbooleanrequiredread-only
- can_customize_bouquetsbooleanrequiredread-only
- administers_panelbooleanrequiredread-only
- permissionsstring[]requiredread-only
  Every permission it holds, as app.codename (for example streams.add_stream).
- credit_balancestringrequiredread-onlycan be null
- credits_unlimitedbooleanrequiredread-only
- created_atstring (date-time)requiredread-only
- updated_atstring (date-time)requiredread-only
groupsstring[]required

Errors

400
401 No credential, or one that is wrong, expired or revoked.
403 The account, or the key's or app's scopes, may not do this.
404 Nothing with this id, or nothing the account can see.
429 Slow down: wait the seconds in the Retry-After header, then try again.

What each error means

cURL

curl -X POST 'https://panel.example.com/auth/users/1/groups/' \
  -H "Authorization: Bearer $MINIMUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "group_ids": [
    1,
    2,
    3
  ]
}'

Python

import os
import requests

response = requests.post(
    "https://panel.example.com/auth/users/1/groups/",
    headers={"Authorization": f"Bearer {os.environ['MINIMUS_API_KEY']}"},
    json={
        "group_ids": [
            1,
            2,
            3
        ]
    },
)
response.raise_for_status()
print(response.json())

JavaScript

const response = await fetch('https://panel.example.com/auth/users/1/groups/', {
  method: 'POST',
  headers: { Authorization: `Bearer ${process.env.MINIMUS_API_KEY}`, 'Content-Type': 'application/json' },
  body: JSON.stringify({
    "group_ids": [
      1,
      2,
      3
    ]
  }),
});
if (!response.ok) throw new Error(`${response.status}`);
console.log(await response.json());

Response 200

{
  "message": "Assigned user john to 2 groups",
  "user": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "username": "john"
  },
  "groups": [
    "Reseller",
    "Super Reseller"
  ]
}

Set a user's groups

Path parameters#

Body#

Response#

200 OK

Errors#

Path parameters

Body

Response

Errors