/pbx/getPBXSSOSettingsWithLocationDetailsByLocationId/{pbxLocationId}

  • Published on Jun 17, 2025
  • 1 minute(s) read
Prev Next
Post
/pbx/getPBXSSOSettingsWithLocationDetailsByLocationId/{pbxLocationId}

Operation to retrieve the PBX SSO settings configured by a specific Location ID for the Office365 Organization.

Security
OAuth
FlowPassword
Token URL/oauth/token
Path parameters
pbxLocationId
integer (int64) Required
Responses
200

OK

object
hasPortal
boolean
locationId
integer (int64)
managerPassword
string

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

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

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

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

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

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

pbxTokenEndpoint
string

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