/enterprise/getPBXSecureDetailsByPBXUserIdOrSIPAOR/{pbxUserIdOrSIPAOR}

Published on Jun 17, 2025

2 minute(s) read

Prev Next

Post

Operation to retrieve PBX details of an Enterprise User's PBX Location.

Security

OAuth

FlowPassword

Token URL/oauth/token

Responses

200

Array of object

object

_links

object (Links)

property*

object (Link) additionalProperties

deprecation

string

href

string

hreflang

string

name

string

profile

string

templated

boolean

title

string

type

string

acceptsEncodedFeatureCode

boolean

apiAccessEnabled

boolean

apiIntegrationEnabled

boolean

callPolicy

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)

canonicalPbxSIPDomain

string

codecs

string

convertHistoryInfoToDiversion

boolean

credentialTemplateId

integer (int64)

dnsLookupType

string

domainAlias

Array of string

string

enableMWIEvents

boolean

enforceCodecsOnInbound

boolean

escapeRequestUri

boolean

integer (int64)

metaSwitchSubscriptionCompatibility

boolean

oldStyleHold

boolean

parentCredentialTemplateInfo

object (PbxCredentialTemplateInfo)

apiCredentialDetail

object (PbxCredentialDetail)

accessCredentialOverride

boolean

accessPassword

string

accessUsername

string

clientCredentialOverride

boolean

clientId

string

clientSecret

string

credentialType

string

Valid values[ "API", "SSO" ]

integer (int64)

ssoEndpoint

string

ssoEndpointOverride

boolean

ssoProviderType

string

ssoUserPortalUrl

string

ssoUserPortalUrlOverride

boolean

tokenUrl

string

tokenUrlOverride

boolean

entPbxDetailsId

integer (int64)

entityId

integer (int64)

entityType

string

integer (int64)

masterResellerTemplateId

integer (int64)

parentTemplateId

integer (int64)

parentTemplateInfo

object (PbxCredentialTemplateInfo) Recursive

pbxName

string

pbxTypeId

integer (int64)

profileName

string

resellerTemplateId

integer (int64)

ssoCredentialDetail

object (PbxCredentialDetail)

accessCredentialOverride

boolean

accessPassword

string

accessUsername

string

clientCredentialOverride

boolean

clientId

string

clientSecret

string

credentialType

string

Valid values[ "API", "SSO" ]

integer (int64)

ssoEndpoint

string

ssoEndpointOverride

boolean

ssoProviderType

string

ssoUserPortalUrl

string

ssoUserPortalUrlOverride

boolean

tokenUrl

string

tokenUrlOverride

boolean

pbxApiSettings

object (PBXApiSettings)

initVector

string

locationId

integer (int64)

PBX Location ID - cannot be empty.

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

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

wsdlLocation

string

pbxHostingType

string

pbxIPAddress

string

pbxLabel

string

pbxLocation

string

pbxSIPDomain

string

pbxSIPDomainProxy

string

pbxSipAutoProvisionSettings

object (PBXSipAutoProvSettings)

locationId

integer (int64)

PBX Location ID - cannot be empty.

provisioningDIDField

string

provisioningPassword

string

SIP Auto Provision Access User Password - cannot be empty.

provisioningServerAutoMacEnabled

boolean

provisioningServerCertificateConfig

string (byte)

provisioningServerCertificateName

string

provisioningServerEnabled

boolean

provisioningURL

string

provisioningUsername

string

SIP Auto Provision Access Username - cannot be empty.

pbxSsoSettings

object (PBXSsoSettings)

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

pbxType

string

presencePackageType

string

proxyDomainName

string

proxyDomainPort

integer (int32)

regExpiresValue

integer (int64)

rejectCalling

boolean

rejectInterval

integer (int64)

rejectMethod

string

sipWaitForAlegAck

boolean

tenantId

string

topologyHiding

boolean

transportType

string

voicemailFeatureCode

string

Was this article helpful?