| Tag Summary |
| getGroups |
Returns all groups sorted by group name. A group name is case-insensitive.
The caller must have administrator privileges.
|
| getRole |
Returns the specified role. The caller must have administrator privileges.
|
| getGroupLockHolder |
Returns the username of the user who has a lock on the specified group.
Returns nothing if the specified group is unlocked or does not exist. The
caller must have administrator privileges.
|
| getRoleLockHolder |
Returns the username of the user who has a lock on the specified role.
Returns nothing if the specified role is unlocked or does not exist. The
caller must have administrator privileges.
|
| getRoles |
Returns all roles sorted by role name. A role name is case-insensitive.
The caller must have administrator privileges.
|
| getUser |
Returns the specified user. The caller must have administrator privileges.
|
| getUserLockHolder |
Returns the username of the user who has a lock on the specified user.
Returns nothing if the specified user is unlocked or does not exist. The
caller must have administrator privileges.
|
| getUsers |
Returns all users that match the specified pattern, sorted by username. A
username is case-insensitive. The caller must have administrator
privileges.
The wildcard characters "*" and "?" may be used. The "*" symbol matches
zero or more characters of any kind, and the "?" symbol matches exactly
one character of any kind. To use "*" or "?" literally, escape using the
"\" escape character. To use the escape character literally, use the
escape character twice ("\\").
|
| getUsersByGroup |
Returns all users in the specified group, sorted by username. A username
is case-insensitive. The caller must have administrator privileges.
|
| isGroupLocked |
Indicates whether the specified group is locked by some user. The caller
must have administrator privileges.
|
| isRoleLocked |
Indicates whether the specified role is locked by some user. The caller
must have administrator privileges.
|
| isUserLocked |
Indicates whether the specified user is locked by some user. The caller
must have administrator privileges.
|
| lockGroup |
Locks the specified group for editing, if it is not already locked by
another user. The caller must have administrator privileges.
At most one group lock can be held at a time by any one user.
This lock is released explicitly by using the unlockGroup tag. This lock
is also released implicitly by using the putGroup tag using the locked
role.
A granted lock may timeout after ten minutes. Once ten minutes have passed
since a lock was acquired, a lock is not actually released until another
user requests it, at which time the lock is timed out automatically.
|
| lockRole |
Locks the specified role for editing, if it is not already locked by
another user. The caller must have administrator privileges.
At most one role lock can be held at a time by any one user.
This lock is released explicitly by using the unlockRole tag. This lock is
also released implicitly by using the putRole tag with the locked role.
A granted lock may timeout after ten minutes. Once ten minutes have passed
since a lock was acquired, a lock is not actually released until another
user requests it, at which time the lock is timed out automatically.
|
| lockUser |
Locks the specified user, if it is not already locked by another user with
administrator privileges. The caller must have administrator privileges.
At most one user lock can be held at a time by any one user.
This lock is released explicitly by using the unlockUser tag. This lock is
also released implicitly by using the putUser tag with the locked user.
A granted lock may timeout after ten minutes. Once ten minutes have passed
since a lock was acquired, a lock is not actually released until another
user requests it, at which time the lock is timed out automatically.
|
| putGroup |
Adds or updates a group in the Flux engine. The caller must have
administrator privileges. Any lock held on the specified group is released
automatically.
|
| putRole |
Adds or updates a role in the specified group. The caller must have
administrator privileges. Any lock held on the specified role is released
automatically.
|
| putUser |
Adds or updates a user in the Flux engine. The group of an existing user
cannot be changed. The caller must have administrator privileges, unless
the caller is modifying its own user object, in which case any user
property may be updated except the username. Any lock held on the
specified user is released automatically.
|
| removeGroup |
Deletes the specified group from the Flux engine. Any users or roles in
the deleted groups are automatically deleted as well. If the group
contains any flow charts, the group cannot be deleted. The caller must
have administrator privileges. Returns whether the specified group was
deleted.
|
| removeRole |
Deletes the specified role from the specified group. If the role is
referenced in a business process trigger, the role cannot be deleted. The
caller must have administrator privileges. Returns whether the specified
role was deleted.
|
| removeUser |
Deletes the specified user from the Flux engine. If the user is referenced
in a business process trigger, a run-as-user flow chart property, or a
run-as-user runtime configuration property, the user cannot be deleted.
The caller must have administrator privileges. Returns whether the
specified user was deleted.
|
| renameGroup |
Renames an existing group. All flow charts under the existing group remain
under the same group after it is renamed. The caller must have
administrator privileges. Returns true if the group was renamed
successfully.
|
| renameRole |
Renames an existing role within an existing group. All business process
triggers that reference the old role name are updated to reference the new
role name. The caller must have administrator privileges. Returns true
if the role was renamed successfully.
|
| sizeGroups |
Returns the number of groups in the Flux engine. The caller must have
administrator privileges.
|
| sizeUsers |
Returns the number of users in the Flux engine. The caller must have
administrator privileges.
|
| unlockGroup |
Removes the group lock held by the current user. The caller must have
administrator privileges.
|
| unlockRole |
Removes the role lock held by the current user. The caller must have
administrator privileges.
|
| unlockUser |
Removes the specified user lock. If an administrator holds a lock on the
specified user, it cannot be unlocked. The caller must have administrator
privileges.
|