identityApiConnector リソースの種類

名前空間: microsoft.graph

重要

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

Azure Active Directory (Azure Active Directory) (Azure AD) および Azure AD B2C テナントの API コネクタを表します。

Azure AD External Ids セルフサービス サインアップおよび Azure AD B2C サインアップ ユーザー フローで使用される 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 コネクタを削除します。

プロパティ

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

リレーションシップ

なし。

JSON 表記

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

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