openIdConnectProvider リソースの種類 (非推奨)

名前空間: microsoft.graph

重要

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

注意事項

この ID プロバイダー API は非推奨であり、2023 年 3 月以降はデータの返送を停止します。 新しい ID プロバイダー API を使用してください。

B2C Connect内の OpenID id プロバイダー Azure Active Directory表します。

B2C テナントで OpenID Connectプロバイダーを構成すると、ユーザーはアプリケーションでカスタム ID プロバイダーを使用してサインアップしてサインインできます。

identityProvider から継承します。

メソッド

メソッド	戻り値の型	説明
List	identityProvider コレクション	テナントで構成されたすべての ID プロバイダーを取得します。
Create	openIdConnectProvider	新しい OpenID id Connect作成します。
Get	openIdConnectProvider	OpenID id プロバイダーのプロパティConnect取得します。
Update	なし	OpenID id プロバイダー Connect更新します。
Delete	なし	Id プロバイダーの OpenID Connect削除します。
利用可能な ID プロバイダーの種類の一覧	文字列コレクション	利用可能なすべての ID プロバイダーの種類を取得します。

プロパティ

プロパティ	型	説明
clientId	文字列	アプリケーションを ID プロバイダーに登録した際に取得したクライアント識別子です。 identityProvider から継承されます。 これは必須プロパティです。
clientSecret	String	アプリケーションを ID プロバイダーに登録した際に取得したクライアント シークレットです。 clientSecret には responseType への依存関係 があります。 responseType が 指定されている code 場合、認証コード交換にはシークレットが必要です。 responseType がシークレットである場合は、コード交換が行えないので、シークレットは必要ありません。承認応答から直接 id_token id_token 返されます。 これは、書き込み専用です。 読み取り操作を行うと、"****" が返されます。 identityProvider から継承されます。
id	String	ID プロバイダーの ID。 必須のプロパティであり、作成後にのみ読み取りされます。
name	String	ID プロバイダーの表示名。 必須のプロパティであり、作成後にのみ読み取りされます。
type	String	ID プロバイダーの型。 この値は、 である必要があります OpenIDConnect 。必須のプロパティであり、作成後にのみ読み取りされます。
claimsMapping	claimsMapping	OIDC プロバイダーが ID トークンを Azure AD に送り返した後、Azure AD は、受け取ったトークンから Azure AD が認識して使用するクレームにクレームをマップできる必要があります。 この複合型は、そのマッピングをキャプチャします。 必須のプロパティです。
domainHint	String	ドメイン ヒントを使用すると、ユーザーが使用可能な ID プロバイダーの一覧から選択するのではなく、指定した ID プロバイダーのサインイン ページに直接スキップできます。
metadataUrl	String	OpenID id プロバイダーのメタデータ ドキュメントConnect URL。 すべての OpenID Connect ID プロバイダーは、サインインの実行に必要なほとんどの情報を含むメタデータ ドキュメントを記述します。 これには、使用する URL やサービスの公開署名キーの場所などの情報が含まれます。 OpenID Connectメタデータ ドキュメントは、.well-known/openid-configuration で終わるエンドポイントに常に格納されます。 追加する OpenID Connect ID プロバイダーの場合は、メタデータ URL を指定する必要があります。 必須のプロパティであり、作成後にのみ読み取りされます。
responseMode	openIdConnectResponseMode	応答モードでは、カスタム ID プロバイダーから Azure ID プロバイダーにデータを B2C に送信するために使用するADします。 次の応答モードを使用 form_post できます。 query query 応答モードは、コードまたはトークンがクエリ パラメーターとして返されるという意味です。 form_post 最適なセキュリティのために応答モードをお勧めします。 応答は HTTP POST メソッドを介して送信され、コードまたはトークンは application/x-www-form-urlencoded 形式を使用して本文でエンコードされます。 必須のプロパティです。
responseType	openIdConnectResponseTypes	応答の種類は、カスタム ID プロバイダーの最初の呼び出しで返される情報の種類authorization_endpoint説明します。 次の応答の種類を使用できます code 。 id_token token 必須のプロパティです。
scope	String	スコープは、カスタム ID プロバイダーから収集する情報とアクセス許可を定義します。 Id プロバイダー Connect ID トークンを受け取るには、OpenID スコープの値を含む必要があります。 ID トークンがない場合、ユーザーはカスタム ID プロバイダーを使用して Azure AD B2C にサインインできます。 他のスコープはスペースで区切って追加できます。 スコープの制限の詳細については 、「RFC6749 セクション 3.3」を参照してください。 必須のプロパティです。

openIdConnectResponseTypes 値

メンバー	説明
code	承認コード フローごとに、コードが Azure または B2C にADされます。 Azure AD B2C は、トークンのコードtoken_endpointを呼び出して呼び出します。
id_token	ID トークンは、カスタム ID プロバイダーから Azure AD B2C に返されます。
token	アクセス トークンは、カスタム ID プロバイダーから Azure AD B2C に返されます。 現在、Azure および B2C ADサポートされていません。

JSON 表記

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

{
  "id": "String",
  "name": "String",
  "type": "String",
  "clientId": "String",
  "clientSecret": "String",
  "claimsMapping": {
      "@odata.type": "#microsoft.graph.claimsMapping",
      "userId": "String",
      "givenName": "String",
      "surname": "String",
      "email": "String",
      "displayName": "String"
  },
  "domainHint": "String",
  "metadataUrl": "String",
  "responseMode": "String",
  "responseType": "String",
  "scope": "String"
}