| |
OScript API/Built-in Package Index |
The built-in functions in the UAPI Package allow controlled access and manipulation of the user and group authorization database.
The major functionalities offered by UAPI are the following:
See also UAPISESSION.
Any user or group type.
Any external user or group type.
Search using the "Contains" operator.
Search using the "Endswith" operator.
Group type id for an external group
User type id for an external user.
Object factory group (excluded from rights).
Search by first name.
Group type.
Could not set the specified user's password expiration date.
Could not set the specified user's password expiration mode.
Search by last name.
Search by mailaddress.
Search by name.
Do a next/forward search.
Do a next/backward search.
Can perform Content Administration tasks.
Can connect to the document database.
Can log in.
Can access the document database without permission checking.
Has system permissions in the document database.
Has world permissions in the document database.
Has user and group administrator privileges.
Can create public groups.
Can connect to the user database.
Can create users.
Can access the workflow database without permission checking.
Can connect to the workflow database.
Proxy for DAPI.
No Proxy.
Proxy for WAPI.
Right ID representing access for All Users.
Disable right id
Right ID representing the system.
Right ID representing Public Access.
Search using the "SoundsLike" operator.
Search using the "Startswith" operator.
System type.
User type id for a System Group.
User type id for a System User.
User type.
Deprecated.
Adds a user or a group to a group by specifying their IDs.
Adds a user proxy.
Creates an extended attributes handle.
Returns a new UAPI session.
Determines whether or not users or groups can be added to the database.
Determines whether or not a particular user or group is modifiable in the given UAPISESSION.
Returns records of child members of the specified group.
Creates a new group in the database.
Creates a new identity in the database.
Creates a new identity type in the database.
Creates a new user in the database.
Deletes a group from the system.
Removes a user or group from the specified group.
Delete an identity from the database.
Delete an identity from the database by the identity ID.
Deletes the specified user from the system.
Deletes a user proxy.
Associates a UAPIUser with a user and retrieves any existing extended attribute data.
Adds user information columns to a RecArray containing a user ID column.
Adds user information columns to a RecArray containing a user ID column.
Adds user information columns to a RecArray containing a user ID column.
Explodes a list of ids into a complete membership.
Adds a new extended attribute data to the specified extended attribute handle.
Stores the specified extended attribute data to the database.
Returns a RecArray containing the information of the specified user or group.
Gets an identity from the database.
Gets an identity from the database by ID number.
Get the identity type ID for an identity type.
Get a list of all identity types.
Gets the user's user interface language.
Returns a RecArray containing detailed information of the specified user.
Gets the user's preferred metadata language.
Determines which users and groups the specified user or group leads.
Lists all users or groups of the specified type in the specified space.
Lists the proxies for the specified user.
Lists all groups (of a particular type) of which the specified user or group is a direct member.
Returns a RecArray containing information about the set of users and groups within the specified group in the specified space that match the specified search criteria.
Deletes a specified user preference keyword or all of the user preference keywords.
Retrieves a specified user preference's value for a given keyword.
Lists all the user preference keywords or a specified user preference keyword.
Updates the value for an existing user preference keyword or adds a new user preference keyword for the specified user.
Renames a user or group.
Returns a List of all groups of which the specified ID is a member (directly and indirectly).
Changes the leader of a group.
Changes the owner of a user or group.
Changes the password expiration date for a user.
Changes the password expiration mode for a user.
Modifies the value stored in the userData field of a user or a group.
Assigns a new base group to the specified user.
Sets the user's preferred metadata language.
Modifies the specified user's password.
Modifies the specified user's privileges.
Retrieves basic or extended information about all users in the specified space.
Any user or group type. Used as the searchType parameter to UAPI.PowerList() and as the typeMembership parameter to UAPI.MembershipListByID().
Any external user or group type. Used as the searchType parameter to UAPI.PowerList() and as the typeMembership parameter to UAPI.MembershipListByID().
Search using the "Contains" operator. Used as the searchOpr parameter to UAPI.PowerList().
Search using the "Endswith" operator. Used as the searchOpr parameter to UAPI.PowerList().
Group type id for an external group
User type id for an external user.
Object factory group (excluded from rights) type.
Search by first name. Used as the searchColumn parameter to UAPI.PowerList().
Group type.
Could not set the specified user's password expiration date.
Could not set the specified user's password expiration mode.
Search by last name. Used as the searchColumn parameter to UAPI.PowerList().
Search by mail address. Used as the searchColumn parameter to UAPI.PowerList().
Search by name. Used as the searchColumn parameter to UAPI.PowerList().
Do a next/forward search. Used as the action parameter to UAPI.PowerList().
Do a next/backward search. Used as the action parameter to UAPI.PowerList().
Can perform Content Administration tasks.
Can connect to the document database.
Can log in.
Can access the document database without permission checking.
Has system permissions in the document database.
Has world permissions in the document database.
Has user and group administrator privileges.
Can create public groups.
Can connect to the user database.
Can create users.
Can access the workflow database without permission checking
Can connect to the workflow database.
Proxy for DAPI.
No proxy.
Proxy for WAPI.
Right ID represent world.
Disable right id.
Right ID represent system.
Right ID represent world.
Search using the "SoundsLike" operator. Used as the searchOpr parameter to UAPI.PowerList().
Search using the "Startswith" operator. Used as the searchOpr parameter to UAPI.PowerList().
System type. Used as the targetType parameter to UAPI.PowerList().
User type id for a system group.
User type id for a system user.
User type.
This function assumes it operates in the standard space (with spaceID of 0).
Use UAPI.Create().
The UAPISession through which the group will be added.
The UAPI type.
The name of the new group to add.
An Integer user ID identifying the leader of the group.
Any additional value to store in the database as part of the user or group identity. If more than one value needs to be stored, specify a List.
The ID of the new group if successful, error otherwise.
This function assumes it operates in the standard space (with spaceID of 0).
Use UAPI.AddToByIDs().
The UAPISession through which the modification is made.
The UAPI type of the user or group being added.
The name of the existing user or group to add.
The UAPI type of the group to which the user or group specified by newType and newName will be added.
The name of the group to which the user or group specified by the newType and newName will be added.
The Integer 0 if successful, error otherwise.
Adds a user or a group to a group by specifying their IDs.
Both the child user or group being added and the parent group to which the user or group is being added must exist or the function will fail.
The UAPISession through which the modification is made.
The id of the user or group being added.
The id of the group to which the user or group specified by childID will be added.
The Integer 0 if successful, error otherwise.
This function assumes it operates in the standard space (with spaceID of 0).
Use UAPI.CreateUser().
The UAPISession through which the modification is made.
The name of the user to add to the database.
The password for the user account. If no password should be associated with the user, specify a null String.
The UAPI type of the base group to which the user will belong.
The name of the base group to which the user will belong.
One or more of the user privilege constants, joined by bitwise OR operators ( | ).
Any additional value to store in the database as part of the user's identity. If more than one value needs to be stored, specify a List.
The ID of the new user if successful, error otherwise.
Adds a user proxy.
The UAPISession through which the modification is made.
The id of the user.
The id of the proxy.
The proxy type.
The Integer 0 if successful, error otherwise.
Creates an extended handle.
UAPI.AllocEx(), UAPI.ExGetByID(),
UAPI.ExSet(), and UAPI.ExUpdate()
are used in conjunction to add, query, update, and modify extended attributes
as related to a user or a group. In general, use:
The UAPISession through which the extended attributes object will be allocated.
A UAPIUser providing an extended
attributes handle.
Creates a UAPI session.
Specifies a CAPILOGIN referring to the Livelink user's connection to a database.
If successful, a UAPISession associating a user with a database connection, otherwise UAPI.KUAF_BADPRIVS if the user associated with session does not have enough privileges to allocate UAPI session.
Determines whether or not users or groups can be added to the database through the specified UAPISession.
The UAPISession through which associated user's privileges will be determined.
The UAPI type (either UAPI.USER or UAPI.GROUP) for which addition privileges are checked.
The Integer 0 if successful and addition is permitted; error otherwise.
Determines whether or not a particular user or group can be modified through a given session. Note that a creator of groups is not necessarily able to edit the groups he/she created. A group is modifiable only if the user has enough privileges, unless he/she is either Admin or the group leader.
The UAPISession used to identify the user whose modification privileges will be determined.
A Record for a user or group, identifying a particular user or group for which modification privileges will be determined.
The Integer 0 if successful and alteration is permitted, error otherwise.
This function assumes it operates in the standard space (with spaceID of 0).
The UAPISession through which the information is retrieved.
The UAPI type of the group on which to operate.
The name of the group whose children will be listed.
A RecArray containing records of
users and groups if successful, error otherwise.
Returns records of child members of the specified group.
If the specified group has no children, an empty RecArray is returned. Each Record contains the following fields:
The UAPISession through which the information is retrieved.
The Integer UAPI ID of the group on which to operate.
A RecArray containing records of users and groups if successful, error otherwise.
Creates a new group in the database.
Group names are unique within a group type in a space.
The user specified by the UAPISession must have Add privileges (verify using UAPI.CheckAddPrivs()) to successfully execute this function.
The UAPISession through which the modification is made.
The group type.
The ID of a space.
The name of the new group to add.
An Integer user ID identifying the leader of the group.
Any additional value to store in the database as part of the user or group identity. If more than one value needs to be stored, specify a List.
The ID of the created group if successful, error otherwise.
Creates a new identity in the database.
An identity is an entity that can be used to identify the original creator of a document or other items uploaded to Content Server. It is not a Content Server user but can be associated with one as an alias if, for example, a Content Server user is also the original creator of a document. For example an identity could be an email address, a phone number, a login id, a guid etc.
The UAPISession through which the creation is made.
A string representing the identity.
The ID number of the type of identity.
A user friendly string for display.
An Integer user ID associated with this identity.
The ID of the created identity if successful, error otherwise
Object prgctx = $pSession UAPISESSION uSession = prgCtx.Usession().fSession // New identity Integer identityID = UAPI.CreateIdentity( uSession, "JSmith@gmail.com", 1, "John Smith", 2000 )
Creates a new identity type in the database.
An identity type represent the type of the identity e.g. "email", "phone number", "login name", etc
The UAPISession through which the creation is made.
A string representing the identity type.
An number representing the ID of the new type:
Object prgctx = $pSession UAPISESSION uSession = prgCtx.Usession().fSession dynamic ret = UAPI.CreateIdentityType( uSession, "email" ) echo(ret) Output: 38
Creates a new user in the database.
The user specified by the UAPISession must have modification privileges (verify using UAPI.CheckAlterPrivs()) to successfully execute this function.
The UAPISession through which the modification is made.
The name of the user to add to the database.
The password for the user account. If no password should be associated with the user, specify a null String.
The ID of the base group to which the user will belong.
The ID of the space to which the user will belong.
One or more of the user privilege constants, joined by bitwise OR operators ( | ).
Any additional value to store in the database as part of the user's identity. If more than one value needs to be stored, specify a List.
The ID of the created user if successful, error otherwise.
This function assumes it operates in the standard space (with spaceID of 0).
Use UAPI.DeleteByID().
The UAPISession through which the modification is made.
The Integer UAPI type of the group to delete.
The String name of the group to delete.
1 - remove from database, 0 - default, mark as deleted in database.
The Integer 0 if successful, error
otherwise.
Deletes a group from the system.
If the parameter remove is 0, the group is marked as deleted in the database (the group row is not deleted), otherwise the group is deleted from the database.
The following is performed upon a group deletion:
Default group cannot be deleted.
The user specified by the UAPISession must have modification privileges (verify using UAPI.CheckAlterPrivs()) to successfully execute this function.
The UAPISession through which the modification is made.
The ID of the group to delete.
1 - remove from database, 0 - default, mark as deleted in database.
The Integer 0 if successful, error
otherwise.
This function assumes it operates in the standard space (with spaceID of 0).
The UAPISession through which the modification is made.
The Integer UAPI type of the user or group being removed.
The String name of the existing user or group to remove.
The Integer UAPI type of the group from which the user or group specified by the delType and delName parameters will be removed.
The String name of the group from which the user or group specified by the delType and delName parameters will be removed.
The Integer 0 if successful, error otherwise.
Removes a user or group from the specified group.
Executing this function removes the user or group from the membership List of the specified group, but does not delete the user from the database.
A user cannot be removed from from his or her base group.
The user specified by the UAPISession must have modification privileges (verify using UAPI.CheckAlterPrivs()) to successfully execute this function.
The UAPISession through which the modification is made
The id of the user or group being removed.
The id of the group from which the user or group specified by childID will be removed.
The Integer 0 if successful, error otherwise.
Delete an identity from the database.
The UAPISession object.
A string representing the identity.
The ID number of the type of identity.
Returns true if deletion succeeded, otherwise false.
Object prgctx = $pSession UAPISESSION uSession = prgCtx.Usession().fSession dynamic ret = UAPI.DeleteIdentity( uSession, "JSmith@gmail.com", 1 ) echo(ret) Output: true
Delete an identity from the database.
The UAPISession object.
The ID number of the identity.
Returns true if deletion succeeded, otherwise false.
Object prgctx = $pSession UAPISESSION uSession = prgCtx.Usession().fSession dynamic ret = UAPI.DeleteIdentityByID( uSession, 59 ) echo(ret) Output: true
This function assumes it operates in the standard space (with spaceID of 0).
The UAPISession through which the modification is made.
The String name of the user to delete.
The Integer 0 if successful, error otherwise.
Deletes the specified user from the system.
When a user is deleted, the following is done:
The user specified by the UAPISession must have modification privileges (verify using UAPI.CheckAlterPrivs()) to successfully execute this function.
The UAPISession through which the modification is made.
The ID of the user to delete.
The Integer 0 if successful, error otherwise.
Deletes a user proxy.
The UAPISession through which the modification is made.
The id of the user.
The proxy type.
The Integer 0 if successful, error otherwise.
This function assumes it operates in the standard space (with spaceID of 0).
Use UAPI.ExGetByID().
Specifies a UAPIUser, as allocated by UAPI.AllocEx(), in which the extended attributes are stored.
The String name of the user whose extended attributes are retrieved.
A RecArray containing one Record,
in which the extended attributes for the specified user are stored. The
format of the Record will depend upon the structure of the user Record,
but will contain one field for each attribute.
If no extended attributes have been stored for the specified user, an empty
RecArray is returned. An Error will be returned if the function does
not complete successfully.
Associates an UAPIUser with a user and retrieves any existing extended attribute data.
The user specified by the UAPISession must have modification privileges (verify using UAPI.CheckAlterPrivs()) to successfully execute this function.
See UAPI.AllocEx() for a summary of various extended attributes functions.
Specifies a UAPIUser, as allocated by UAPI.AllocEx(), in which the extended attributes are stored.
The ID of the user whose extended attributes are retrieved.
A RecArray containing one Record,
in which the extended attributes for the specified user are stored. The
format of the Record will depend upon the structure of the user Record,
but will contain one field for each attribute.
If no extended attributes have been stored for the specified user, an empty
RecArray is returned. An Error will be returned if the function does
not complete successfully.
Adds user information columns to a RecArray containing a user ID column.
The function is intended to quickly provide additional user information when only the user ID is currently available. The columns have the following names and contain the following data:
In the table columnName is the name specified by the function's third parameter.
The UAPISession through which the modification is made.
The RecArray upon which to operate. It must contain a user ID column.
The String name of the column that contains the user IDs. The name specified will be used when naming the newly added columns.
The Integer 0 if successful, error otherwise.
Adds user information columns to a RecArray containing a user ID column.
For details regarding the output RecArray, refer to UAPI.Expand().
The UAPISession through which the modification is made.
The RecArray upon which to operate. It must contain a user ID column.
The String name of the column that contains the user IDs. The name specified will be used when naming the newly added columns.
The passed in RecArray with expanded columns if successful, error otherwise.
Adds user information columns to a RecArray containing a user ID column.
Refer to UAPI.Expand() for details on the expanded RecArray.
The UAPISession through which the modification is made.
The RecArray upon which to operate. It must contain one or more user ID columns.
A List of column names containing the user IDs.
The Integer 0 if successful, error otherwise.
Explodes a list of ids into a complete membership.
Returns a RecArray containing one record for each group and child member of the groups specified in the parameter explodeList.
For details regarding the output RecArray, refer to UAPI.ChildrenList().
The UAPISession through which the information is retrieved.
The datatype List containing the IDs of the groups to be exploded.
A RecArray containing one record for each user or group that is a child (member) of the groups specified in the parameter explodeList.
Adds a new extended attribute to the specified extended attribute handle.
See UAPI.AllocEx() for a summary of the various extended attributes functions.
Unlike the optional userData parameter on UAPI.Create(), extended attributes cannot simply be stored as part of a user Record without any preplanning.
To store extended attributes, the user database, specifically the kUAF table, must first be modified. The columns that will hold the extended attributes must be added to the kUAF table before using the extended attribute functions.
Specifies a UAPIUser, as allocated by UAPI.AllocEx(), in which the extended attributes are stored.
The String name of the attribute to be stored. It must be case-sensitively identical to a column name in the kUAF table. This will also be the name used as the column heading in the RecArray returned by UAPI.ExGetByID() when retrieving the extended attribute values.
Specifies the value to be stored, which can be of any data type.
The Integer 0 if successful, error otherwise.
Stores the specified extended attribute data to the database.
See UAPI.AllocEx() for a summary of the various extended attributes functions.
Specifies a UAPIUser, as allocated by UAPI.AllocEx(), in which the extended attributes are stored.
The Integer 0 if successful, error otherwise.
Specifies a UAPIUser, as returned by UAPI.AllocEx()
The Integer 0 if successful, error otherwise.
The UAPISession to terminate.
The Integer 0 if successful, error otherwise.
This function assumes it operates in the standard space (with spaceID of 0).
Use UAPI.GetByID().
The UAPISession through which the information is retrieved.
The UAPI type of the group or user for which information will be returned.
The name of the group or user for which information will be returned.
A RecArray containing only one record for the user or group if successful, error otherwise.
Returns a RecArray containing the information of the specified user or group.
For details regarding the output RecArray, refer to UAPI.ChildrenListByID().
The UAPISession through which the information is retrieved.
The user or group ID.
A RecArray containing only one record for the user or group if successful, error otherwise.
Get an identity from the database.
The UAPISession object.
A string representing the identity.
The ID number of the type of identity.
An assoc containing the following keys:
Identity - The string representing the identity IdentityID - An ID number for the identity IdentityTypeID - The identity type id of this identity UserID - The Content Server user ID, if any, associated with this identity. DisplayStr - The display string.
Object prgctx = $pSession
UAPISESSION uSession = prgCtx.Usession().fSession
dynamic ret = UAPI.GetIdentity( uSession, "JSmith@gmail.com", 1 )
echo(ret)
Output:
A<1,?,'DisplayStr'='John Smith','Identity'='JSmith@gmail.com','IdentityID'=59,'IdentityTypeID'=1,'UserID'=2000>
Get an identity from the database by ID number.
The UAPISession object.
An ID number representing the identity.
An assoc containing the following keys:
Identity - The string representing the identity IdentityID - An ID number for the identity IdentityTypeID - The identity type id of this identity UserID - The Content Server user ID, if any, associated with this identity. DisplayStr - The display string.
Object prgctx = $pSession
UAPISESSION uSession = prgCtx.Usession().fSession
dynamic ret = UAPI.GetIdentityByID( uSession, 59 )
echo(ret)
Output:
A<1,?,'DisplayStr'='John Smith','Identity'='JSmith@gmail.com','IdentityID'=59,'IdentityTypeID'=39,'UserID'=2000>
Get the identity type ID for an identity type.
The UAPISession object.
A string representing the identity type.
The ID number of the identity type
Object prgctx = $pSession UAPISESSION uSession = prgCtx.Usession().fSession dynamic ret = UAPI.GetIdentityTypeID( uSession, "email" ) echo(ret) Output: 39
Get a list of all identity types.
The UAPISession object.
A list of all identity types.
Object prgctx = $pSession UAPISESSION uSession = prgCtx.Usession().fSession dynamic ret = UAPI.GetIdentityTypes( uSession ) echo(ret) Output: V{<'Value'><'email'><'login name'><'guid'>}
Get the user's user interface language given their user ID.
The CAPIConnect through which the information is retrieved.
The ID of the user to get the information for.
A string representing the language code if successful, undefined if none specified, error otherwise.
This function assumes it operates in the standard space (with spaceID of 0).
Use UAPI.GetUserByID().
The UAPISession through which the information is retrieved.
The name of the user for which the information is retrieved.
A RecArray containing only one record for the specified user if successful, error otherwise.
Returns a RecArray containing detailed information of the specified user.
The one record in the RecArray return value contains the following fields:
The UAPISession through which the information is retrieved.
The UAPI ID of the user for which the information is retrieved.
A RecArray containing only one record for the specified user if successful, error otherwise.
Get the user's preferred metadata language.
The CAPILogin through which the information is retrieved.
A string representing the language code if successful, error otherwise.
Determines which users and groups the specified user or group leads.
If the user or group specified by the ID parameter is not a leader, an empty RecArray is returned.
For details regarding the output RecArray, refer to UAPI.ChildrenListByID().
The UAPISession through which the information is retrieved.
The ID of the user or group for which the leader List will be obtained.
A RecArray containing one record for each user or group for which the specified user or group is the leader.
Lists all users or groups of the specified type in the specified space.
If there are no members of the specified type in the system, an empty RecArray is returned.
For details regarding the output RecArray, refer to UAPI.ChildrenListByID().
The UAPISession through which the information is retrieved.
The UAPI type.
The id of the space. The default is 0 for standard user and group.
A RecArray containing records of users or groups if successful, error otherwise.
Lists the proxies for the specified user.
The UAPISession through which the information is retrieved.
The ID of the user.
A RecArray containing records of users or groups if successful, error otherwise.
This function assumes it operates in the standard space (with spaceID of 0).
Use UAPI.MembershipListByID().
The UAPISession through which the information is retrieved.
The UAPI type of the user or group.
The name of the user or group.
The UAPI type, for which membership information will be returned.
A RecArray containing one record for each group (of the specified type) of which the user or group is a member if successful, error otherwise.
Lists all groups (of a particular type) of which the specified user or group is a direct member.
If the user or group specified by the memberID parameter is not a member of any groups of the specified groupType, an empty RecArray is returned.
For details regarding the output RecArray, refer to UAPI.ChildrenListByID().
Note: UAPI.MembershipListByID() returns only those groups of which the user or group specified is a direct member—for example, if "Arnold Wilson" is the specified user, and he belongs to the "Programming" group which is in turn a member of the "Research" group, the "Research" group will not appear in Arnold Wilson's membership List.
The UAPISession through which the information is retrieved.
The ID of the user or group.
The type, for which membership information will be returned.
A RecArray containing one record for each group (of the specified type) of which the user or group is a member if successful, error otherwise.
Returns a RecArray containing information about the set of users and groups within the specified group in the specified space that match the specified search criteria.
It provides a powerful and flexible means for searching for users and/or groups with a high degree of control. If no records matched the specified query criteria, an empty RecArray is returned. For details regarding the output RecArray, refer to UAPI.ChildrenListByID().
The UAPISession through which the information is retrieved.
The type of group in which to search in; UAPI.SYSTEM to search in the entire system, or UAPI.GROUP to search only in the group specified by the groupID parameter.
The UAPI type to return; UAPI.USER to return users only, UAPI.GROUP to return groups only, or UAPI.ANY to return both users and groups.
The value which the parameter searchColumn will be compared against.
The direction in which to search in; UAPI.NEXT or UAPI.PREVIOUS.
The maximum number of records to return.
The column to compare; specify UAPI.NAME, UAPI.LASTNAME, UAPI.FIRSTNAME, or UAPI.MAILADDRESS.
The operator defining the type of comparison made; specify UAPI.STARTSWITH, UAPI.CONTAINS, UAPI.ENDSWITH, or UAPI.SOUNDSLIKE.
The user or group ID to begin the search. Specify 0 only if the parameter startValue is an empty string or the parameter searchColumn is not UAPI.NAME.
The value to begin the search. Specify an empty string only if the first set of records is to be returned.
The group ID to search in. It is unused if the parameter targetType is UAPI.SYSTEM.
The space ID to search in. The default is 0 for standard user or group.
A RecArray containing records of users and/or groups that satisfied the specified query criteria if successful, error otherwise.
Deletes a specified user preference keyword or all of the user preference keywords.
The UAPISession through which the modification is made.
User ID for whom the preferences is deleted.
If unspecified, deletes all preferences related to the user specified in the parameter ID. Otherwise, specify a string naming a keyword matching the particular preference to be deleted.
The Integer 0 if successful, error otherwise.
Retrieves a specified user preference value for a given keyword.
The UAPISession through which the information is retrieved.
User ID for whom a particular preference keyword is retrieved.
The String keyword of the preference to retrieve.
Optional. If specified, then this is the value to be returned if the specified user preference's keyword is not found, otherwise Undefined will be returned in such a case.
The specified keyword's stored value if successful, error otherwise.
Lists either all user preference keywords or the value of a specified user's preference keyword.
If no preference keyword was found for the user,
an empty RecArray is returned. The RecArray columns will be the following:
The UAPISession through which the information is retrieved.
User ID for whom the user preference keywords are listed.
Optional. If unspecified, lists all preferences related to the user specified in the parameter ID. Otherwise, specify a string keyword to list that preference's stored value for that keyword.
A RecArray containing one Record for each preferences keyword if successful, error otherwise
Updates the value for an existing user preference keyword or adds a new user preference keyword for the specified user. Returns an SQL error when updating an existing value with UNDEFINED.
The UAPISession through which the modification is made.
User ID for whom a particular preference keyword is to be updated.
The keyword of the preference to set/update.
The new stored value if specified, otherwise undefined.
The Integer 0 if successful, error otherwise.
This function assumes it operates in the standard space (with spaceID of 0).
Use UAPI.RenameByID().
The UAPISession through which the modification is made.
The UAPI type of the user or group to rename.
The name of the user or group to rename.
The new name for the user or group.
The Integer 0 if successful, error otherwise.
Renames a user or group.
The UAPISession through which the modification is made.
The ID of the user or group to rename.
The new name for the user or group.
The Integer 0 if successful, error otherwise.
This function assumes it operates in the standard space (with spaceID of 0).
The UAPISession through which the information is retrieved.
The UAPI type of the user or group for whom membership information is returned.
The name of the user or group for which membership information is returned.
The proxy type.
A RecArray containing one record for each group the user or group is a member of if successful, error otherwise.
Returns a List of all groups of which the specified ID is a member (directly and indirectly).
Unlike the UAPI.MembershipListByID function, the UAPI.RightsListByID function travels completely down the membership information tree and returns all groups (of all types) of which the specified user is a member both directly or indirectly (through membership in another group).
For details regarding the output RecArray, refer to UAPI.ChildrenListByID().
The UAPISession through which the information is retrieved.
The ID of the user or group for whom membership is returned.
The proxy type.
A RecArray containing one record for each group the user or group is a member of if successful, error otherwise.
This function assumes it operates in the standard space (with spaceID of 0).
Use UAPI.SetLeaderByID().
The UAPISession through which the modification is made.
The UAPI type of the group whose leader will be changed.
The name of the group whose leader will be changed.
The user or group ID of the new leader.
The Integer 0 if successful, error otherwise.
Changes the leader of a group.
The user specified by the UAPISession must have Alter privileges (verify using UAPI.CheckAlterPrivs()) to successfully execute this function.
The UAPISession through which the modification is made.
The ID of the group whose leader will be changed.
The user or group ID of the new leader.
The Integer 0 if successful, error otherwise.
This function assumes it operates in the standard space (with spaceID of 0).
Use UAPI.SetOwnerByID().
The UAPISession through which the modification is made.
The UAPI type of the user or group whose owner will be changed.
The name of the user or group whose owner will be changed.
The user or group ID of the new owner.
The Integer 0 if successful, error otherwise.
Changes the owner of a user or group.
The user specified by the UAPISession must have Alter privileges (verify using UAPI.CheckAlterPrivs()) to successfully execute this function.
The UAPISession through which the modification is made.
The ID the user or group whose owner will be changed.
The user or group ID of the new owner.
The Integer 0 if successful, error otherwise.
Changes the password expiration date for a user.
The UAPISession through which the modification is made.
The ID the user.
The new password expiration date.
The Integer 0 if successful, error otherwise.
Changes the password expiration mode for a user.
The UAPISession through which the modification is made.
The ID the user.
The expiration mode.
The Integer 0 if successful, error otherwise.
This function assumes it operates in the standard space (with spaceID of 0).
The UAPISession through which the modification is made.
The UAPI type of the user or group whose userData will be changed.
The name of the user or group whose userData will be changed.
The new value to store as the userData (for user type and name specifications). To store more than one value, specify a List.
The Integer 0 if successful, error otherwise.
Modifies the value stored in the userData field of a user or a group.
The user specified by the UAPISession must have Alter privileges (verify using UAPI.CheckAlterPrivs()) to successfully execute this function.
The UAPISession through which the modification is made.
The ID of the user or group whose userData will be changed.
The new value to store as the userData (for user type and name specifications). To store more than one value, specify a List.
The Integer 0 if successful, error otherwise.
This function assumes it operates in the standard space (with spaceID of 0).
Use UAPI.SetUserDefaultGroupByIDs().
The UAPISession through which the modification is made.
The name of the user whose default group will be changed.
The UAPI type of the new default group.
The name of the new default group.
The Integer 0 if successful, error otherwise.
Assigns a new base group to the specified user.
The user specified by the UAPISession must have Alter privileges (verify using UAPI.CheckAlterPrivs()) to successfully execute this function.
The UAPISession through which the modification is made.
The ID of the user.
The ID of the new base group for this user.
The Integer 0 if successful, error otherwise.
Set the user's preferred metadata language.
The CAPILogin with which the information is associated.
The language code representing the user's preferred metadata language.
The Integer 0 if successful, error otherwise.
This function assumes it operates in the standard space (with spaceID of 0).
Use UAPI.SetUserPasswordByID().
The UAPISession through which the modification is made.
The name of the user whose password will be modified.
The user's current password. Must be either a String or Undefined. If specified, then the current password must pass verification before the new password is assigned.
The new password to assign.
The Integer 0 if successful, error otherwise.
Modifies the specified user's password.
The user specified by the UAPISession must have Alter privileges (verify using the UAPI.CheckAlterPrivs function) to successfully execute this function.
The UAPISession through which the modification is made.
The ID of the user whose password will be modified.
The user's current password. Must be either a String or Undefined. If specified, then the current password must pass verification before the new password is assigned.
The new password to assign.
The Integer 0 if successful, error otherwise.
This function assumes it operates in the standard space (with spaceID of 0).
Use UAPI.SetUserPrivilegesByID().
The UAPISession through which the modification is made.
The name of the user whose privileges will be modified.
Specifies one or more user privilege constants, combined using bitwise OR ( | ) operators.
The Integer 0 if successful, error otherwise.
Modifies the specified user's privileges.
The user specified by the UAPISession must have Alter privileges (verify using UAPI.CheckAlterPrivs()) to successfully execute this function.
The UAPISession through which the modification is made.
The ID of the user whose privileges will be modified.
Specifies one or more user privilege constants, combined using bitwise OR ( | ) operators.
The Integer 0 if successful, error otherwise.
Retrieves basic or extended information about all users in the specified space.
If the parameter brevity is 0, to retrieve extended information, the structure of the output RecArray will be that described in UAPI.GetUserByID().
If the parameter brevity is 1, to retrieves basic
information, the RecArray will have the following format:
The UAPISession through which the information is retrieved.
The id of the space. The default is 0 for standard users.
The default is 0 for extended information, or 1 for basic information.
A RecArray containing records of users if successful, error otherwise.
| Copyright © 2022 OpenText Corporation. All rights reserved. |