Comandos API de usuario

Advertencia de fin de funcionamiento

Este comando de API será eliminado y no va a funcionar en Noviembre 2 de 2021.

El módulo user de API administra usuarios de Shell y FTP.

El comando user-list_users también enumera los usuarios de correo.

Comandos

user-add_user

Agrega un usuario (de tipo ftp, sftp o shell). Si no especificas una contraseña, se genera una contraseña aleatoriamente y se muestra en el resultado. De lo contrario, el resultado muestra ******** para la contraseña. También se devuelve un token de servicio (consulta Comandos de control de servicio).

Comando user-add_user
Valores

type : El tipo de usuario; puede ser ftp, sftp, o shell.
username : El usuario deseado para el nuevo usuario.
gecos : EL Nombre Completo para este usuario, como John Smith (este campo no puede ir en blanco).
server : El home para el usuario (el servidor compartido o VPS). Esto es requerido.
shell_type : El tipo de shell para el usuario (bash, tcsh, ksh, o zsh). Solo es requerido si el tipo es shell.
password : (opcional) La contraseña para el nuevo usuario. Generado aleatoriamente si no se especifical
enhanced_security : (opcional) Configurado como 1 para habiliatar la Seguridad del Usuario Mejorada (Enhanced User Security. Ponlo en 0 o déjalo en blanco para deshabiliatarlo)

Resultado

success
username password token
testuser123 ******** gcnaBcD12eFgH34iJkL

Posibles errores

no_type
no_username
no_gecos
no_server
no_shell_type
invalid_type
invalid_shell_type
invalid_server
invalid_username (specific error after a tab)
user_exists
invalid_gecos (specific error after a tab)
invalid_password (specific error after a tab)

user-list_users

Vuelca una lista de todos los usuarios (incluidos ftp, shell, ftp anónimo, copias de seguridad y buzones de correo) en todas las cuentas a las que tienes acceso. Las contraseñas ya no están disponibles a través de este comando de API.

Comando user-list_users
Valores

(ninguno)

Resultado

success
account_id username type shell home password disk_used_mb quota_mb gecos
1 anftp ftp /etc/ftponly machine.dreamhost.com 0 671744 An FTP user
1 b1 backup /usr/bin/rssh backup.dreamhost.com 0 671744 Account #1 Backup User
1 blah shell /bin/bash machine.dreamhost.com 0 671744 Blah Shell
1 josh@blah.com mail /etc/poponly smaug.dreamhost.com 0 671744 Josh Email User!

Posibles errores

type : normalmente ftp, sftp, shell, mail, o backup

Posibles errores

(ninguno)

user-remove_user

Elimina un usuario especificado por el usuario. Opcionalmente, se puede especificar el tipo de usuario o home para distinguir el usuario que se eliminará (si el usuario existe en múltiples hogares/tipos). Para especificar el home, establece el usuario en username@home. Si el usuario tiene más de un tipo/home, puedes configurar remove_all para eliminar todas las instancias del usuario (nota: si remove_all está configurado y se especifica el tipo u home, elimina todas las instancias del usuario con ese tipo o en ese home).

Comand user-remove_user
Valores

username : el usuario a eliminar, como testuser42. Opcionalmente usa username@home para especificar un hogar, como testuser42@riga
type : (Opcional) el tipo de usuario, como ftp, shell, etc.
remove_all : (Opcional) Configuralo como 1 para eliminar todas las intancias de este usuario (si el usuario tiene múltiples tipos o está en multiples hogar).

Resultado

success

Posibles errores

invalid_user (specific error after tab).
multiple_user_services (error específico después de la pestaña, como que el usuario tiene más de un tipo/hogar y el tipo/home y remove_all no se establecieron)
cannot_remove_user (error específico después de la pestaña)

Ver también

¿Este artículo ha respondido sus preguntas?

Última actualización el PST.

¿Aún no encuentra lo que busca?