在主控台中建立作用域

範圍是應用程式中的執行時期動作，可由獲授與必要許可權來完成它們的使用者採取。 當您向 App ID登錄應用程式時，會建立範圍。 如果您的應用程式已登錄，您可以編輯它以包含範圍。

範圍名稱的值必須符合下列需求:

• 為英數
• 小寫
• 開頭不是 appid 或 openid
• 不含句點 (.) 或底線 (_) 以外的特殊字元
• 少於 50 個字元。

若要建立範圍，您可以使用 App ID 使用者介面。

1. 移至 App ID 儀表板中的 應用程式。
2. 按一下 新增應用程式，以開啟配置畫面。 如果您已有想要使用的認證，請從您要更新之列的「動作」功能表中按一下 編輯。
3. 為您的應用程式提供名稱，並選取您具有的應用程式類型。
4. 輸入自訂範圍的值，然後按一下加號 (+)。範例範圍值可能是 read 或 write。
5. 重複前一個步驟，直到您將所有範圍新增至應用程式為止。
6. 按一下儲存。

使用 API 建立作用域

範圍是應用程式中的執行時期動作，可由獲授與必要許可權來完成它們的使用者採取。 當您向 App ID登錄應用程式時，會建立範圍。 如果您的應用程式已登錄，您可以編輯它以包含範圍。

範圍名稱的值必須符合下列需求:

• 為英數
• 小寫
• 開頭不是 appid 或 openid
• 不含句點 (.) 或底線 (_) 以外的特殊字元
• 少於 50 個字元。

若要建立範圍，您可以使用 App ID 使用者介面。

1. 向 /scopes 端點提出下列要求來建立範圍。

   curl -X PUT "https://<region>.appid.cloud.ibm.com/management/v4/<tenantID>/applications/<clientID>/scopes"
   -H "accept: application/json"
   -H "Content-Type: application/json"
   -d "{\ "scopes":\ [\ <scopesObject>}" ]}"
   

   變數	說明
   region	在其中佈建 App ID 實例的地區。 進一步瞭解 可用地區。
   tenantID	App ID 實例的唯一 ID。 您可以在應用程式的認證中找到此值，因為它們列在服務儀表板的 應用程式 標籤中。
   clientID	您應用程式的唯一識別碼。 您可以在應用程式的認證中找到此值，因為它們列在服務儀表板的 應用程式 中。
   scopesObject	包含您要為應用程式建立之所有範圍的 JSON 物件。
   {：caption =“呼叫 /scopes 端點所需的變數”caption-side =“top”}

2. 選用: 確認已建立範圍。

   curl -X GET "https://<region>.appid.cloud.ibm.com/management/v4/<tenantID>/applications/<clientID>/scopes"
   -H "accept: application/json"
   -H "Content-Type: application/json"
   

在主控台中建立角色

角色是一組適用於相同使用者類型的範圍。 例如，如果您建立 admin 角色，則 scope 區段可能容許該角色執行讀取、寫入或建立動作。 但是，如果您建立另一個稱為 viewer 的角色，則獲指派該角色的使用者具有唯讀存取權。 若要建立角色，您可以使用 App ID 使用者介面。

1. 移至 App ID 儀表板中的 人員資訊和角色> 角色。

2. 按一下 建立角色，以開啟配置畫面。

3. 為角色提供名稱和說明。

4. 透過使用您在前一節中建立的範圍，使用下列格式將範圍指派給角色。 按一下 + 以新增範圍。

   <appName>/<scope>
   

   如果您只有一個應用程式，則不需要指定應用程式名稱。 您可以自行新增範圍。

5. 重複前一個步驟來新增更多範圍。

6. 按一下儲存。

使用 API 建立角色

角色是一組適用於相同使用者類型的範圍。 例如，如果您建立 admin 角色，則 scope 區段可能容許該角色執行讀取、寫入或建立動作。 但是，如果您建立另一個稱為 viewer 的角色，則獲指派該角色的使用者將具有唯讀存取權。 若要建立角色，您可以使用 App ID API。

