X-Git-Url: https://git.hcoop.net/hcoop/debian/courier-authlib.git/blobdiff_plain/4e60b389634568bcf4cc5009fa37bba3eb381482..940be80e3e40dbbbd84161e1e5ae3abf0b2eadf6:/auth_getuserinfo.html diff --git a/auth_getuserinfo.html b/auth_getuserinfo.html index faaa3c4..324cb68 100644 --- a/auth_getuserinfo.html +++ b/auth_getuserinfo.html @@ -1,15 +1,15 @@ -auth_getuserinfo

Name

auth_getuserinfo — Obtain account information

Synopsis


-#include <courierauth.h>
-

int rc=auth_getuserinfo(const char * userid,
 int  (*callback_func)(struct authinfo *, void *),
 void * callback_arg);

DESCRIPTION

+-->

Name

auth_getuserinfo — Obtain account information

Synopsis


+#include <courierauth.h>
+

int rc=auth_getuserinfo(const char * userid,
 int  (*callback_func)(struct authinfo *, void *),
 void * callback_arg);

DESCRIPTION

If userid is a valid account name, retrieve the account particulars and invoke -callback_func.

RETURNS

+callback_func.

RETURNS

callback_func will be invoked if userid exists, and callback_func's return value becomes @@ -25,7 +25,7 @@ return value indicates that this request was processed, but it failed The second argument to callback_func will be callback_arg, which is not interpreted by this function in any way. -The first argument will be a pointer to the following structure:

Example 1. struct authinfo

+The first argument will be a pointer to the following structure:
 
Example 1. struct authinfo
 struct authinfo {
 	const char *sysusername;
 	const uid_t *sysuserid;
@@ -42,7 +42,7 @@ struct authinfo {
 	const char *options;
 
 	} ;
-


+

Description of the above fields:

address

The authenticated login ID.

sysusername

The authenticated account's userid and groupid can be looked up in the @@ -78,7 +78,7 @@ The account's cleartext password, if available. If the account has an encrypted password defined, this field can be set to NULL.

options

A comma-separated list of miscellaneous account options. -See below for more information.

Account options

+See below for more information.

Account options

Depending on the configuration of the Courier authentication library, accounts may have individual options associated with them. If the authentication library configuration does not implement account @@ -122,15 +122,15 @@ account could possibly access (and that's on top of whatever else the access control lists say). See the virtual shared folder documentation for more information.

For technical reasons, group names may not include comma, tab, "/" or "|" -characters.

SEE ALSO

-authlib(3), +characters.

SEE ALSO

+authlib(3), -auth_generic(3), +auth_generic(3), -auth_login(3), +auth_login(3), -auth_enumerate(3), +auth_enumerate(3), -auth_passwd(3), +auth_passwd(3), -auth_getoption(3).

+auth_getoption(3).