名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
Azure Active Directory (Azure AD) B2C テナント内の OpenID Connect Azure ID プロバイダーを表します。
Azure AD B2C テナントで OpenID Connect プロバイダーを構成すると、ユーザーはカスタム ID プロバイダーを使用して任意のアプリケーションにサインアップしてサインインできます。
identityProviderBase から継承します。
メソッド
なし。
Azure AD B2C で OpenID Connect ID プロバイダーを管理するための API 操作の一覧については、identityProviderBase リソースの種類に関するページを参照してください。
プロパティ
| プロパティ | 型 | 説明 |
|---|---|---|
| clientId | 文字列 | アプリケーションを ID プロバイダーに登録した際に取得したクライアント識別子です。 必須です。 |
| clientSecret | String | アプリケーションを ID プロバイダーに登録した際に取得したクライアント シークレットです。 clientSecret は responseType に依存します。
**** が返されます。 |
| id | 文字列 | ID プロバイダーの識別子。必須。 identityProviderBase から継承されます。 読み取り専用です。 |
| displayName | String | ID プロバイダーの表示名。 |
| claimsMapping | claimsMapping | OIDC プロバイダーが ID トークンを Microsoft Entra ID に送り返した後、Microsoft Entra ID は、受信したトークンからの要求を、Microsoft Entra ID が認識して使用する要求にマップできる必要があります。 この複合型は、そのマッピングをキャプチャします。 必須です。 |
| domainHint | 文字列 | ドメイン ヒントを使用すると、ユーザーに利用可能な ID プロバイダーの一覧から選択させる代わりに、指定した ID プロバイダーのサインイン ページに直接スキップできます。 |
| metadataUrl | 文字列 | 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_token 、 token。 必須です。 |
| scope | 文字列 | スコープは、カスタム ID プロバイダーから収集する情報とアクセス許可を定義します。 ID プロバイダーから ID トークンを受信するには、OpenID Connect 要求に openid スコープ値が含まれている必要があります。 ID トークンがないと、ユーザーはカスタム ID プロバイダーを使用して Azure AD B2C にサインインできません。 他のスコープは、スペースで区切って追加できます。 スコープ制限の詳細については、 セクション 3.3 RFC6749を参照してください。 必須です。 |
openIdConnectResponseMode 値
| メンバー | 説明 |
|---|---|
| form_post | 最適なセキュリティを得るには、この応答モードをお勧めします。 応答は HTTP POST メソッドを介して送信され、コードまたはトークンは application/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"
}
}