openIdConnectIdentityProvider リソースの種類

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

名前空間: microsoft.graph

重要

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

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

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

identityProviderBase から継承します。

メソッド

メソッド	戻り値の型	説明
構成済みの ID プロバイダーを一覧表示する	identityProviderBase コレクション	openIdConnectIdentityProvider オブジェクト型を含む、テナントで構成されているすべての ID プロバイダーを取得します。テナント内の OpenID Connect ID プロバイダーのみを取得する方法はありません。
ID プロバイダーを作成する	openIdConnectIdentityProvider	新しい openIdConnectIdentityProvider オブジェクトをCreateします。
ID プロバイダーを取得する	openIdConnectIdentityProvider	openIdConnectIdentityProvider オブジェクトのプロパティを取得します。
ID プロバイダーを更新する	なし	openIdConnectIdentityProvider オブジェクトを更新します。
ID プロバイダーの削除	なし	openIdConnectIdentityProvider オブジェクトを削除します。
使用可能な ID プロバイダーを一覧表示する	文字列コレクション	テナントで利用可能なすべての ID プロバイダーの種類を取得します。

プロパティ

プロパティ	種類	説明
clientId	文字列	アプリケーションを ID プロバイダーに登録した際に取得したクライアント識別子です。必須です。
clientSecret	String	アプリケーションを ID プロバイダーに登録した際に取得したクライアントシークレットです。 clientSecret は responseType に依存しています。 responseType がの場合、`code`認証コード交換にはシークレットが必要です。 responseType がシークレットの`id_token`場合は、コード交換がないため、必要ありません。 id_tokenは、承認応答から直接返されます。これは、書き込み専用です。読み取り操作を行うと、`****` が返されます。
id	String	ID プロバイダーの識別子。必須。 identityProviderBase から継承されます。読み取り専用です。
displayName	String	ID プロバイダーの表示名。
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 メタデータドキュメントは、常にで終わるエンドポイントにあります `.well-known/openid-configuration`。追加する OpenID Connect ID プロバイダーのメタデータ URL を指定します。読み取り専用です。必須です。
responseMode	openIdConnectResponseMode	応答モードでは、カスタム ID プロバイダーから Azure AD B2C にデータを送信するために使用されるメソッドを定義します。使用可能な値: `form_post`、 `query`。必須です。
responseType	openIdConnectResponseTypes	応答の種類は、カスタム ID プロバイダーのauthorization_endpointへの最初の呼び出しで返される情報の種類を表します。使用可能な値: `code` 、、 `id_tokentoken`。必須です。
スコープ	String	スコープは、カスタム ID プロバイダーから収集する情報とアクセス許可を定義します。 ID プロバイダーから ID トークンを受け取るには、OpenID Connect 要求に openid スコープ値が含まれている必要があります。 ID トークンがないと、ユーザーはカスタム ID プロバイダーを使用して Azure AD B2C にサインインできません。その他のスコープは、スペースで区切って追加できます。スコープの制限事項の詳細については、 RFC6749セクション 3.3 を参照してください。必須です。

openIdConnectResponseMode 値

メンバー	説明
form_post	この応答モードは、最適なセキュリティのために推奨されます。応答は HTTP POST メソッドを介して送信され、コードまたはトークンは、アプリケーション/x-www-form-urlencoded 形式を使用して本文でエンコードされます。
query	コードまたはトークンは、クエリパラメーターとして返されます。
unknownFutureValue	将来の値を示す Sentinel 値。

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 表現は、リソースの種類を示しています。

{
  "@odata.type": "#microsoft.graph.openIdConnectIdentityProvider",
  "id": "String (identifier)",
  "displayName": "String",
  "clientId": "String",
  "clientSecret": "String",
  "scope": "String",
  "metadataUrl": "String",
  "domainHint": "String",
  "responseType": "String",
  "responseMode": "String",
  "claimsMapping": {
    "@odata.type": "microsoft.graph.claimsMapping"
  }
}

次の方法で共有