Channel-Scoped API Access through APIM
To support channel-specific API integrations, Live Platform now supports channel-scoped API requests when used in conjunction with Azure API Management (APIM). Previously, Live Platform API access was available only at the Service Provider (SP) level. Authentication tokens granted access to resources across all channels without any mechanism to restrict API operations to customers belonging to a specific channel. As a fast-track solution, channel integrations can now be routed through APIM instead of directly to Live Platform. APIM identifies the calling channel and adds a channel identifier header to requests forwarded to Live Platform. Live Platform then validates the channel context and retrieves only resources belonging to the requesting channel.
This feature is implemented using new channel-scoping header parameters: IAM Id of the channel (X-IAM-Account-Id) or the Live Platform channel Id itself (X-Ovoc-Channel-Id).
| ■ | When accessing Rest API with Channel admin permissions: If these request headers are not configured, the request will fail. |
| ■ | When accessing Rest API with Service Provider tenant level permissions: If these request headers are not configured, Live Platform maintains its existing behavior and processes requests with full Service Provider scope, allowing access to all system resources according to the token's permissions. |
The table below describes the endpoints and services support for these new request headers.
The code examples in the Rest API documentation links shown in the table below with the new request headers (described above) have been generated with Service Provider tenant level permissions. Later versions of documentation will include customized sections for connecting to Rest API as Channel admin including examples generated with this permission level.
|
Request |
Service Type |
||||||
|---|---|---|---|---|---|---|---|
|
Get Services Brief Details (V3) |
|
||||||
|
Provision Customer M365 User |
|
||||||
|
Get Operator Connect Customer Numbers V2 |
|
||||||
|
Get Operator Connect Customer Numbers V3 |
|
||||||
|
Get List of End Users and their M365 Teams Phone System Attributes |
|
||||||
|
Get SIP Connections |
|
||||||
|
Add SIP Connections |
|
||||||
|
Modify SIP Connection |
|
||||||
|
Delete Specific SIP Connections |
|