次の方法で共有

oidcIdentityProvider リソースの種類

  • [アーティクル]

名前空間: microsoft.graph

重要

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

Microsoft Entra外部テナントの OpenID Connect ID プロバイダーを表します。

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

identityProviderBase から継承します。

メソッド

なし。

oidcIdentityProvider リソースを管理するための API 操作の一覧については、 identityProviderBase リソースの種類に関するページを参照してください。

プロパティ

プロパティ 型 説明
clientAuthentication oidcClientAuthentication クライアント認証設定。
  • oidcClientSecretAuthentication 派生複合型を使用して、client_secret_post または client_secret_jwt authentication メソッドを使用して ID プロバイダーを設定します。
  • 認証方法を使用して ID プロバイダーを設定するには、 oidcPrivateJwtKeyClientAuthentication 型 private_key_jwt 使用します。

    セキュリティ上の理由から、 client_secret_basic 認証方法はサポートされていません。
    		•
    clientId 文字列 アプリケーションを ID プロバイダーに登録した際に取得したクライアント ID です。
    displayName String ID プロバイダーの表示名。 identityProviderBase から継承されます。
    id String ID プロバイダーの識別子。必須。 identityProviderBase から継承されます。 エンティティから継承します
    inboundClaimMapping oidcInboundClaimMappingOverride OIDC プロバイダーが ID トークンをMicrosoft Entra 外部 IDに送信した後、Microsoft Entra 外部 IDは、受信したトークンからの要求を、Microsoft Entra IDが認識して使用する要求にマップできる必要があります。 この複合型は、そのマッピングをキャプチャします。
    発行者 String 発行者 URI。 発行者 URI は、https スキームを使用した大文字と小文字が区別される URL で、スキーム、ホスト、および必要に応じてポート番号とパス のコンポーネントが含まれており、クエリまたはフラグメント コンポーネントはありません。
    手記：他のMicrosoft Entraテナントを外部 ID プロバイダーとして構成することは現在サポートされていません。 その結果、発行者 URI の microsoftonline.com ドメインは受け入れられない。
    responseType oidcResponseType 応答の種類は、カスタム ID プロバイダーのauthorization_endpointへの最初の呼び出しで返される情報の種類を表します。 使用可能な値:
  • code: 承認コード フローに従って、コードが Entra 外部 IDに返されます。 Entra 外部 IDは、token_endpointを呼び出してトークンのコードを交換します。
  • id_token: ID トークンは、カスタム ID プロバイダーから Entra 外部 IDに返されます。 (現時点では、この値はサポートされていません)。
  • token: アクセス トークンは、カスタム ID プロバイダーから Entra 外部 IDに返されます。 この値は現在サポートされていません。
    		•
    scope String スコープは、カスタム ID プロバイダーから収集する情報とアクセス許可を定義します。
    wellKnownEndpoint String OpenID Connect ID プロバイダーのメタデータ ドキュメントの URL。 すべての OpenID Connect ID プロバイダーは、サインインを実行するために必要なほとんどの情報を含むメタデータ ドキュメントを記述します。 これには、使用する URL やサービスの公開署名キーの場所などの情報が含まれます。 OpenID Connect メタデータ ドキュメントは常に、 .well-known/openid-configurationで終わるエンドポイントにあります。
    手記： メタデータ ドキュメントには、少なくとも、 issuer、 authorization_endpoint、 token_endpoint、 token_endpoint_auth_methods_supported、 response_types_supported、 subject_types_supported 、 jwks_uriの各プロパティが含まれている必要があります。 詳細については、「 OpenID Connect Discovery の仕様」を参照してください。

    リレーションシップ

    なし。

    JSON 表記

    次の JSON 表現は、リソースの種類を示しています。

    {
  "@odata.type": "#microsoft.graph.oidcIdentityProvider",
  "id": "String (identifier)",
  "displayName": "String",
  "supportedTenantTypes": "String",
  "clientId": "String",
  "issuer": "String",
  "wellKnownEndpoint": "String",
  "responseType": "String",
  "scope": "String",
  "clientAuthentication": {
    "@odata.type": "microsoft.graph.oidcClientAuthentication"
  },
  "inboundClaimMapping": {
    "@odata.type": "microsoft.graph.oidcInboundClaimMappingOverride"
  }
}