Ir al contenido

user

El dominio user tiene 6 acciones. En la superficie meta se alcanzan todas a través de arcane_user; en la individual, cada una es una herramienta propia; en la dinámica se ejecutan con arcane_execute_action y el ID canónico.

AcciónTítuloTipo
user.avatarGet user avatarlectura
user.createCreate a userescritura
user.deleteDelete a userdestructiva
user.getGet a userlectura
user.listList userslectura
user.updateUpdate a userescritura

Get user avatar

Get the custom profile picture for a user

  • Tipo: lectura
  • Parámetros obligatorios: userId
  • Meta-herramienta: arcane_user con "action": "avatar"
  • Herramienta individual: arcane_user_avatar
  • Ruta de Arcane: GET /api/users/{userId}/avatar
  • ID de operación: getUserAvatar
  • Uso: Downloads a user’s custom profile picture by userId (from user.list). The route is public, and the result gives contentType and bytes with the image as an embedded resource. Returns 404 when the user has no custom avatar (avatarUrl is empty in user.get): fall back to app_image.get_default_profile. Users set or remove their own with auth.avatar_upload and auth.avatar_delete.
  • Acciones relacionadas: user.get, app_image.get_default_profile, auth.avatar_upload, auth.avatar_delete

Create a user

Create a new user account

  • Tipo: escritura
  • Parámetros obligatorios: password, username
  • Meta-herramienta: arcane_user con "action": "create"
  • Herramienta individual: arcane_user_create
  • Ruta de Arcane: POST /api/users
  • ID de operación: createUser
  • Uso: Creates a local account (needs users:create): username (no @, must be unique, 409 if taken) and password (at least 8 characters and checked against the authPasswordPolicy setting) are required, and displayName, email, locale and timeFormat (auto, 12h, 24h) are optional. The account starts without any role and can do almost nothing until a global admin assigns one with role.user_assignments_set (role IDs from role.list). The result’s id is the userId for that call.
  • Acciones relacionadas: role.list, role.user_assignments_set, user.get

Delete a user

Delete a user by ID

  • Tipo: destructiva — exige confirm: true
  • Parámetros obligatorios: userId
  • Meta-herramienta: arcane_user con "action": "delete"
  • Herramienta individual: arcane_user_delete
  • Ruta de Arcane: DELETE /api/users/{userId}
  • ID de operación: deleteUser
  • Uso: Permanently deletes the account by userId (from user.list, needs users:delete). Refused with 409 for the last global admin (canDelete=false in user.get) and with 403 when a caller who is not a global admin targets a global admin. The user’s cached tokens are invalidated.
  • Acciones relacionadas: user.list, user.get, role.user_assignments_set

Get a user

Get a user by ID

  • Tipo: lectura
  • Parámetros obligatorios: userId
  • Meta-herramienta: arcane_user con "action": "get"
  • Herramienta individual: arcane_user_get
  • Ruta de Arcane: GET /api/users/{userId}
  • ID de operación: getUser
  • Uso: One user by userId (from user.list), with roleAssignments (roleId, environmentId, source), the resolved permissionsByEnv map, isGlobalAdmin and canDelete (false for the only global admin). Needs users:read and returns 404 for an unknown ID. For yourself use auth.me, which needs only a login.
  • Acciones relacionadas: user.list, auth.me, role.user_assignments_get, user.update

List users

Get a paginated list of all users

  • Tipo: lectura
  • Parámetros obligatorios: ninguno
  • Meta-herramienta: arcane_user con "action": "list"
  • Herramienta individual: arcane_user_list
  • Ruta de Arcane: GET /api/users
  • ID de operación: listUsers
  • Uso: Paginated Arcane user accounts (needs users:list, service accounts are excluded). Search matches username, email or display name, with start/limit/sort/order paging. Each item carries the id that user.get, user.update, user.delete and role.user_assignments_set take as userId, plus isGlobalAdmin, roleAssignments and canDelete. For the account behind this server’s own credential use auth.me.
  • Acciones relacionadas: user.get, user.create, auth.me, role.user_assignments_get

Update a user

Update an existing user’s information

  • Tipo: escritura
  • Parámetros obligatorios: userId
  • Meta-herramienta: arcane_user con "action": "update"
  • Herramienta individual: arcane_user_update
  • Ruta de Arcane: PUT /api/users/{userId}
  • ID de operación: updateUser
  • Uso: Admin edit of any user by userId (from user.list, needs users:update): only the fields you pass change among displayName, email, username, locale and timeFormat. An empty email is ignored rather than cleared. password resets it per authPasswordPolicy and clears requiresPasswordChange. Callers who are not global admins cannot set another user’s password or edit a global admin (403). Roles change through role.user_assignments_set, your own profile through auth.profile_update and your own password through auth.change_password.
  • Acciones relacionadas: user.get, role.user_assignments_set, auth.profile_update, auth.change_password