/pbx/managePBXSSOSettings

  • Published on Jun 17, 2025
  • 1 minute(s) read
Prev Next
Post
/pbx/managePBXSSOSettings

Operation to manage the Advanced SSO settings for the PBX. The settings configured here will be used to show the PBX End User Portal in the Teams client as a tab in the Custom Application when deployed for the Office 365 Enterprise users

Security
OAuth
FlowPassword
Token URL/oauth/token
Body parameters
object
hasPortal
boolean
locationId
integer (int64)
managerPassword
string Required

API Access User Password - cannot be empty. This is the Client Secret generated by the PBX vendor for this Enterprise to access the API

managerUsername
string Required

API Access Username - cannot be empty. This is the Client Secret generated by the PBX vendor for this Enterprise to access the API

pbxClientId
string Required

PBX Client ID - cannot be empty. This is the Client ID generated by the PBX vendor for this Enterprise to access the API

pbxClientSecret
string Required

PBX Client Secret - cannot be empty. This is the Client Secret generated by the PBX vendor for this Enterprise to access the API

pbxEUPortal
string Required

PBX End User Portal - cannot be empty. This is the default URL that the Teams tab will fallback to when the SSO to the PBX fails

pbxSSOEndpoint
string Required

PBX SSO endpoint - cannot be empty. This is the URL that serves the End User Portal after the Credentials are authenticated.

pbxTokenEndpoint
string Required

PBX token endpoint - cannot be empty. This is the Authorization URL that serves the Token for accessing the API using the client ID and Secret specified

providerType
string
sameCredentialsAsPbxAPI
boolean
Responses
200

OK

boolean