/enterprise/configureUser

Prev Next
Post
/enterprise/configureUser

Operation to Add/Edit a User in the Enterprise. This operation also enables the Calling Services to the given User when the Authentication object is filled in with appropriate parameters

Security
OAuth
FlowPassword
Token URL/oauth/token
Body parameters
Expand All
object
authenticationResult
object (MSALAuthenticationResult)
authenticationResult
object (AuthenticationResult)
accessToken
string
accessTokenType
string
expiresAfter
integer (int64)
expiresOn
integer (int64)
expiresOnDate
string (date-time)
idToken
string
multipleResourceRefreshToken
boolean
refreshToken
string
userInfo
object (UserInfo)
displayableId
string
identityProvider
string
tenantId
string
resellerId
integer (int64)
tenantId
string
callPolicyInfo
object (CallPolicyInfo)
callPolicyCNAM
string
callPolicyCallerId
string
callPolicyName
string
forwardedCallsCallerId
string
resellerId
integer (int64)
codecs
string
deviceName
string
deviceType
string
directRouteId
integer (int64) Deprecated

This attribute is deprecated and will be removed in 2.7.0. Use sbcGatewayId instead

disableTeamsVoicemail
boolean Deprecated
email
string
firstName
string
lastName
string
linePort
string
loginID
string Required

Login ID - cannot be empty

macAddress
string
password
string
pbxAuthUserId
string
pbxCallPolicyInfo
object (PBXCallPolicyInfo)
callPolicyCNAM
string
Valid values[ "TRANSPARENT", "OTHER" ]
Default"TRANSPARENT"
callPolicyCustomCNAM
string
callPolicyName
string
Default"Global"
forwardedCallsCallerId
string
Valid values[ "USER_CALLER_ID", "TRANSPARENT" ]
Default"USER_CALLER_ID"
resellerId
integer (int64)
pbxLocation
string Required

PBX ID - cannot be empty

pbxUserId
string Required

PBX User ID - cannot be empty

phoneNumber
string
portalLoginName
string
portalPassword
string
provisioningPassword
string
provisioningUsername
string
rePassword
string
sbcGatewayId
integer (int64) Required

SBC Gateway identifier - value must be greater than 0

sipAutoProvisioningEnabled
boolean
teamsUserId
string Required

Teams User ID - cannot be empty

tenantID
string Required

Tenant ID - cannot be empty

useAudioConferenceVRP
boolean
useEnterpriseDialPlan
boolean
useTeamsVoicemail
boolean
userTag
string
userType
string

User Type - the type of the User being provisioned

Default"PBX"
Responses
200

OK

object