次の方法で共有


customAuthenticationExtension を更新する

名前空間: microsoft.graph

重要

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

customAuthenticationExtension オブジェクトのプロパティを更新します。 現在、次の派生型がサポートされています。

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

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

アクセス許可

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

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

重要

職場または学校アカウントを使用する委任されたシナリオでは、管理者にサポートされているMicrosoft Entraロールまたはサポートされているロールのアクセス許可を持つカスタム ロールを割り当てる必要があります。 この操作では、次の最小特権ロールがサポートされています。

  • 認証機能拡張管理者
  • アプリケーション管理者

HTTP 要求

PATCH /identity/customAuthenticationExtensions/{customAuthenticationExtensionId}

要求ヘッダー

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

要求本文

要求本文で、更新するプロパティの値 のみを 指定します。 要求本文に含まれていない既存のプロパティは、以前の値を維持するか、他のプロパティ値の変更に基づいて再計算されます。

次の表に、更新できるプロパティを示します。

customAuthenticationExtension オブジェクトを更新するときは、 プロパティを指定@odata.typeする必要があります。 たとえば、 onTokenIssuanceStartCustomExtension オブジェクト型を更新するには、 プロパティを @odata.type#microsoft.graph.onTokenIssuanceStartCustomExtension設定します。

プロパティ 説明
authenticationConfiguration customExtensionAuthenticationConfiguration このカスタム拡張機能の認証構成。 customCalloutExtension から継承されます。 省略可能。
説明 String カスタム拡張機能の説明。 customCalloutExtension から継承されます。 省略可能。
displayName String カスタム拡張機能の表示名。 customCalloutExtension から継承されます。 省略可能。
handler onAttributeCollectionStartCustomExtensionHandler 条件が満たされたときに呼び出すハンドラー。 onAttributeCollectionStartCustomExtensionListener リスナー型に対して更新できます。
handler onAttributeCollectionSubmitCustomExtensionHandler 条件が満たされたときに呼び出すハンドラー。 onAttributeCollectionSubmitCustomExtensionListener リスナー型に対して更新できます。
endpointConfiguration customExtensionEndpointConfiguration カスタム拡張機能が呼び出す API エンドポイントの構成。 customCalloutExtension から継承されます。 省略可能。

応答

成功した場合、このメソッドは 204 No Content 応答コードを返します。

要求

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

PATCH hhttps://graph.microsoft.com/beta/identity/customAuthenticationExtensions/6fc5012e-7665-43d6-9708-4370863f4e6e
Content-Type: application/json
Content-length: 468

{
    "@odata.type": "#microsoft.graph.onTokenIssuanceStartCustomExtension",
    "displayName": "onTokenIssuanceStartCustomExtension",
    "description": "Fetch additional claims from custom user store",
    "endpointConfiguration": {
        "@odata.type": "#microsoft.graph.httpRequestEndpoint",
        "targetUrl": "https://authenticationeventsAPI.contoso.com"
    },
    "authenticationConfiguration": {
        "@odata.type": "#microsoft.graph.azureAdTokenAuthentication",
        "resourceId": "api://authenticationeventsAPI.contoso.com/a13d0fc1-04ab-4ede-b215-63de0174cbb4"
    },
    "claimsForTokenConfiguration": [
        {
            "claimIdInApiResponse": "DateOfBirth"
        },
        {
            "claimIdInApiResponse": "CustomRoles"
        }
    ]
}

応答

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

HTTP/1.1 204 No Content