identityApiConnector リソースの種類

名前空間: microsoft.graph

Microsoft Entra テナント内の API コネクタを表します。

Microsoft Entra 外部 IDセルフサービス サインアップ ユーザー フローで使用される API コネクタを使用すると、ユーザー フローの実行中に API を呼び出すことができます。 API コネクタは、エンドポイント URL と認証を含む API を呼び出すために必要な情報を提供します。 API コネクタは、ユーザー フローの特定の手順で使用して、ユーザー フローの実行に影響を与えることができます。 たとえば、API 応答では、ユーザーのサインアップをブロックしたり、入力検証エラーを表示したり、ユーザーが収集した属性を上書きしたりできます。

b2xIdentityUserFlow API を使用して、外部 ID セルフサービス サインアップ ユーザー フローの API コネクタを使用します。

メソッド

メソッド	戻り値の種類	説明
List	identityApiConnector コレクション	API コネクタの一覧を取得する
Create	identityApiConnector	新しい API コネクタを作成します。
Get	identityApiConnector	identityApiConnector オブジェクトのプロパティを読み取ります。
Update	identityApiConnector	API コネクタのプロパティを更新します。
クライアント証明書のアップロード	identityApiConnector	認証に使用するクライアント証明書をアップロードします。
Delete	なし	API コネクタを削除します。

プロパティ

プロパティ	型	説明
authenticationConfiguration	apiAuthenticationConfigurationBase	API を呼び出すための認証構成の詳細を記述する オブジェクト。 Basic および PKCS 12 クライアント証明書がサポートされています。
displayName	String	API コネクタの名前。
id	String	API コネクタのランダムに生成された識別子。
targetUrl	String	呼び出す API エンドポイントの URL。

リレーションシップ

なし。

JSON 表記

リソースの JSON 表記を次に示します。

{
  "@odata.type": "#microsoft.graph.identityApiConnector",
  "id": "String (identifier)",
  "displayName": "String",
  "targetUrl": "String",
  "authenticationConfiguration": {
    "@odata.type": "microsoft.graph.apiAuthenticationConfigurationBase"
  }
}