1. 向 /roles 端點提出要求以建立角色。

   curl -X POST "https://<region>.appid.cloud.ibm.com/management/v4/<tenantID>/roles"
   -H "accept: application/json"
   -H "Content-Type: application/json"
   -d { \"name\": \"<roleName>\", \"description\": \"<roleDescription>\", \"access\": [ { \"application_id\": \"<applicationID>\", \"scopes\": [ \"<scopes>" ] } ]}"
   

   變數	說明
   region	在其中佈建 App ID 實例的地區。 進一步瞭解 可用地區。
   tenantID	App ID 實例的唯一 ID。 您可以在應用程式的認證中找到此值，因為它們列在服務儀表板的 應用程式 標籤中。
   clientID	您應用程式的唯一識別碼。 您可以在應用程式的認證中找到此值，因為它們列在 應用程式中。
   roleName	您要指派給角色的名稱。
   roleDescription	此簡短詞組說明您的角色要執行的動作。
   applicationID	您應用程式的唯一識別碼。 您可以在應用程式的認證中找到此值，因為它們列在 應用程式中。
   scopes	您要套用至角色之所有範圍的 JSON 物件。
   {：caption =“呼叫 /scopes 端點所需的變數”caption-side =“top”}

2. 選用: 確認已建立角色。

   curl -X GET "https://<region>.appid.cloud.ibm.com/management/v4/<tenantID>/roles -H "accept: application/json"
   

   回應與以下範例相似：

   {
      "roles": [
      {
         "id": "12345678-1234-1234-1234-123456789012",
         "name": "admin",
         "description": "Can perform administrative tasks.",
         "access": [
            {
            "application_id": "de33d272-f8a7-4406-8fe8-ab28fd457be5",
            "scopes": [
               "create",
               "update",
               "write",
               "read"
            ]
            }
         ]
      }
      {
         "id": "123454231-1234-1234-3334-12345687012",
         "name": "developer",
         "description": "Can perform administrative tasks.",
         "access": [
            {
            "application_id": "de33d272-f8a7-4406-8fe8-ab28fd457be5",
            "scopes": [
               "write",
               "read"
            ]
            }
         ]
      }
      ]
   }
   

在主控台中為使用者指定角色

建立角色之後，您可以將它們指派給使用者的設定檔。 您也可以在建立未來使用者時指派角色。

1. 移至 App ID 儀表板中的 設定檔和角色> 使用者設定檔。
2. 從您要指派角色之特定使用者列中的「動作」功能表，按一下 指派角色。
3. 從可用角色清單中選取您要新增的一或多個角色。
4. 選用項目: 如果看不到您要尋找的角色，請按一下 建立角色，並提供資訊以新增另一個選項。
5. 按一下儲存。

使用 API 將角色指派給使用者

建立角色之後，您可以將它們指派給使用者的設定檔。 您也可以在建立未來使用者時指派角色。

1. 透過使用識別查詢 (例如電子郵件位址) 來搜尋 App ID 使用者，以取得您的使用者 ID。

   curl -X GET "https://<region>.appid.cloud.ibm.com/management/v4/<tenantID>/Users?query=<identifyingSearchQuery>" \
   -H "accept: application/json" \
   -H "authorization: Bearer <token>"
   

   範例：

   curl -X GET https://us-south.appid.cloud.ibm.com/management/v4/e19a2778-3262-4986-8875-8khjafsdkhjsdafkjh/cloud_directory/Users?query=example@domain.com
   -H "accept: application/json"
   -H "authorization: Bearer eyJraWQiOiIyMDE3MTEyOSIsImFsZ...."
   

2. 選用: 取得角色 ID 或角色名稱。 如果您已知道您的角色 ID 或名稱，請跳至下一步。

   curl -X GET "https://<region>.appid.cloud.ibm.com/management/v4/<tenantID>/roles" \
   -H "accept: application/json" \
   -H "authorization: Bearer <token>"
   

3. 對包含您要指派之角色的 JSON 物件的 /roles 端點提出要求。

   curl -X PUT "https://<region>.appid.cloud.ibm.com/management/v4/<tenantID>/users/<userID>/roles"
   -H "accept: application/json"
   -H "Content-Type: application/json"
   -d "{ \"roles\": { \"ids\": [ \"<roleIDs>\" ] }}"
   -H "authorization: Bearer <token>"
   

若要從使用者移除角色，請重新提出 PUT 要求，但移除角色 ID。