M.5. User Source Plug-ins

See Section 4.11.1.3, “Custom”.

Tip

A sample CLI program custom-auth-sync-sample.sh with both plug-in interfaces combined is found in /opt/savapage/server/examples/ext/ .

M.5.1. User Synchronization Plug-in

Argumentsstdout

--list-users

List of all users. Each user is separated by \n. User details must be supplied in the correct order separated by \t like this:

UserName\tFullName\tEmail\tCardNumber\tIDNumber\n

UserName identifies the user and is mandatory. Other fields can be void with respect to the mandatory \t field separator. Note: Email is the Primary email.

--list-groups

List of all groups. Each group is separated by \n. Group details must be supplied in the correct order separated by \t like this:

GroupName\tFullName\n

GroupName identifies the group and is mandatory. FullName can be void with respect to the mandatory \t field separator.

--get-user-details [UserName]

UserName details separated by \t as in --list-users.

--get-group-details [GroupName]

GroupName details separated by \t as in --list-groups.

--list-group-members [GroupName]

List of users as in --list-users that are member of GroupName.

--is-group-present [GroupName]

Y if GroupName is present, N if not.

--is-user-in-group [GroupName] [UserName]

Y if UserName is a member of GroupName, N if not.

--rfid-format

The Card Number Format as LSB|MSB and HEX|DEC. For example:

LSB\tHEX\n

Table M.4. User Synchronization Plug-in CLI


M.5.2. User Authentication Plug-in

stdinstdout

UserName\nPassword\n

OK if authentication succeeded, ERROR if not.

Table M.5. User Authentication Plug-in CLI