accessPackageAssignmentRequest を作成する

名前空間: microsoft.graph

重要

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

Azure AD エンタイトルメント管理で、新しい accessPackageAssignmentRequest オブジェクトを作成します。 この操作は、アクセス パッケージにユーザーを割り当てたり、アクセス パッケージの割り当てを削除したりするために使用されます。

アクセス許可

この API を呼び出すには、次のいずれかのアクセス許可が必要です。アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。

アクセス許可の種類 アクセス許可 (特権の小さいものから大きいものへ)
委任 (職場または学校のアカウント) EntitlementManagement.ReadWrite.All
委任 (個人用 Microsoft アカウント) サポートされていません。
アプリケーション EntitlementManagement.ReadWrite.All

HTTP 要求

POST /identityGovernance/entitlementManagement/accessPackageAssignmentRequests

要求ヘッダー

名前 説明
Authorization ベアラー {トークン}。 必須です。
Content-Type application/json. Required.

要求本文

要求本文で、 accessPackageAssignmentRequest オブジェクトの JSON 表現を指定します。

管理者がユーザーの割り当ての作成を要求する場合、requestType プロパティの値はAdminAddaccessPackageAssignment プロパティに割り当てられているユーザー、accessPackageAssignmentPolicy を識別する assignmentPolicyId プロパティ、および accessPackage を識別する accessPackageId プロパティが含まれますtargetId

管理者が割り当ての削除を要求する場合、requestType プロパティの値は AdminRemoveaccessPackageAssignment プロパティに、削除される accessPackageAssignment を識別する id プロパティが含まれています。

管理者以外のユーザーが最初の割り当てまたは更新の割り当てに対して独自の割り当ての作成を要求する場合、 requestType プロパティの値は UserAdd. accessPackageAssignment プロパティには、ユーザーがtargetIdidまれています。 assignmentPolicyId プロパティは、accessPackageAssignmentPolicy を識別します。 accessPackageId プロパティは、accessPackage を識別します。 要求を行うユーザーは、ディレクトリに既に存在している必要があります。

管理者以外のユーザーが独自の割り当ての拡張を要求する場合、 requestType プロパティの値は UserExtend. accessPackageAssignment プロパティには、ユーザーがtargetIdidまれています。 assignmentPolicyId プロパティは、accessPackageAssignmentPolicy を識別します。 accessPackageId プロパティは、accessPackage を識別します。 要求を行うユーザーは、ディレクトリに既に存在している必要があります。

応答

成功した場合、このメソッドは、応答本文に 200 シリーズの応答コードと新しい accessPackageAssignmentRequest オブジェクトを返します。

これが要求の AdminAdd 場合は、その後 accessPackageAssignment が作成され、必要に応じて accessPackageSubject も作成されます。 accessPackageAssignments を一覧表示するときに、クエリ パラメーターを使用して検索できます。

例 1: 管理がディレクトリ内に既に存在するユーザーに対して直接割り当てを要求する

要求

管理者がユーザーの割り当ての作成を要求している直接割り当ての要求の例を次に示します。 accessPackageSubject はまだ存在しない可能性があるため、targetID の値は割り当てられているユーザーのオブジェクト ID であり、accessPackageId の値はそのユーザーに必要なアクセス パッケージであり、assignmentPolicyId の値はそのアクセス パッケージの直接割り当てポリシーです。

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

{
  "requestType": "AdminAdd",
  "accessPackageAssignment":{
     "targetId":"46184453-e63b-4f20-86c2-c557ed5d5df9",
     "assignmentPolicyId":"2264bf65-76ba-417b-a27d-54d291f0cbc8",
     "accessPackageId":"a914b616-e04e-476b-aa37-91038f0b165b"
  }
}

応答

応答の例を次に示します。

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

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

{

  "id": "7e382d02-4454-436b-b700-59c7dd77f466",
  "requestType": "AdminAdd",
  "requestState": "Submitted",
  "requestStatus": "Accepted",
  "isValidationOnly": false
}

例 2: ユーザーがパッケージを要求し、承認に関する質問に回答する

要求

次に示す要求の例を示します。要求者は、承認者が決定を下すのに役立つ回答を提供しました。

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

{
    "requestType": "UserAdd",
    "accessPackageAssignment": {
        "targetId": "46184453-e63b-4f20-86c2-c557ed5d5df9",
        "assignmentPolicyId": "2264bf65-76ba-417b-a27d-54d291f0cbc8",
        "accessPackageId": "a914b616-e04e-476b-aa37-91038f0b165b"
    },
    "answers": [
        {
            "@odata.type": "#microsoft.graph.accessPackageAnswerString",
            "value": "Arizona",
            "answeredQuestion": {
                "@odata.type": "#microsoft.graph.accessPackageMultipleChoiceQuestion",
                "id": "A714EC6F-4EE0-4614-BD81-37E0C5ECBBFF"
            }
        },
        {
            "@odata.type": "#microsoft.graph.accessPackageAnswerString",
            "value": "Need access to marketing campaign material",
            "answeredQuestion": {
                "@odata.type": "#microsoft.graph.accessPackageTextInputQuestion",
                "id": "AA615EE9-D9D8-4C03-BE91-BEE37106DEDA"
            }
        }
    ]
}

応答

