openIdConnectIdentityProvider リソースの種類
名前空間: microsoft.graph
重要
Microsoft Graph のバージョンの /beta API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 API が v1.0 で使用できるかどうかを確認するには、 バージョン セレクターを使用します。
(Azure Connect) B2C テナント内Azure Active Directory OpenID ADを表します。
Azure AD B2C テナントで OpenID Connect プロバイダーを構成すると、ユーザーはカスタム ID プロバイダーを使用して任意のアプリケーションにサインアップしてサインインできます。
identityProviderBase から継承します。
メソッド
| メソッド | 戻り値の型 | 説明 |
|---|---|---|
| List | identityProviderBase コレクション | openIdConnectIdentityProviderオブジェクトの種類を含む、テナントで構成されているすべての ID プロバイダーを取得します。 テナント内の Id プロバイダーの OpenID Connect取得する方法はありません。 |
| Create | openIdConnectIdentityProvider | 新しい openIdConnectIdentityProvider オブジェクトを作成 します。 |
| Get | openIdConnectIdentityProvider | openIdConnectIdentityProvider オブジェクトのプロパティを取得します。 |
| Update | なし | openIdConnectIdentityProvider オブジェクトを更新します。 |
| Delete | なし | openIdConnectIdentityProvider オブジェクトを削除します。 |
| 利用可能な ID プロバイダーの種類の一覧 | 文字列コレクション | テナントで利用可能なすべての ID プロバイダーの種類を取得します。 |
プロパティ
| プロパティ | 種類 | 説明 |
|---|---|---|
| clientId | String | アプリケーションを ID プロバイダーに登録するときに取得されるアプリケーションのクライアント識別子です。必須。 |
| clientSecret | String | アプリケーションを ID プロバイダーに登録した際に取得したクライアント シークレットです。 clientSecret には responseType への依存関係 があります。
**** が返されます。 |
| id | String | ID プロバイダーの識別子。必須。 identityProviderBase から継承されます。 読み取り専用です。 |
| displayName | String | ID プロバイダーの表示名。 |
| 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 。 追加するユーザー ID プロバイダーの OpenID Connect URL を指定します。 読み取り専用です。 必須です。 |
| responseMode | openIdConnectResponseMode | 応答モードでは、カスタム ID プロバイダーから Azure ID プロバイダーにデータを送信し、B2C AD定義します。 可能な値: form_post , query . 必須です。 |
| responseType | openIdConnectResponseTypes | 応答の種類は、カスタム ID プロバイダーの最初の呼び出しでauthorization_endpointの種類を示します。 可能な値: code id_token 、 、 token 。 必須です。 |
| scope | String | スコープは、カスタム ID プロバイダーから収集する情報とアクセス許可を定義します。 Id プロバイダー Connect ID トークンを受け取るには、OpenID スコープの値を含む必要があります。 ID トークンがない場合、ユーザーはカスタム ID プロバイダーを使用して Azure AD B2C にサインインできます。 他のスコープは、スペースで区切って追加できます。 スコープの制限の詳細については 、「RFC6749 セクション 3.3」を参照してください。 必須です。 |
openIdConnectResponseMode 値
| メンバー | 説明 |
|---|---|
| form_post | この応答モードは、最適なセキュリティを提供する場合にお勧めします。 応答は HTTP POST メソッドを介して送信され、コードまたはトークンは application/x-www-form-urlencoded 形式を使用して本文でエンコードされます。 |
| query | コードまたはトークンはクエリ パラメーターとして返されます。 |
| unknownFutureValue | 将来の値を示すセンチネル値。 |
openIdConnectResponseTypes 値
| メンバー | 説明 |
|---|---|
| code | 承認コード フローごとに、コードが Azure または B2C にADされます。 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"
}
}
フィードバック
フィードバックの送信と表示