Get User Info

https://development.api.wealthcare.com/system/Services/User/Access

This operation allows you to retrieve the access profile of a user by submitting a request with specific Function IDs. It is typically used to determine the permissions and functionalities available to a user within the system. The operation expects a valid request body containing the Function IDs, and it will return the user access profile, including their permissions and functionalities. Authentication is required to access this endpoint, and the user must have the appropriate permissions to view access profiles.

Header parameters

api-version string Required

The requested API version, which determines the version of the API to be used for the request

Request body

FunctionID array <string>

Response

TpaId string Required

A unique identifier used to identify your admin instance. This value was system generated with the admin instance was created.
Name string Required

The name of TPA associated with the admin instance.
UserType string Required

Specifies the type of user associated with the admin instance.
BulkPermission string Required

Defines the set of EDI record codes that the admin has access to.
Functionality array <object> Required
- Id integer <int32>
  
  A unique identifier assigned to each function or request made by the user.
- Description string
  
  Represents the name of the function requested by the user.
- Permissions object
  
  Defines the access rights granted to the user for a specific function. These permissions determine what operations the user is allowed to perform.
  - Read boolean
    
    Indicates whether the user has permission to view or retrieve data related to the requested function.
  - Write boolean
    
    Indicates whether the user has permission to create or add new data for the requested function.
  - Update boolean
    
    Indicates whether the user has permission to modify existing data for the requested function.
  - Delete boolean
    
    Indicates whether the user has permission to remove or delete data related to the requested function.
- SubFunctions array <object>
  - Id string
    
    A unique identifier for the sub-function related to the main function requested by the user.
  - HasAccess boolean
    
    Indicates whether the user has permission to access this specific sub-function.
InsightPermissions array <object>
- Id integer <int32>
  
  A unique identifier for the insight that the user has access to.
- Name string
  
  The name of the insight available to the user
ReportPermissions array <object>
- Id integer <int32>
  
  A unique identifier for the report that the user has access to.
- Name string
  
  The name of the report available to the user