Skip to content
This repository was archived by the owner on Nov 29, 2023. It is now read-only.

Commit 87dc33d

Browse files
authored
ONEID-1530 - Add note on default users API permissions on Credentials Page (#696)
* ONEID-1530 - Add note on default users API permissions on Credentials page * ONEID-1530 - remove eng * ONEID-1530 - added comma after "deault" - better english/grammar * ONEID-1530 - add missing "/" in order details url
1 parent 70c8cde commit 87dc33d

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

site/docs/account/credentials.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,21 @@ All of Bandwidth's APIs are protected with Basic Authorization over HTTPS. Basic
3030

3131
Bandwidth provides a 'user-based' permission and authentication scheme. It's recommended to [create a new user](https://support.bandwidth.com/hc/en-us/articles/115007187088-How-to-Create-New-Users-in-the-Bandwidth-Dashboard) with **ONLY** API access and the necessary roles on your account. The API user can be leveraged to access all of Bandwidth's APIs.
3232

33+
34+
:::note
35+
By default, users with no assigned role(s) will have the ability to perform GET requests against the following endpoints:
36+
* Orders:
37+
* `https://dashboard.bandwidth.com/api/accounts/{accountId}/orders`
38+
* Order Details:
39+
* `https://dashboard.bandwidth.com/api/accounts/{accountId}/orders/{orderId}`
40+
* SIP Peer Details:
41+
* `https://dashboard.bandwidth.com/api/accounts/{accountId}/sites/{siteId}/sippeers`
42+
* Admin Edge Settings:
43+
* `https://dashboard.bandwidth.com/api/accounts/{accountId}/products/edgemanagement/settings`
44+
* Subscriptions API:
45+
* `https://dashboard.bandwidth.com/api/accounts/{accountId}/subscriptions`
46+
:::
47+
3348
## API User Credentials
3449

3550
⚠️ The API user is meant to be separate from your Dashboard user and **should not** be used to access the Dashboard. Further, your Dashboard user **should not** be used to access Bandwidth's APIs.

0 commit comments

Comments
 (0)