UserProfileService

Class provides API for getting information about user from SSO server

Endpoint Metadata

  • Namespace: http://opencase.extend.com/webservices/userProfile
  • Endpoint Name: UserProfileWebService
  • Endpoint Address: http(s)://{VMS URL}/opencase/webservices/userProfile-service

The following methods are available on this endpoint:

getActiveUsersContainingProducerTaskPermissions

Gets the list of all the Active Users which have any of the specified producer task PermissionTargets

Input Parameters

name type description
permissionTargets list the list of permission targets, for example the "Producer > Tasks" page on the UI could be an element of permissionTargets

Return Value

type description
list the list of Active User names which have the specified permission

Faults

name description
ClientFault if caller passes in invalid list of Permission Targets

getAllUsersExcludingSuperAdmin

Find all active users excluding super_admin

Return Value

type description
list<User> list of users

getAllUsersForRole

Find all users which have specified role

Input Parameters

name type description
roleName string for search

Return Value

type description
list<User> list of users witch have specified role

Faults

name description
ClientFault If the users cannot be retrieved for any reason.

getRolesAvalibleForTaskAssignment

Find all roles, which have active users, excluding AFFILIATE_WEBSERVICE, AFFILIATE_CUSTOMER_SUPPORT_ADMIN, CUSTOMER_SUPPORT_ADMIN andSUPER_ADMIN

Return Value

type description
list list of roles

getRolesContainingProducerTaskPermissions

Gets the list of Roles that have any of the specified producer task Permission targets

Input Parameters

name type description
permissionTargets list the list of permission targets, for example the "Producer > Tasks" page on the UI could be an element of permissionTargets

Return Value

type description
list the list of role names containing the permission target

Faults

name description
ClientFault if caller passes in invalid list of Permission Targets