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

[アーティクル]
10/19/2023

名前空間: microsoft.graph

重要

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

注意

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

Azure Active Directory B2C テナント内の OpenID Connect ID プロバイダーを表します。

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

identityProvider から継承します。

メソッド

メソッド	戻り値の型	説明
List	identityProvider コレクション	テナントで構成されたすべての ID プロバイダーを取得します。
Create	openIdConnectProvider	新しい OpenID Connect ID プロバイダーを作成します。
Get	openIdConnectProvider	OpenID Connect ID プロバイダーのプロパティを取得します。
Update	なし	OpenID Connect ID プロバイダーを更新します。
Delete	なし	OpenID Connect ID プロバイダーを削除します。
利用可能な 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 トークンをMicrosoft Entra IDに送信した後、Microsoft Entra IDは、受信したトークンからの要求を、認識して使用する要求Microsoft Entra IDマップできる必要があります。この複合型は、そのマッピングをキャプチャします。これは必須のプロパティです。
domainHint	String	ドメインヒントを使用すると、ユーザーが使用可能な ID プロバイダーの一覧を選択するのではなく、指定した ID プロバイダーのサインインページに直接スキップできます。
metadataUrl	String	OpenID Connect ID プロバイダーのメタデータドキュメントの URL。すべての OpenID Connect ID プロバイダーは、サインインを実行するために必要なほとんどの情報を含むメタデータドキュメントを記述します。これには、使用する URL やサービスの公開署名キーの場所などの情報が含まれます。 OpenID Connect メタデータドキュメントは常に、既知の openid-configuration で終わるエンドポイントにあります。追加する OpenID Connect ID プロバイダーの場合は、メタデータ URL を指定する必要があります。これは必須のプロパティであり、作成後にのみ読み取られます。
responseMode	openIdConnectResponseMode	応答モードでは、カスタム ID プロバイダーから Azure AD B2C にデータを送信するために使用するメソッドを定義します。次の応答モードを使用できます。 `form_postquery` `query` 応答モードは、コードまたはトークンがクエリパラメーターとして返されたことを意味します。 `form_post` 最適なセキュリティを確保するには、応答モードをお勧めします。応答は HTTP POST メソッドを介して送信され、コードまたはトークンは、アプリケーション/x-www-form-urlencoded 形式を使用して本文でエンコードされます。これは必須のプロパティです。
responseType	openIdConnectResponseTypes	応答の種類は、カスタム ID プロバイダーのauthorization_endpointに対する最初の呼び出しで送信される情報の種類を示します。次の応答の種類を使用できます: `code` 、 `id_token` 、 `token`。これは必須のプロパティです。
scope	String	スコープは、カスタム ID プロバイダーから収集する情報とアクセス許可を定義します。 ID プロバイダーから ID トークンを受け取るには、OpenID Connect 要求に openid スコープ値が含まれている必要があります。 ID トークンがないと、ユーザーはカスタム ID プロバイダーを使用して Azure AD B2C にサインインできません。その他のスコープは、スペースで区切って追加できます。スコープの制限事項の詳細については、「 RFC6749セクション 3.3」を参照してください。これは必須のプロパティです。

openIdConnectResponseTypes 値

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

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"
}

次の方法で共有