minimusdocs
Help center

Groups and permissions

Set a group's permissions

POST/auth/groups/{group_id}/permissions/

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

Replace a group's permissions with these, by codename (e.g. add_stream). A reseller gives only permissions they hold.

Path parameters

  • group_idintegerrequired

Body

  • permission_codenamesstring[]required

Response

200 OK

  • messagestringrequired
  • groupobjectrequired

    A group: its permissions, members, the group above it, and the rules for its resellers (trial lines and refunds).

    • idintegerrequiredread-only
    • namestringrequired
    • permissionsinteger[]
    • permissions_displaystring[]requiredread-only
    • permissions_countintegerrequiredread-only

      Get count of permissions in this group

    • usersobject[]requiredread-only
      • idstring (uuid)requiredread-only
      • usernamestringrequiredread-only
      • emailstring (email)requiredread-onlycan be null
      • first_namestringrequiredread-only
      • last_namestringrequiredread-only
      • is_staffbooleanrequiredread-only

        Designates whether the user can log into this admin site.

      • is_activebooleanrequiredread-only
      • groupsinteger[]requiredread-only
    • users_countintegerrequiredread-only

      Get count of users in this group

    • parentintegerrequiredread-onlycan be null
    • parent_namestringrequiredread-onlycan be null
    • created_by_usernamestringrequiredread-onlycan be null
    • created_atstring (date-time)requiredread-only
    • is_resellerbooleanrequiredread-only
    • can_customize_packagesbooleanrequiredread-only
    • can_customize_bouquetsbooleanrequiredread-only
    • trials_limitintegerrequiredread-only
    • trials_periodstringrequiredread-only

      Default: "day"

    • trials_min_balancestring (decimal)requiredread-only
    • refund_window_hoursintegerrequiredread-only

      Default: 0

  • assigned_permissionsstring[]required
  • not_assignedstring[]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