次の方法で共有


identityProviders を更新する (非推奨)

名前空間: microsoft.graph

重要

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

注意

この ID プロバイダー API は非推奨であり、2023 年 3 月以降はデータの返送を停止します。 新しい ID プロバイダー API を使用してください。

identityProvider オブジェクトのプロパティを更新します。

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

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

アクセス許可

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

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

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

HTTP 要求

PATCH /identityProviders/{id}

要求ヘッダー

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

要求本文

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

identityProvider オブジェクト

プロパティ 説明
clientId String アプリケーションのクライアント ID。 アプリケーションを ID プロバイダーに登録した際に取得したクライアント ID です。
clientSecret String アプリケーションでのクライアント シークレット。 アプリケーションを ID プロバイダーに登録した際に取得したクライアント シークレットです。
name String ID プロバイダーの表示名。
type String ID プロバイダーの型。
    B2B シナリオの場合:
  • Google
  • Facebook
    B2C シナリオの場合:
  • Microsoft
  • Google
  • Amazon
  • LinkedIn
  • Facebook
  • GitHub
  • Twitter
  • Weibo
  • QQ
  • WeChat
  • OpenIDConnect

openIdConnectProvider オブジェクト

プロパティ 説明
clientId String アプリケーションのクライアント ID。 アプリケーションを ID プロバイダーに登録した際に取得したクライアント ID です。
clientSecret String アプリケーションでのクライアント シークレット。 アプリケーションを ID プロバイダーに登録した際に取得したクライアント シークレットです。
name String ID プロバイダーの表示名。
type String ID プロバイダーの型。 値は OpenIdConnectする必要があります。
claimsMapping claimsMapping OIDC プロバイダーが ID トークンを Microsoft Entra ID に送信した後、Microsoft Entra ID は、受信したトークンからの要求を、Microsoft Entra ID が認識して使用する要求にマップできる必要があります。 この複合型は、そのマッピングをキャプチャします。
domainHint String ドメイン ヒントを使用すると、ユーザーが使用可能な ID プロバイダーの一覧を選択するのではなく、指定した ID プロバイダーのサインイン ページに直接スキップできます。
metadataUrl String OpenID Connect ID プロバイダーのメタデータ ドキュメントの URL。
responseMode String カスタム ID プロバイダーから Azure AD B2C にデータを送信するために使用するメソッドを定義します。 次の応答モードを使用できます。
  • form_post : この応答モードは、最適なセキュリティのために推奨されます。 応答は HTTP POST メソッドを介して送信され、コードまたはトークンは、アプリケーション/x-www-form-urlencoded 形式を使用して本文でエンコードされます。
  • query : コードまたはトークンがクエリ パラメーターとして返されます。
responseType String カスタム ID プロバイダーのauthorization_endpointへの最初の呼び出しで返される情報の種類について説明します。 次の応答の種類を使用できます。
  • code : 承認コード フローに従って、コードが Azure AD B2C に返されます。 Azure AD B2C は、token_endpointを呼び出してトークンのコードを交換します。
  • id_token : ID トークンは、カスタム ID プロバイダーから Azure AD B2C に返されます。
  • token : アクセス トークンは、カスタム ID プロバイダーから Azure AD B2C に返されます。 (現時点では、この値は Azure AD B2C ではサポートされていません)
scope String スコープは、カスタム ID プロバイダーから収集する情報とアクセス許可を定義します。

応答

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

例 1: 特定の IDProvider を更新する

要求

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

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

{
  "clientSecret": "1111111111111"
}

応答

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

HTTP/1.1 204 No Content

例 2: 特定の openIDConnectProvider を更新する (Azure AD B2C の場合のみ)

要求

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

PATCH https://graph.microsoft.com/beta/identityProviders/OIDC-V1-MyTest-085a8a0c-58cb-4b6d-8e07-1328ea404e1a
Content-type: application/json

{
  "responseType": "id_token"
}

応答

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

HTTP/1.1 204 No Content