查詢組織列表
查詢組織列表
支援查詢目前開發者金鑰所屬帳號可存取的組織列表。
可以透過該 API,查詢目前開發者金鑰所屬帳號可存取的組織列表。
請求方式
GET
調用地址
https://api.${endpoint}/v1/org/list
調用驗證
使用帳號級 DevKey / DevSecret 的 Basic 驗證。
請求
請求範例
curl -X GET 'https://api.${endpoint}/v1/org/list' \
-H 'Authorization: Basic ${BASIC_TOKEN}'
curl -X GET 'https://api.${endpoint}/v1/org/list' \
-H 'Authorization: Basic ${BASIC_TOKEN}'
此代碼塊在浮窗中顯示
請求標頭
| 欄位 | 類型 | 說明 |
|---|---|---|
| Authorization | Basic ${BASIC_TOKEN} | 使用 DevKey:DevSecret Base64 後的 Basic Token。 |
請求參數
無。
回應
回應範例
{
"code": 0,
"message": "OK",
"data": [
{
"org_id": "p-xxxx",
"org_name": "Demo Org",
"is_owner": true
}
]
}
{
"code": 0,
"message": "OK",
"data": [
{
"org_id": "p-xxxx",
"org_name": "Demo Org",
"is_owner": true
}
]
}
此代碼塊在浮窗中顯示
成功回應
| 欄位 | 類型 | 說明 |
|---|---|---|
| org_id | String | 組織 ID,後續組織資源 API 需要傳入該欄位。 |
| org_name | String | 組織名稱。 |
| is_owner | Boolean | 目前帳號是否為組織擁有者。 |
失敗回應
| 欄位 | 類型 | 說明 |
|---|---|---|
| code | Integer | 錯誤碼。 |
| message | String | 錯誤詳情。 |
狀態碼
| 狀態碼 | 說明 |
|---|---|
| 200 | 成功 |
| 400 | 參數錯誤 |
| 401 | 未授權 |
| 403 | 權限不足 |
| 429 | 請求過於頻繁 |
| 500 | 伺服器錯誤 |
