accessPackageResourceRequest の作成

名前空間: microsoft.graph

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

新しい accessPackageResourceRequest オブジェクトを作成して、アクセス パッケージ カタログへのリソースの追加、リソースの更新、またはカタログからのリソースの削除を要求します。 リソースをアクセス パッケージに追加する前に、 そのリソースを アクセス パッケージ カタログに含める必要があります。

この API は、次の国内クラウド展開で使用できます。

グローバル サービス 米国政府機関 L4 米国政府機関 L5 (DOD) 21Vianet が運営する中国
✅ ✅ ✅ ✅

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。

アクセス許可の種類 最小特権アクセス許可 より高い特権のアクセス許可
委任 (職場または学校のアカウント) EntitlementManagement.ReadWrite.All 注意事項なし。
委任 (個人用 Microsoft アカウント) サポートされていません。 サポートされていません。
アプリケーション EntitlementManagement.ReadWrite.All 注意事項なし。

ヒント

職場または学校アカウントを使用する委任されたシナリオでは、サインインしたユーザーには、次のいずれかのオプションを使用して、サポートされている役割のアクセス許可を持つ管理者ロールも割り当てる必要があります。

アプリのみのシナリオでは、呼び出し元のアプリに、 EntitlementManagement.ReadWrite.All アプリケーションのアクセス許可の代わりに、前述のサポート対象ロールの 1 つを割り当てることができます。 カタログ所有者ロールの特権は、EntitlementManagement.ReadWrite.All アプリケーションのアクセス許可よりも低くなります。

さらに、追加するリソースに対する次のアクセス許可も必要です。

  • Microsoft Entra グループをリソースとしてカタログに追加するには:
    • 委任されたアクセス許可を使用する場合、グループの追加を要求するユーザーは、グループの所有者であるか、グループの変更を許可するディレクトリ ロールに属している必要があります。
    • アプリケーションのアクセス許可を使用している場合は、グループの追加を要求するアプリケーションにも Group.ReadWrite.All アクセス許可を割り当てる必要があります。
  • Microsoft Entra ロールをリソースとしてカタログに追加するには:
    • 委任されたアクセス許可を使用する場合、ロールをカタログに追加するユーザーは、グローバル管理者またはカタログ所有者アクセス許可を持つ特権ロール管理者である必要があります。
    • 資格 Management.ReadWrite.All アクセス許可を持つアプリケーションは、グローバル管理者または特権ロール管理者アクセス許可も持っていない限り、Microsoft Entra ロールをカタログに追加できません。
  • Microsoft Entra アプリケーションをリソースとしてカタログに追加するには:
    • 委任されたアクセス許可を使用する場合、アプリケーションの追加を要求するユーザーは、アプリケーションの所有者であるか、アプリケーション ロールの割り当てを変更できるディレクトリ ロールに属している必要があります。
    • アプリケーションのアクセス許可を使用している場合は、 servicePrincipal の追加を要求するアプリケーションにも Application.ReadWrite.All アクセス許可が割り当てられる必要があります。
  • SharePoint Online サイトをリソースとしてカタログに追加するには、次の手順を実行します。
    • 委任されたアクセス許可を使用する場合は、ユーザーに SharePoint 管理者 ロールが割り当てられているか、SharePoint サイトの管理者である必要があります。
    • アプリケーションのアクセス許可を使用している場合は、アプリケーションにも Sites.FullControl.All アクセス許可を割り当てる必要があります。

HTTP 要求

POST /identityGovernance/entitlementManagement/accessPackageResourceRequests

要求ヘッダー

名前 説明
Authorization ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。
Content-Type application/json. 必須です。

要求本文

リクエスト本文には、 accessPackageResourceRequest オブジェクトの JSON 表現を指定します。 リクエストの一部として、accessPackageResource オブジェクトとのaccessPackageResource関係を含めます。

Microsoft Entra グループをリソースとしてカタログに追加するには、catalogId をカタログの ID に設定し、requestType を AdminAdd にして、リソースを表すaccessPackageResourceを設定します。 accessPackageResource内の originSystem プロパティの値は AadGroup である必要があり、originId の値はグループの識別子です。 委任されたアクセス許可を使用する場合、グループの追加を要求するユーザーは、グループの所有者であるか、グループを変更できるディレクトリ ロールに属している必要があります。 アプリケーションのアクセス許可を使用している場合は、グループの追加を要求するアプリケーションにも Group.ReadWrite.All アクセス許可を割り当てる必要があります。