応答の例を次に示します。

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

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

{
    "id": "7e382d02-4454-436b-b700-59c7dd77f466",
    "requestType": "UserAdd",
    "requestState": "Submitted",
    "requestStatus": "Accepted",
    "isValidationOnly": false,
    "answers": [
        {
            "@odata.type": "#microsoft.graph.accessPackageAnswerString",
            "value": "Arizona",
            "answeredQuestion": {
                "id": "A714EC6F-4EE0-4614-BD81-37E0C5ECBBFF",
                "isRequired": false,
                "text": {
                    "defaultText": "what state are you from?",
                    "localizedTexts": [
                        {
                            "text": "¿De qué estado eres?",
                            "languageCode": "es"
                        }
                    ]
                },
                "@odata.type": "#microsoft.graph.accessPackageMultipleChoiceQuestion",
                "choices": [
                    {
                        "actualValue": "AZ",
                        "displayValue": {
                            "localizedTexts": [
                                {
                                    "text": "Arizona",
                                    "languageCode": "es"
                                }
                            ]
                        }
                    },
                    {
                        "actualValue": "CA",
                        "displayValue": {
                            "localizedTexts": [
                                {
                                    "text": "California",
                                    "languageCode": "es"
                                }
                            ]
                        }
                    },
                    {
                        "actualValue": "OH",
                        "displayValue": {
                            "localizedTexts": [
                                {
                                    "text": "Ohio",
                                    "languageCode": "es"
                                }
                            ]
                        }
                    }
                ],
                "allowsMultipleSelection": false
            }
        },
        {
            "@odata.type": "#microsoft.graph.accessPackageAnswerString",
            "value": "Need access to marketing campaign material",
            "answeredQuestion": {
                "id": "AA615EE9-D9D8-4C03-BE91-BEE37106DEDA",
                "isRequired": false,
                "text": {
                    "defaultText": "Who is your manager?",
                    "localizedTexts": [
                        {
                            "text": "por qué necesita acceso a este paquete",
                            "languageCode": "es"
                        }
                    ]
                },
                "@odata.type": "#microsoft.graph.accessPackageTextInputQuestion",
                "isSingleLineQuestion": false
            }
        }
    ]
}

例 3: パッケージを要求し、理由を指定する

要求

次の例は、アクセス パッケージを要求し、承認者に正当な理由を提供する方法を示しています。

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

{
    "requestType": "UserAdd",
    "accessPackageAssignment": {
        "accessPackageId": "a914b616-e04e-476b-aa37-91038f0b165b"
    },
    "justification":"Need access to New Hire access package"
}

応答

応答の例を次に示します。

注: 読みやすくするために、ここに示す応答オブジェクトは短縮されている場合があります。実際の呼び出しからは、すべてのプロパティが返されます。

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

{
    "id": "813bbc6b-31f5-4cdf-8fed-1ba4284a1e3f",
    "requestType": "UserAdd",
    "requestState": "Submitted",
    "requestStatus": "Accepted",
    "isValidationOnly": false,
    "expirationDateTime": null,
    "justification": "Requested for the new task.",
    "answers": [],
    "schedule": {
        "startDateTime": null,
        "recurrence": null,
        "expiration": {
            "endDateTime": null,
            "duration": null,
            "type": null
        }
    }
}

例 4: 割り当てを削除する

割り当てを削除するには、次の設定で新しい accessPackageAssignmentRequest オブジェクトを作成します。

  • requestType プロパティの値を .AdminRemove
  • accessPackageAssignment プロパティに、削除する accessPackageAssignment オブジェクトの識別子を持つオブジェクトを含めます。

要求

次の例は、割り当てを削除する方法を示しています。

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

{
    "requestType": "AdminRemove",
    "accessPackageAssignment":{
     "id": "a6bb6942-3ae1-4259-9908-0133aaee9377"
    }
}

応答

応答の例を次に示します。

注: 読みやすくするために、ここに示す応答オブジェクトは短縮されている場合があります。実際の呼び出しからは、すべてのプロパティが返されます。

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

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#accessPackageAssignmentRequests/$entity",

    "id": "78eaee8c-e6cf-48c9-8f99-aae44c35e379",
    "requestType": "AdminRemove",
    "requestState": "Submitted",
    "requestStatus": "Accepted"
}

例 5: 管理がディレクトリにまだいないユーザーの直接割り当てを要求する

要求

管理者がディレクトリに存在しないユーザーに対してユーザーの割り当ての作成を要求している直接割り当ての要求の例を次に示します。 accessPackageId の値は、そのユーザーに必要なアクセス パッケージであり、assignmentPolicyId の値は、そのアクセス パッケージ内の直接割り当てポリシーです。

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

{
  "requestType": "AdminAdd",
  "accessPackageAssignment":{
     "target": {
        "email": "user@contoso.com"
     },
     "assignmentPolicyId":"2264bf65-76ba-417b-a27d-54d291f0cbc8",
     "accessPackageId":"a914b616-e04e-476b-aa37-91038f0b165b"
  }
}

応答

応答の例を次に示します。

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

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

{

  "id": "7e382d02-4454-436b-b700-59c7dd77f466",
  "requestType": "AdminAdd",
  "requestState": "Submitted",
  "requestStatus": "Accepted",
  "isValidationOnly": false
}