ns_user

Overview

Add, delete, update, or get information about AOLserver users

Syntax

ns_user add ?-server servername? user fullname password groups data

ns_user data ?-server servername? user

ns_user delete ?-server servername? user

ns_user list ?-server servername?

ns_user exists ?-server servername? user

ns_user fullname ?-server servername? user

ns_user groups ?-server servername? user

ns_user password ?-server servername? user

ns_user permissions ?-server servername? user

ns_user update ?-server servername? user fullname password groups data

Description

ns_user add adds a user with the specified username (user), the specified fullname, and the specified password. The new user belongs to the specified list of groups. You can also store some arbitrary data along with the user information, which can be later retrieved with ns_user data. If no servername is specified, the current virtual server is used.

ns_user data returns the arbitrary data stored with the specified user's permission record. If no servername is specified, the current virtual server is used.

ns_user delete deletes the specified user. If no servername is specified, the current virtual server is used.

ns_user list returns a list of users. If no servername is specified, the current virtual server is used.

ns_user exists returns 1 (one) if the specified user exists and 0 (zero) if it does not. If no servername is specified, the current virtual server is used.

ns_user fullname returns the full name of the specified user. If no servername is specified, the current virtual server is used.

ns_user groups returns a list of the groups that the specified user belongs to. If no servername is specified, the current virtual server is used.

ns_user password returns the password of the specified user. If no servername is specified, the current virtual server is used.

ns_user permissions returns the permissions of the specified user as a set of {method URL} pairs. If no servername is specified, the current virtual server is used.

ns_user update updates the specified user. The values specified for fullname, password, and groups will replace the current values for the user. Note that all arguments must be specified. You can also update the arbitrary data stored along with the user information, which can be later retrieved with ns_user data. If no servername is specified, the current virtual server is used.

Note

This function normally updates the users disk file each time it is called. To perform large-scale loading of users, first call ns_perm syncoff to disable the file synchronization mechanism, then perform multiple calls to ns_user, and finally call ns_perm syncon to re-enable the file synchronization.

Top of Page
Copyright © 1996 America Online, Inc.