名前空間: 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 から継承します。
メソッド
なし。
Open ID Connect プロバイダーを管理するための API 操作のリストについては、 identityProvider を参照してください。
プロパティ
| プロパティ | 型 | 説明 |
|---|---|---|
| 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 | 文字列 | ドメイン ヒントを使用すると、ユーザーが利用可能な ID プロバイダーの一覧から選択する代わりに、指定された ID プロバイダーのサインイン ページに直接スキップできます。 |
| metadataUrl | 文字列 | OpenID Connect ID プロバイダーのメタデータ ドキュメントの URL。 すべての OpenID Connect ID プロバイダーは、サインインの実行に必要な情報のほとんどを含むメタデータ ドキュメントを記述します。 これには、使用する URL やサービスの公開署名キーの場所などの情報が含まれます。 OpenID Connect メタデータドキュメントは、常に welln/openid-configuration で終わるエンドポイントに配置されます。 追加する OpenID Connect ID プロバイダーの場合は、メタデータ URL を指定する必要があります。 これは必須のプロパティであり、作成後は読み取り専用です。 |
| responseMode | openIdConnectResponseMode | 応答モードは、カスタム ID プロバイダーから Azure AD B2C にデータを送り返すために使用する方法を定義します。 次の応答モードを使用できます: form_post、 query。
query 応答モードとは、コードまたはトークンがクエリ パラメーターとして返されることを意味します。
form_post 最適なセキュリティを確保するには、応答モードをお勧めします。 応答は HTTP POST メソッドを介して送信され、コードまたはトークンは application/x-www-form-urlencoded 形式を使用して本文にエンコードされます。 これは必須のプロパティです。 |
| responseType | openIdConnectResponseTypes | 応答の種類は、カスタム ID プロバイダーの authorization_endpoint への最初の呼び出しで、どのような種類の情報が送り返されるかを表します。 次の応答の種類を使用できます: code 、 id_token 、 token。 これは必須のプロパティです。 |
| scope | 文字列 | スコープは、カスタム ID プロバイダーから収集する情報とアクセス許可を定義します。 ID プロバイダーから ID トークンを受信するには、OpenID Connect 要求に openid スコープ値が含まれている必要があります。 ID トークンがないと、ユーザーはカスタム ID プロバイダーを使用して Azure AD B2C にサインインできません。 その他のスコープはスペースで区切って追加できます。 スコープ制限の詳細については、 セクション 3.3 RFC6749を参照してください。 これは必須のプロパティです。 |
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"
}