產品端點

NOTE
如果傳遞的是使用者權杖,則權杖的使用者必須具有請求組織的「組織管理員」角色。

以屬性為基礎的存取控制API中的/products端點可讓您以程式設計方式管理產品,以及與您組織中的產品相關聯的許可權類別和許可權集。

快速入門

本指南中使用的API端點屬於屬性型存取控制API的一部分。 繼續之前,請先檢閱快速入門手冊,以取得相關檔案的連結、閱讀本檔案中範例API呼叫的手冊,以及有關成功呼叫任何Experience PlatformAPI所需必要標題的重要資訊。

擷取已授權產品的清單 list

您可以向/products端點發出GET要求,以擷取已授權產品的清單。

API格式

GET /products/

要求

下列請求會擷取屬於您組織的已授權產品清單。

curl -X GET \
  https://platform.adobe.io/data/foundation/access-control/administration/products \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \

回應

成功的回應會傳回屬於您組織的已授權產品清單。

{
  "products": [
    {
      "id": "{ID}",
      "name": "Adobe Experience Platform",
      "serviceCode": "{SERVICE_CODE}"
    }
  ]
}
屬性
說明
id
查詢產品的對應ID。
name
查詢產品的名稱。
serviceCode
查詢產品的對應服務代碼。

依產品ID查詢許可權類別

您可以在指定產品ID時,透過向/products/{PRODUCT_ID}/categories端點發出GET要求來查詢指定產品的許可權類別。

API格式

GET /products/{PRODUCT_ID}/categories
參數
說明
與您要查閱的許可權類別相關聯的產品識別碼。

要求

下列要求會擷取與{PRODUCT_ID}關聯的許可權類別。

curl -X GET \
  https://platform.adobe.io/data/foundation/access-control/administration/products/{PRODUCT_ID}/categories \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \

回應

成功的回應會傳回與您查詢的產品ID相關聯的許可權類別。

{
  "categories": [
    {
        "name": "Profile Management"
    },
    {
        "name": "Data Ingestion"
    },
    {
        "name": "Sandbox Administration"
    },
    {
        "name": "Query Service"
    },
    {
        "name": "Data Management"
    },
    {
        "name": "Identity Management"
    },
    {
        "name": "Data Modeling"
    },
    {
        "name": "Data Science Workspace"
    },
    {
        "name": "Dashboards"
    },
    {
        "name": "Alerts"
    },
    {
        "name": "Data Governance"
    }
  ]
}
屬性
說明
category
查詢的產品ID中可用的許可權類別。
name
許可權類別的名稱。

依產品ID查詢許可權集

您可以在指定產品ID時,透過向/products/{PRODUCT_ID}/permission-sets端點發出GET要求來查詢指定產品的許可權集。

API格式

GET /products/{PRODUCT_ID}/permission-sets
參數
說明
與您要查閱的許可權集相關聯的產品識別碼。

要求

下列要求會擷取與{PRODUCT_ID}關聯的許可權集。

curl -X GET \
  https://platform.adobe.io/data/foundation/access-control/administration/products/{PRODUCT_ID}/permission-sets \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \

回應

成功的回應會傳回與您查詢的產品ID相關聯的許可權集。

{
  "permission-sets": [
      {
          "id": "manage-schemas",
          "name": "Manage Schemas",
          "category": "Data Modeling",
          "permissions": [
              {
                  "resource": "schemas",
                  "actions": [
                      "read",
                      "write",
                      "delete"
                  ]
              },
              {
                  "resource": "schema-fields",
                  "actions": [
                      "read",
                      "write",
                      "delete"
                  ]
              },
              {
                  "resource": "sandboxes",
                  "actions": [
                      "view"
                  ]
              }
          ]
      },
      {
          "id": "view-schemas",
          "name": "View Schemas",
          "category": "Data Modeling",
          "permissions": [
              {
                  "resource": "schemas",
                  "actions": [
                      "read"
                  ]
              },
              {
                  "resource": "schema-fields",
                  "actions": [
                      "read"
                  ]
              },
              {
                  "resource": "sandboxes",
                  "actions": [
                      "view"
                  ]
              }
          ]
      },
  ]
}
屬性
說明
permission-sets
許可權集代表管理員可套用至角色的一組許可權。 管理員可以將許可權集指派給角色,而不是指派個別許可權。 這可讓您從包含一組許可權的預定義角色建立自訂角色。
id
查詢許可權集的對應ID。
name
查詢許可權集的對應名稱。
category
可用的許可權類別。
permissions
許可權包括檢視和/或使用Platform功能的能力,例如建立沙箱、定義結構以及管理資料集。
permissions.resource
主體可以或無法存取的資產或物件。 資源可以是檔案、應用程式、伺服器或甚至API。
permissions.actions
允許主體對查詢的資源執行的動作。 可能的值包括: viewreadcreateeditdelete
recommendation-more-help
631fcab2-5cb1-46ef-ba66-fe098ac723e0