Microsoft Entra アプリケーションをリソースとしてカタログに追加するには、catalogId をカタログの ID に設定し、requestType を AdminAdd に設定し、リソースを表すaccessPackageResourceを設定します。 accessPackageResource内の originSystem プロパティの値は AadApplication である必要があり、originId の値は servicePrincipal の識別子です。 委任されたアクセス許可を使用する場合、アプリケーションの追加を要求するユーザーは、アプリケーションの所有者であるか、アプリケーション ロールの割り当てを変更できるディレクトリ ロールの所有者である必要があります。

SharePoint Online サイトをリソースとしてカタログに追加するには、 catalogId をカタログの ID に設定し、 requestType を AdminAdd に設定し、リソースを表す accessPackageResource を設定します。 accessPackageResource内の originSystem プロパティの値は SharePointOnline である必要があり、originId の値はサイトの URI です。 委任されたアクセス許可を使用する場合、ユーザーは SharePoint 管理者ロールである必要があります。 アプリケーションのアクセス許可を使用している場合は、サイトの追加を要求するアプリケーションにも Sites.FullControl.All アクセス許可を割り当てる必要があります。 マルチジオロケーション Sharepoint Online リソースにジオロケーション環境を割り当てるには、accessPackageResource オブジェクトに accessPackageResourceEnvironment 関係を含めます。 これは、次の 2 つの方法で実行できます。

  • @odata.bindアノテーションを使用して、accessPackageResourceEnvironmentのidをaccessPackageResourceEnvironmentオブジェクトに割り当てます。
  • accessPackageResourceEnvironment オブジェクト内のaccessPackageResourceEnvironmentの originId パラメーターを指定します。

カタログからリソースを削除するには、 catalogId をカタログの ID に設定し、 requestType を AdminRemove に設定し、削除するリソース オブジェクトの accessPackageResource を設定します。 リソース オブジェクトは、 list accessPackageResources を使用して取得できます。

応答

成功した場合、このメソッドは 201 Created 応答コードと新しい accessPackageResourceRequest オブジェクトを応答本文で返します。

例

例 1: サイトをリソースとして追加するための accessPackageResourceRequest を作成する

要求

次の例は要求を示しています。

POST https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/accessPackageResourceRequests
Content-type: application/json

{
  "catalogId":"26ac0c0a-08bc-4a7b-a313-839f58044ba5",
  "requestType": "AdminAdd",
  "justification": "",
  "accessPackageResource": {
     "displayName": "Sales",
     "description": "https://contoso.sharepoint.com/sites/Sales",
     "url": "https://contoso.sharepoint.com/sites/Sales",
     "resourceType": "SharePoint Online Site",
     "originId": "https://contoso.sharepoint.com/sites/Sales",
     "originSystem": "SharePointOnline"
  }
}

応答

次の例は応答を示しています。

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

HTTP/1.1 201 Created
Content-type: application/json

{
  "catalogId": "26ac0c0a-08bc-4a7b-a313-839f58044ba5",
  "id": "1fe272f0-d463-42aa-a9a8-b07ab50a1c4d",
  "isValidationOnly": false,
  "justification": "",
  "requestState": "Delivered",
  "requestStatus": "Fulfilled",
  "requestType": "AdminAdd"
}

例 2: サイトをリソースとして追加するための accessPackageResourceRequest を作成し、 @odata.bind

要求

次の例は要求を示しています。 この例では、@odata.bindアノテーションを使用して、accessPackageResourceEnvironmentのidをaccessPackageResourceEnvironmentオブジェクトに割り当てます。

POST https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/accessPackageResourceRequests
Content-type: application/json

{
    "catalogId": "de9315c1-272b-4905-924b-cc112ca180c7",
    "accessPackageResource": {
        "displayName": "Community Outreach",
        "description": "https://contoso.sharepoint.com/sites/CSR",
        "resourceType": "SharePoint Online Site",
        "originId": "https://contoso.sharepoint.com/sites/CSR",
        "originSystem": "SharePointOnline",
        "accessPackageResourceEnvironment@odata.bind": "accessPackageResourceEnvironments/615f2218-678f-471f-a60a-02c2f4f80c57"
    },
    "requestType": "AdminAdd"
}

応答

次の例は応答を示しています。

HTTP/1.1 201 Created
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/entitlementManagement/accessPackageResourceRequests/$entity",
    "catalogId": "de9315c1-272b-4905-924b-cc112ca180c7",
    "executeImmediately": false,
    "id": "d3f800d5-0dd6-47f3-9e90-ef562c7551dc",
    "requestType": "AdminAdd",
    "requestState": "Delivered",
    "requestStatus": "Fulfilled",
    "isValidationOnly": false,
    "expirationDateTime": null,
    "justification": null
}

例 3: サイトをリソースとして追加するための accessPackageResourceRequest を作成し、originId を使用して accessPackageResourceEnvironment を割り当てる

要求

