Add an administrator user

https://development.api.wealthcare.com/system/Services/Access/AdminManager/{tpaId}

This endpoint allows you to add a new administrator user to the system, identified by the unique TPA ID. It is typically used when onboarding new administrative personnel who require access to manage user accounts and benefits.

Request

Path parameters

tpaId string Required

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

Request body

tpaId string
userId string
title enum<string>

Possible values: None Mr Mrs Ms Dr Rev
firstName string

Min Length: 0

Max Length: 50
middleInitial string

Min Length: 0

Max Length: 1
lastName string

Min Length: 0

Max Length: 50
mobileNumber string

emailAddress string

Min Length:	0
Max Length:	75
Pattern:	^([a-zA-Z0-9_\-\.]+)@([a-zA-Z0-9_\-\.]+)\.([a-zA-Z]{2,5})$

allowGetCurrentSessions boolean
address1 string

Min Length: 0

Max Length: 50
address2 string
city string

Min Length: 0

Max Length: 30
state string
zipCode string

Min Length: 0

Max Length: 10
birthDate string
ssn string
profile string

Min Length: 0

Max Length: 30
role string

Min Length: 0

Max Length: 100
password string
viewableEmployers enum<string>

Possible values: All Only Not RoleDefined
employersList string
allowPayrollUpload boolean
reviewClaimsRequired boolean
reviewOverThreshold boolean
reviewPercent boolean
reviewPercentValue integer <int32>
reviewReason enum<string>

Possible values: None Training Performance Audit Threshold Manual

Response

Response body

tpaId string
userId string
title enum<string>

Possible values: None Mr Mrs Ms Dr Rev
firstName string
middleInitial string
lastName string
mobileNumber string
emailAddress string
allowGetCurrentSessions boolean
address1 string
address2 string
city string
state string
zipCode string
birthDate string
ssn string
profile string
role string
viewableEmployers enum<string>

Possible values: All Only Not RoleDefined
employersList string
userStatus enum<string>

Possible values: New Active TempInactive PermInactive
allowPayrollUpload boolean
reviewClaimsRequired boolean
reviewOverThreshold boolean
reviewPercent boolean
reviewPercentValue integer <int32>
reviewReason enum<string>

Possible values: None Training Performance Audit Threshold Manual

Administrative APIs | REST