Administrative Calls

This section describes the Administrative Web service API calls that are available in SBM. These calls represent the Web service operations that are invoked from a client and performed on the SBM Application Engine Web Server. The calls receive one or more arguments from the client, perform an operation on the server, and return an XML response to the client when applicable.

The following table lists all supported calls in alphabetical order, followed by a brief description of each operation. Select a call to view detailed information including:

Description – A brief description of the call.
Arguments – A table that describes the simple and complex types for each argument. For each complex type, click the type name for a detailed description.
Response – A brief description of the call's response. For each response that is a complex type, click the response name for a detailed description.
Usage – Any notes, additional details, and considerations are addressed here.
Faults – Possible error messages are listed here.
XML – This section contains an example of the actual XML that is sent. The XML provides detailed examples of each element and shows you how to format the expected data.

List of Administrative Calls

Call	Description
CreateGroups	This service creates one or more new groups.
CreateProject	This service creates a new project.
CreateUsers	This service creates one or more new users.
DeleteProcessApp	This service deletes a specified process app.
GetGroupMembers	This services returns a list of users who are members of one or more specified groups.
GetGroups	This service returns one or more existing groups.
GetGroupPrivileges	This services returns a list of privileges for a specified group.
GetGroupRoles	This services returns a list of roles for a specified group.
GetRoleGroups	This services returns a list of groups that are granted a particular role in a specified project.
GetRoleUsers	This services returns a list of users that are granted a particular role in a specified project.
GetPrivilegeTypes	This services returns the list of available privilege types.
GetTypePrivileges	This services returns a list privileges by type.
GetUserRoles	This services returns a list of roles for a specified user.
GetUsers	This service returns one or more user records.
GetUserPrivileges	This services returns a list of privileges for a specified user.
HasUserRole	This service checks for a specified role by name.
GetVersion	This service returns the SBM version and build number.
HasGroupPrivilege	This service checks for a specified privilege by name.
HasGroupRole	This service checks for a specified role by name.
HasUserPrivilege	This service checks for a specified privilege by name.
IsUserValid	This service determines whether a specified user is valid or not.
Logout	This service releases any licenses and resources associated with the session.
SetGroupPrivileges	This services sets or revokes privileges for a specified group.
SetGroupRoles	This services sets or revokes roles for a specified group.
SetUserPrivileges	This services sets or revokes privileges for a specified user.
SetUserRoles	This services sets or revokes roles for a specified user.
UpdateGroups	This service updates one or more existing groups.
UpdateUsers	This service updates one or more existing users.