identityProvider を更新する

名前空間: microsoft.graph

重要

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

テナントで構成されている指定された外部 ID プロバイダーのプロパティを更新します。

identityProviderBase から派生したプロバイダーの種類のうち、Microsoft Entra では、この操作によって socialIdentityProviderappleManagedIdentityProvider (外部テナントのみ)、または oidcIdentityProvider (外部テナントのみ) リソースを更新できます。

Azure AD B2C では、この操作により、socialIdentityProviderappleManagedIdentityProviderbuiltinIdentityProvider、または openIdConnectIdentityProvider リソースを更新できます。

この API は、次の国内クラウド展開で使用できます。

グローバル サービス 米国政府機関 L4 米国政府機関 L5 (DOD) 21Vianet が運営する中国

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。

アクセス許可の種類 最小特権アクセス許可 より高い特権のアクセス許可
委任 (職場または学校のアカウント) IdentityProvider.ReadWrite.All 注意事項なし。
委任 (個人用 Microsoft アカウント) サポートされていません。 サポートされていません。
アプリケーション IdentityProvider.ReadWrite.All 注意事項なし。

重要

職場または学校アカウントを使用してアクセスを委任するには、サインインしたユーザーに、サポートされている Microsoft Entra ロール、またはこの操作に必要なアクセス許可を付与するカスタム ロールが割り当てられている必要があります。 外部 ID プロバイダー管理者 は、この操作でサポートされる最小特権ロールです。

HTTP 要求

PATCH /identity/identityProviders/{id}

要求ヘッダー

名前 説明
Authorization ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。
Content-Type application/json. 必須です。

要求本文

Microsoft Entra 外部 ID で、socialIdentityProviderappleManagedIdentityProvider または oidcIdentityProvider オブジェクトに対して更新する必要がある 1 つ以上のプロパティを含む要求本文の JSON オブジェクトを指定します。

Azure AD B2C で、socialIdentityProviderappleManagedIdentityProvider、または openIdConnectIdentityProvider オブジェクトに対して更新する必要がある 1 つ以上のプロパティを含む要求本文の JSON オブジェクトを指定します。

socialIdentityProvider オブジェクト

プロパティ 説明
clientId 文字列 アプリケーションを ID プロバイダーに登録した際に取得したクライアント識別子です。
clientSecret String アプリケーションが ID プロバイダーに登録された際に取得したクライアント シークレットです。 これは、書き込み専用です。 読み取り操作を行うと、**** が返されます。
displayName String ID プロバイダーの表示名。
identityProviderType String 外部テナントおよび従業員テナントの場合、可能な値は FacebookGoogle です。
Azure AD B2C テナントの場合、可能な値は MicrosoftGoogleAmazonLinkedInFacebookGitHubTwitterWeiboQQWeChat です。

appleManagedIdentityProvider オブジェクト

プロパティ 説明
certificateData String 証明書からのテキストの長い文字列である証明書データは、null 値である可能性があります。
developerId String Apple の開発者 ID。
displayName String ID プロバイダーの表示名。
keyId String Apple のキー識別子。
serviceId String Apple のサービス ID。

openIdConnectIdentityProvider オブジェクト

プロパティ 説明
claimsMapping claimsMapping OIDC プロバイダーが ID トークンを Microsoft Entra ID に送り返した後、Microsoft Entra ID は、受信したトークンからの要求を、Microsoft Entra ID が認識して使用する要求にマップできる必要があります。 この複合型は、そのマッピングをキャプチャします。
clientId 文字列 アプリケーションを ID プロバイダーに登録した際に取得したクライアント識別子です。
clientSecret String アプリケーションを ID プロバイダーに登録した際に取得したクライアント シークレットです。 clientSecret は responseType に依存します。
  • responseTypecode の場合、認証コードの交換にシークレットが必要です。
  • responseTypeid_tokenの場合認証パイプラインにコード交換がないため、シークレットは必要ありません。 このモードでは、id_tokenは承認応答から直接返されます。
displayName String ID プロバイダーの表示名。
domainHint 文字列 ドメイン ヒントを使用すると、ユーザーが利用可能な ID プロバイダーの一覧から選択する代わりに、指定された ID プロバイダーのサインイン ページに直接スキップできます。
metadataUrl 文字列 OpenID Connect ID プロバイダーのメタデータ ドキュメントの URL。 すべての OpenID Connect ID プロバイダーは、サインインの実行に必要な情報のほとんどを含むメタデータ ドキュメントを記述します。 これには、使用する URL やサービスの公開署名キーの場所などの情報が含まれます。 OpenID Connect メタデータ ドキュメントは、常に .well-known/openid-configuration で終わるエンドポイントに配置されます。 追加する OpenID Connect ID プロバイダーのメタデータ URL を指定します。
responseMode 文字列 応答モードは、カスタム ID プロバイダーから Azure AD B2C にデータを送り返すために使用される方法を定義します。 指定可能な値: form_postquery
responseType 文字列 応答の種類は、カスタム ID プロバイダーのauthorization_endpointへの最初の呼び出しで送信される情報の種類を表します。 指定可能な値: codeid_tokentoken
scope 文字列 Scope は、カスタム ID プロバイダーから収集する情報とアクセス許可を定義します。

oidcIdentityProvider オブジェクト

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

    応答

    成功した場合、このメソッドは 204 No Content 応答コードを返します。 失敗した場合、4xx エラーが詳細情報とともに返されます。

    例 1: ソーシャル ID プロバイダーを更新する

    要求

    次の例は要求を示しています。

    PATCH https://graph.microsoft.com/beta/identity/identityProviders/Amazon-OAUTH
    Content-type: application/json
    
    {
      "@odata.type": "#microsoft.graph.socialIdentityProvider",
      "clientSecret": "4294967296"
    }
    

    応答

    次の例は応答を示しています。

    HTTP/1.1 204 No Content
    

    例 2: Apple ID プロバイダーを更新する

    要求

    次の例は要求を示しています。

    PATCH https://graph.microsoft.com/beta/identity/identityProviders/Apple-Managed-OIDC
    Content-type: application/json
    
    {
      "@odata.type": "#microsoft.graph.socialIdentityProvider",
      "displayName": "Apple"
    }
    

    応答

    次の例は応答を示しています。

    HTTP/1.1 204 No Content
    

    例 3: OpenID Connect ID プロバイダー (Azure AD B2C テナント) の更新

    要求

    次の例は要求を示しています。

    PATCH https://graph.microsoft.com/beta/identity/identityProviders/Contoso-OIDC-00001111-aaaa-2222-bbbb-3333cccc4444
    Content-type: application/json
    
    {
      "@odata.type": "#microsoft.graph.openIdConnectIdentityProvider",
      "responseType": "id_token"
    }
    

    応答

    次の例は応答を示しています。

    HTTP/1.1 204 No Content
    

    例 4: OpenID Connect ID プロバイダー (外部テナント) の更新

    要求

    次の例は要求を示しています。

    PATCH https://graph.microsoft.com/beta/identity/identityProviders/ContosoOIDCIdentityProvider
    Content-type: application/json
    
    {
      "@odata.type": "#microsoft.graph.oidcIdentityProvider",
      "displayName": "Contoso"
    }
    

    応答

    次の例は応答を示しています。

    HTTP/1.1 204 No Content