minimusdocs
Help center

Users

Update a user

PATCH/auth/users/{id}/

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

Change some of an account's details, status or groups. Only a superuser makes or unmakes a superuser.

Path parameters

  • idstring (uuid)required

Body

  • usernamestring
  • 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[]

Response

200 OK

  • 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

Errors

  • 400 Something sent is not valid. Each field that is wrong is named with what is wrong.
  • 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