LegatoUserServiceService
The user services is used to perform actions on the data associated with a user.
Endpoint Metadata
- Namespace: http://api.legatoppm.com/
- WSDL: api.wsdl
- Mount Point: /soap/LegatoUserServiceService
The following methods are available on this endpoint:
- createUserProfile
- deleteUser
- enableUser
- getAllDisabledUserNames
- getAllEnabledUserProfiles
- getAllUserProfiles
- getManagerUserProfiles
- getOwnerUserProfiles
- getRequestorUserProfiles
- getSponsorUserProfiles
- getSubmittedToUserProfiles
- getTaskOwnerUserProfiles
- getUserProfile
- getUserRoles
- updateUserProfile
- updateUserRoles
createUserProfile
Creates a user profile.
Input Parameters
| name | description |
|---|---|
| userProfile | The user profile to be created. |
Return Value
The created user profile.
Faults
| name | description |
|---|---|
| PermissionDeniedException | If you don't have permission. |
| SystemException | (no documentation provided) |
deleteUser
Deletes a user.
Input Parameters
| name | description |
|---|---|
| userName | The user to be deleted. |
Return Value
Whether the user was successfully deleted.
Faults
| name | description |
|---|---|
| DataNotFoundException | If the user doesn't exist. |
| PermissionDeniedException | If you don't have permission. |
| SystemException | If there is a system error. |
enableUser
To enable/disable a user.
Input Parameters
| name | description |
|---|---|
| userName | The user to be enabled/disabled. |
| enable | True to enable the user, False otherwise. |
Return Value
True if successful.
Faults
| name | description |
|---|---|
| DataNotFoundException | If the user doesn't exist. |
| PermissionDeniedException | If you don't have permission. |
| SystemException | If there is a system error. |
getAllDisabledUserNames
Gets all disabled user names'.
Return Value
All disabled user names'.
Faults
| name | description |
|---|---|
| PermissionDeniedException | If you don't have permission. |
getAllEnabledUserProfiles
Gets all enabled user profiles.
Return Value
All enabled user profiles.
Faults
| name | description |
|---|---|
| DataNotFoundException | If the user doesn't exist. |
| PermissionDeniedException | If you don't have permission. |
getAllUserProfiles
Gets all user profiles including disabled users.
Return Value
All user profiles including disabled users.
Faults
| name | description |
|---|---|
| DataNotFoundException | If the user doesn't exist. |
| PermissionDeniedException | If you don't have permission. |
getManagerUserProfiles
Gets manager user profiles.
Return Value
The manager user profiles.
Faults
| name | description |
|---|---|
| DataNotFoundException | If the user doesn't exist. |
| PermissionDeniedException | If you don't have permission. |
getOwnerUserProfiles
Gets owner user profiles.
Return Value
The owner user profiles.
Faults
| name | description |
|---|---|
| DataNotFoundException | If the user doesn't exist. |
| PermissionDeniedException | If you don't have permission. |
getRequestorUserProfiles
Gets requestor user profiles.
Return Value
The requestor user profiles.
Faults
| name | description |
|---|---|
| DataNotFoundException | If the user doesn't exist. |
| PermissionDeniedException | If you don't have permission. |
getSponsorUserProfiles
Gets sponsor user profiles.
Return Value
The sponsor user profiles.
Faults
| name | description |
|---|---|
| DataNotFoundException | If the user doesn't exist. |
| PermissionDeniedException | If you don't have permission. |
getSubmittedToUserProfiles
Gets submitted to user profiles.
Return Value
The submitted to user profiles.
Faults
| name | description |
|---|---|
| DataNotFoundException | If the user doesn't exist. |
| PermissionDeniedException | If you don't have permission. |
getTaskOwnerUserProfiles
Gets permitted task owner user profiles.
Return Value
The task owner user profiles.
Faults
| name | description |
|---|---|
| DataNotFoundException | If the user doesn't exist. |
| PermissionDeniedException | If you don't have permission. |
getUserProfile
Gets a user profile.
Input Parameters
| name | description |
|---|---|
| userName | The username of the user profile. |
Return Value
The user profile.
Faults
| name | description |
|---|---|
| DataNotFoundException | If the user doesn't exist. |
| PermissionDeniedException | If you don't have permission. |
getUserRoles
Gets a list of roles for the user.
Input Parameters
| name | description |
|---|---|
| userName | The user to be queried. |
Return Value
List of roles.
Faults
| name | description |
|---|---|
| DataNotFoundException | If the user doesn't exist. |
| PermissionDeniedException | If you don't have permission. |
updateUserProfile
Updates a user profile.
Input Parameters
| name | description |
|---|---|
| userProfile | The user profile to be updated. |
Return Value
The updated user profile.
Faults
| name | description |
|---|---|
| DataNotFoundException | If the user doesn't exist. |
| PermissionDeniedException | If you don't have permission. |
updateUserRoles
Input Parameters
| name | description |
|---|---|
| userName | (no documentation provided) |
| roleIds | (no documentation provided) |
Return Value
(no documentation provided)
Faults
| name | description |
|---|---|
| DataNotFoundException | (no documentation provided) |
| PermissionDeniedException | (no documentation provided) |