Share via


identityProvider を更新する

名前空間: microsoft.graph

重要

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

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

identityProviderBase から派生したプロバイダーの種類のうち、現在、Microsoft Entra IDで socialIdentityProvider リソースを更新できます。 Azure AD B2C では、現在、この操作で socialIdentityProvideropenIdConnectIdentityProvider、または appleManagedIdentityProvider リソースを更新できます。

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

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

アクセス許可

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

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

職場または学校アカウントは、少なくとも外部 ID プロバイダー管理者Microsoft Entraロールに属している必要があります。

HTTP 要求

PATCH /identity/identityProviders/{id}

要求ヘッダー

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

要求本文

要求本文で、テナント内の socialIdentityProvider オブジェクトに対して更新する必要がある 1 つ以上のプロパティMicrosoft Entra JSON オブジェクトを指定します。

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

socialIdentityProvider オブジェクト

プロパティ 説明
clientId 文字列 アプリケーションを ID プロバイダーに登録した際に取得したクライアント識別子です。
clientSecret String アプリケーションが ID プロバイダーに登録された際に取得したクライアント シークレットです。 これは、書き込み専用です。 読み取り操作を行うと、**** が返されます。
displayName String ID プロバイダーの表示名。

openIdConnectIdentityProvider オブジェクト

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

appleManagedIdentityProvider オブジェクト

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

応答

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

例 1: 特定のソーシャル ID プロバイダー (Microsoft Entra IDまたは Azure AD B2C) を更新する

要求

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

PATCH https://graph.microsoft.com/beta/identity/identityProviders/Amazon-OAUTH
Content-type: application/json

{
  "@odata.type": "#microsoft.graph.socialIdentityProvider",
  "clientSecret": "1111111111111"
}

応答

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

HTTP/1.1 204 No Content

例 2: 特定の OpenID Connect ID プロバイダー を更新する (Azure AD B2C の場合のみ)

要求

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

PATCH https://graph.microsoft.com/beta/identity/identityProviders/OIDC-V1-Nam_AD_Test-3e393390-ed2d-4794-97f6-5c999ccc61f7
Content-type: application/json

{
  "@odata.type": "#microsoft.graph.socialIdentityProvider",
  "responseType": "id_token"
}

応答

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

HTTP/1.1 204 No Content

例 3: 特定の Apple ID プロバイダー を更新する (Azure AD B2C の場合のみ)

要求

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

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