名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
カスタム認証拡張機能は、ユーザー認証セッション中の外部システムとの対話式操作を定義します。 これは、次の型が派生する抽象型です。
- onTokenIssuanceStartCustomExtension リソースの種類。
- onAttributeCollectionStartCustomExtension リソースの種類。
- onAttributeCollectionSubmitCustomExtension リソースの種類。
- onOtpSendCustomExtension リソースの種類。
- onPasswordSubmitCustomExtension リソースの種類。
- onVerifiedIdClaimValidationCustomExtension リソースの種類。
customCalloutExtension から継承します。
カスタム認証拡張機能 と、 カスタム クレーム プロバイダーのトークン発行イベントを構成するときにこの API を使用する方法について詳しく説明します。
注:
最大 100 個のカスタム拡張ポリシーを使用できます。
メソッド
| メソッド | 戻り値の種類 | 説明 |
|---|---|---|
| List | customAuthenticationExtension コレクション | customAuthenticationExtension から派生したオブジェクト タイプの一覧を取得します。 |
| Create | customAuthenticationExtension | customAuthenticationExtension から派生した新しいオブジェクト タイプを作成します。 |
| Get | customAuthenticationExtension | customAuthenticationExtension から派生したオブジェクト型のプロパティと関係を読み取ります。 |
| Update | なし | customAuthenticationExtension から派生したオブジェクト タイプのプロパティを更新します。 |
| Delete | なし | customAuthenticationExtension から派生したオブジェクト タイプを削除します。 |
| 認証構成を検証する | authenticationConfigurationValidation | customAuthenticationExtension オブジェクトのエンドポイントと認証構成の有効性を確認します。 |
プロパティ
| プロパティ | 型 | 説明 |
|---|---|---|
| authenticationConfiguration | customExtensionAuthenticationConfiguration | customAuthenticationExtension の認証構成。 customCalloutExtension から継承されます。 |
| behaviorOnError | customExtensionBehaviorOnError | カスタム認証拡張機能のエラー発生時の動作。 |
| clientConfiguration | customExtensionClientConfiguration | customAuthenticationExtension の接続設定。 customCalloutExtension から継承されます。 |
| 説明 | String | customAuthenticationExtension の説明。 customCalloutExtension から継承されます。 |
| displayName | 文字列 | customAuthenticationExtension の表示名。 customCalloutExtension から継承されます。 |
| endpointConfiguration | customExtensionEndpointConfiguration | このカスタム拡張機能が呼び出す HTTP エンドポイント。 customCalloutExtension から継承されます。 |
| id | 文字列 | customAuthenticationExtension の識別子。 エンティティから継承 されます。 |
リレーションシップ
なし。
JSON 表記
次の JSON 表現は、リソースの種類を示しています。
{
"@odata.type": "#microsoft.graph.customAuthenticationExtension",
"id": "String (identifier)",
"authenticationConfiguration": {
"@odata.type": "microsoft.graph.customExtensionAuthenticationConfiguration"
},
"clientConfiguration": {
"@odata.type": "microsoft.graph.customExtensionClientConfiguration"
},
"description": "String",
"displayName": "String",
"endpointConfiguration": {
"@odata.type": "microsoft.graph.customExtensionEndpointConfiguration"
},
"behaviorOnError": {
"@odata.type": "microsoft.graph.customExtensionBehaviorOnError"
}
}