次の例は要求を示しています。 この例では、 accessPackageResourceEnvironment のパラメーターを accessPackageResourceEnvironment オブジェクトで指定します。

POST https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/accessPackageResourceRequests
Content-type: application/json

{
    "catalogId": "de9315c1-272b-4905-924b-cc112ca180c7",
    "accessPackageResource": {
        "displayName": "Community Outreach",
        "description": "https://contoso.sharepoint.com/sites/CSR",
        "resourceType": "SharePoint Online Site",
        "originId": "https://contoso.sharepoint.com/sites/CSR",
        "originSystem": "SharePointOnline",
        "accessPackageResourceEnvironment": {
            "originId": "https://contoso-admin.sharepoint.com/"
        }
    },
    "requestType": "AdminAdd"
}

応答

次の例は応答を示しています。

HTTP/1.1 201 Created
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/entitlementManagement/accessPackageResourceRequests/$entity",
    "catalogId": "de9315c1-272b-4905-924b-cc112ca180c7",
    "executeImmediately": false,
    "id": "eadf3fbb-668c-4c3a-8d84-7c8bd73dc3e4",
    "requestType": "AdminAdd",
    "requestState": "Delivered",
    "requestStatus": "Fulfilled",
    "isValidationOnly": false,
    "expirationDateTime": null,
    "justification": null
}

例 4: グループをリソースとして追加するための accessPackageResourceRequest を作成する

要求

次の例は要求を示しています。

POST https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/accessPackageResourceRequests
Content-type: application/json

{

  "catalogId":"beedadfe-01d5-4025-910b-84abb9369997",
  "requestType": "AdminAdd",
  "accessPackageResource": {
     "originId": "c6294667-7348-4f5a-be73-9d2c65f574f3",
     "originSystem": "AadGroup"
  }
}

応答

次の例は応答を示しています。

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

HTTP/1.1 201 Created
Content-type: application/json

{
  "catalogId": "beedadfe-01d5-4025-910b-84abb9369997",
  "id": "acc2294e-f37f-42d3-981d-4e83847ed0ce",
  "requestType": "AdminAdd",
  "requestState": "Delivered",
  "requestStatus": "Fulfilled"
}

例 5: リソースを削除するための accessPackageResourceRequest を作成する

要求

次の例は要求を示しています。

POST https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/accessPackageResourceRequests
Content-type: application/json

{
  "catalogId": "beedadfe-01d5-4025-910b-84abb9369997",
  "requestType": "AdminRemove",
  "accessPackageResource": {
    "id": "354078e5-dbce-4894-8af4-0ab274d41662"
  }
}

応答

次の例は応答を示しています。

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

HTTP/1.1 201 Created
Content-type: application/json

{
  "catalogId": "beedadfe-01d5-4025-910b-84abb9369997",
  "id": "65c3340d-defb-49a9-8930-63841fda0e68",
  "requestType": "AdminRemove",
  "requestState": "Delivered",
  "requestStatus": "Fulfilled"
}

例 6: アプリケーションを追加するための accessPackageResourceRequest を作成する

要求

次の例は、カタログにアプリケーションを追加するための要求を示しています。これには、そのアプリケーションの必須属性の指定が含まれます。

POST https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/accessPackageResourceRequests
Content-type: application/json

{
  "catalogId": "26ac0c0a-08bc-4a7b-a313-839f58044ba5",
  "requestType": "AdminAdd",
  "justification": "",
  "accessPackageResource": {
      "displayName": "Faculty cafeteria ordering",
      "description": "Example application",
      "url": "https://myapps.microsoft.com/example.com/signin/Faculty%20cafeteria%20ordering/f1e3b407-942d-4934-9a3f-cef1975cb988/",
      "resourceType": "Application",
      "originId": "2f1099a6-d4fc-4cc9-a0ef-ddd3f1bf0b7e",
      "originSystem": "AadApplication",
      "attributes": [
        {
          "attributeName": "extension_2b676109c7c74ae2b41549205f1947ed_personalTitle",
          "isEditable": true,
          "isPersistedOnAssignmentRemoval": true,
          "attributeSource": {
              "@odata.type": "#microsoft.graph.accessPackageResourceAttributeQuestion",
              "question": {
                  "@odata.type": "#microsoft.graph.accessPackageTextInputQuestion",
                  "isRequired": false,
                  "sequence": 0,
                  "isSingleLineQuestion": true,
                  "text": {
                      "defaultText": "Title",
                      "localizedTexts": []
                  }
              }
          },
          "attributeDestination": {
              "@odata.type": "#microsoft.graph.accessPackageUserDirectoryAttributeStore"
          }
        }
      ]
  }
}

応答

次の例は応答を示しています。

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

HTTP/1.1 201 Created
Content-type: application/json

