| |
Options |
Name |
Purpose |
|
|
|
FindUserRecordForRead (character, buffer)
|
/* Helper method for finding a _User record for READ
@param character The User@Domain user name/id
@param buffer The _User buffer to use */
|
|
|
|
FindUserRecordForUpdate (character, buffer)
|
/* Helper method for finding a _User record for UPDATE
@param character The User@Domain user name/id
@param buffer The _User buffer to use */
|
|
|
|
CHARACTER GetAttribute (character, character)
|
/* Retrieves a value for the a requested attribute, per user
@param character A unique userid
@param character The name of the attribute for which to return a value
return character An attribute value for the given user. May be empty or unknown. */
|
|
|
|
CHARACTER GetAttributeNames (character)
|
/* Returns an array of attributes for a given user.
In the _USER case all users are equal.
@param character A unique userid
@return character[] An array of attribute names. */
|
|
|
|
Initialize ()
|
/* Loads configuration for this provider */
|
|
|
|
LOGICAL SetAttribute (character, character, character)
|
/* Sets an attribute's value for a user. May optionally create an attribute value.
@param character A unique userid
@param character The name of the attribute to remove
@param character The value to apply
@return logical TRUE if the attribute value was successfully set; FALSE otherwise */
|
|
|
|
CHARACTER SplitUserId (character)
|
/* Splits a user@domain string into its component parts.
A user name may be one of the following forms
i) user (blank domain)
ii) user@oedomaim (oe domain)
iii) user@email@oedomain (email address + domain)
@param character A user@domain string to split
@return character[2] 1=userid (not empty/null). May contain the @email portion;
2=domain (not null) */
|
|
|
|
CHARACTER Stringify (character)
|
/* Stringifies an attribute value for return to the caller.
No validation typically done on the input.
@param character The value to format
@return character An appropriately-formatted character value */
|
|
|
|
CHARACTER Stringify (datetime-tz)
|
/* Stringifies an attribute value for return to the caller.
No validation typically done on the input.
@param datetime-tz The value to format
@return character An appropriately-formatted character value */
|
|
|
|
CHARACTER Stringify (decimal)
|
/* Stringifies an attribute value for return to the caller.
No validation typically done on the input.
@param decimal The value to format
@return character An appropriately-formatted character value */
|
|
|
|
CHARACTER Stringify (integer)
|
/* Stringifies an attribute value for return to the caller.
No validation typically done on the input.
@param integer The value to format
@return character An appropriately-formatted character value */
|
|
|
|
CHARACTER Stringify (logical)
|
/* Stringifies an attribute value for return to the caller.
No validation typically done on the input.
@param logical The value to format
@return character An appropriately-formatted character value */
|
|
|
|
CHARACTER Stringify (longchar)
|
/* Stringifies an attribute value for return to the caller.
No validation typically done on the input.
@param longchar The value to format
@return character An appropriately-formatted character value */
|
|
|
|
LOGICAL ValidatePassword (character, character)
|
/* Simple, clear-text password validation for a user
@param character A unique userid
@param character The user's (cleartext) password to verify
@return logical TRUE if the provide credentials match the realm's values */
|
|
|
|
LOGICAL ValidatePassword (character, character, character, character)
|
/* Digest-encoded password validation for a user
@param character A unique userid
@param character The hashed digest of the password to verify
@param character The nonce value used to create the digest hash
@param character The timestamp value used to create the digest hash
@return logical TRUE if the provide credentials match the realm's values */
|
|
|
|
CHARACTER ValidateUser (character)
|
/* Validates that the username is in the realm, and returns a unique identifier for
the user (which may be the username@domain).
@param character The client-supplied username
@return character A unique identifier for the user */
|