{
  "id": "f0e632ed-afd2-41d3-8d6e-ccefda457e5e",
  "requestType": "AdminAdd",
  "requestState": "Delivered",
  "requestStatus": "Fulfilled"
}

例 7: SAP IAG アクセス権をリソースとして追加するための accessPackageResourceRequest を作成する

要求

次の例は、外部オリジン リソース コネクタをカタログに追加するための要求を示しています。これには、そのリソース コネクタの必須属性の指定が含まれます。

POST https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/accessPackageResourceRequests
Content-type: application/json

{
  "catalogId": "bcb19bf7-cdf7-4a70-a106-f6543620b2a5",
  "accessPackageResource": {
    "id": "88eb460d-ca08-4eb9-afae-8d60a8b00377",
    "displayName": "SAP IAG Access Rights",
    "description": "This resource represents the business roles of SAP IAG",
    "resourceType": "Business role",
    "originId": "https://iagintgorg-iag-intg-space-java-rest-arqapi.cfapps.sap.hana.ondemand.com",
    "originSystem": "External",
    "accessPackageResourceScopes": [],
    "externalOriginResourceConnector": {
      "id": "1a53cea5-48bd-467c-af81-a24245b0df2b",
      "displayName": "SAP IAG 10.0",
      "description": "SAP IAG 10.0.0",
      "connectorType": "sapIag",
      "connectionInfo": {
        "@odata.type": "microsoft.graph.externalTokenBasedSapIagConnectionInfo",
        "url": "https://iagigorg-iag-intg-space-java-rest-arqapi.cfapps.sap.hana.ondemand.com",
        "subscriptionId": "8e072eb5-73f5-4ed2-9324-a734dcb9728",
        "resourceGroup": "SAPResourceGroup",
        "accessTokenUrl": "https://entra-docu-intg-mrrd3gv.authentication.sap.hana.ondemand.com/oauth/token",
        "clientId": "sb-72062308-a7ae-456f-b9a4-24302b8a4aa!b247012|iagapi-iag-intg-space!b11378",
        "keyVaultName": "SAPIAG-KV",
        "secretName": "ClientSecret"
      }
    },
    "accessPackageResourceEnvironment": null
  },
  "requestType": "AdminAdd",
  "history": [],
  "executeImmediately": true
}

応答

次の例は応答を示しています。

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

HTTP/1.1 201 Created
Content-type: application/json

{
  "id": "0e37f047-c6b9-4d5c-99cd-e3fab4007be4",
  "requestType": "AdminAdd",
  "requestState": "Delivered",
  "requestStatus": "Fulfilled"
}

例 8: 管理グループ リソースをカタログに追加する

要求

次の例は、管理グループ リソースをカタログに追加する要求を示しています。

POST https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/accessPackageResourceRequests
Content-type: application/json

{
    "catalogId": "e8368470-afaf-44da-ba86-13a7318f1995",
    "requestType": "AdminAdd",
    "justification": "",
    "accessPackageResource": {
        "id": "",
        "displayName": "test-mgmtgroup",
        "description": "test-mgmtgroup",
        "resourceType": "ManagementGroup",
        "originId": "/providers/Microsoft.Management/managementGroups/test-mgmtgroup",
        "originSystem": "AzureResources"
    }
}

応答

次の例は応答を示しています。

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

HTTP/1.1 201 Created
Content-type: application/json

{
    "catalogId": "e8368470-afaf-44da-ba86-13a7318f1995",
    "id": "99e156fe-d152-4005-b019-6ba816f411ea",
    "justification": "",
    "requestState": "Delivered",
    "requestStatus": "Fulfilled",
    "requestType": "AdminAdd",
}

例 9: サブスクリプション リソースをカタログに追加する

要求

次の例は、カタログにサブスクリプション リソースを追加するための要求を示しています。

POST https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/accessPackageResourceRequests
Content-type: application/json

{
    "catalogId": "e8368470-afaf-44da-ba86-13a7318f1995",
    "requestType": "AdminAdd",
    "justification": "",
    "accessPackageResource": {
        "id": "",
        "displayName": "Dev",
        "description": "Dev",
        "resourceType": "Subscription",
        "originId": "/subscriptions/828b526f-c769-4b19-9797-734b4843b978",
        "originSystem": "AzureResources"
    }
}

応答

次の例は応答を示しています。

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

HTTP/1.1 201 Created
Content-type: application/json

{
    "catalogId": "e8368470-afaf-44da-ba86-13a7318f1995",
    "id": "13ac6518-0597-452c-98ff-59c52b391dae",
    "justification": "",
    "requestState": "Delivered",
    "requestStatus": "Fulfilled",
    "requestType": "AdminAdd",
}
  • 最終更新: