更新 identityApiConnector

2024-07-16

命名空间：microsoft.graph

全局服务	美国政府 L4	美国政府 L5 (DOD)	由世纪互联运营的中国
✅	❌	❌	✅

权限

为此 API 选择标记为最低特权的权限。只有在应用需要它时，才使用更高的特权权限。有关委派权限和应用程序权限的详细信息，请参阅权限类型。要了解有关这些权限的详细信息，请参阅权限参考。

权限类型	最低特权权限	更高特权权限
委派（工作或学校帐户）	APIConnectors.ReadWrite.All	不可用。
委派（个人 Microsoft 帐户）	不支持。	不支持。
应用程序	APIConnectors.ReadWrite.All	不可用。

重要

在具有工作或学校帐户的委托方案中，必须为登录用户分配受支持的Microsoft Entra角色或具有支持的角色权限的自定义角色。 外部 ID用户流管理员是此操作支持的最低特权角色。

HTTP 请求

PATCH /identity/apiConnectors/{identityApiConnectorId}

请求标头

名称	说明
Authorization	持有者 {token}。必填。详细了解身份验证和授权。
Content-Type	application/json. 必需。

请求正文

在请求正文中，提供 identityApiConnector 对象的 JSON 表示形式。

下表显示了可以更新的 identityApiConnector 的属性。

属性	类型	说明
displayName	String	API 连接器的名称。
targetUrl	String	要调用的 API 终结点的 URL。
authenticationConfiguration	apiAuthenticationConfigurationBase	描述调用 API 的身份验证配置详细信息的对象。仅支持基本身份验证和 PKCS 12 客户端证书。

响应

如果成功，此方法返回 204 No Content 响应代码。

示例

示例 1：更改用于基本身份验证的显示名称、targetUrl 和用户名 & 密码

请求

以下示例显示了一个请求。

PATCH https://graph.microsoft.com/v1.0/identity/apiConnectors/{identityApiConnectorId}
Content-Type: application/json

{
  "displayName": "New Test API",
  "targetUrl": "https://otherapi.com/api/endpoint",
  "authenticationConfiguration": {
    "@odata.type": "microsoft.graph.basicAuthentication",
    "username":"<NEW_USERNAME>", 
    "password":"<NEW_PASSWORD>"
  }
}


// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Models;

var requestBody = new IdentityApiConnector
{
	DisplayName = "New Test API",
	TargetUrl = "https://otherapi.com/api/endpoint",
	AuthenticationConfiguration = new BasicAuthentication
	{
		OdataType = "microsoft.graph.basicAuthentication",
		Username = "<NEW_USERNAME>",
		Password = "<NEW_PASSWORD>",
	},
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Identity.ApiConnectors["{identityApiConnector-id}"].PatchAsync(requestBody);



mgc identity api-connectors patch --identity-api-connector-id {identityApiConnector-id} --body '{\
  "displayName": "New Test API",\
  "targetUrl": "https://otherapi.com/api/endpoint",\
  "authenticationConfiguration": {\
    "@odata.type": "microsoft.graph.basicAuthentication",\
    "username":"<NEW_USERNAME>", \
    "password":"<NEW_PASSWORD>"\
  }\
}\
'



// Code snippets are only available for the latest major version. Current major version is $v1.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  graphmodels "github.com/microsoftgraph/msgraph-sdk-go/models"
	  //other-imports
)

requestBody := graphmodels.NewIdentityApiConnector()
displayName := "New Test API"
requestBody.SetDisplayName(&displayName) 
targetUrl := "https://otherapi.com/api/endpoint"
requestBody.SetTargetUrl(&targetUrl) 
authenticationConfiguration := graphmodels.NewBasicAuthentication()
username := "<NEW_USERNAME>"
authenticationConfiguration.SetUsername(&username) 
password := "<NEW_PASSWORD>"
authenticationConfiguration.SetPassword(&password) 
requestBody.SetAuthenticationConfiguration(authenticationConfiguration)

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
apiConnectors, err := graphClient.Identity().ApiConnectors().ByIdentityApiConnectorId("identityApiConnector-id").Patch(context.Background(), requestBody, nil)


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

IdentityApiConnector identityApiConnector = new IdentityApiConnector();
identityApiConnector.setDisplayName("New Test API");
identityApiConnector.setTargetUrl("https://otherapi.com/api/endpoint");
BasicAuthentication authenticationConfiguration = new BasicAuthentication();
authenticationConfiguration.setOdataType("microsoft.graph.basicAuthentication");
authenticationConfiguration.setUsername("<NEW_USERNAME>");
authenticationConfiguration.setPassword("<NEW_PASSWORD>");
identityApiConnector.setAuthenticationConfiguration(authenticationConfiguration);
IdentityApiConnector result = graphClient.identity().apiConnectors().byIdentityApiConnectorId("{identityApiConnector-id}").patch(identityApiConnector);


const options = {
	authProvider,
};

const client = Client.init(options);

const identityApiConnector = {
  displayName: 'New Test API',
  targetUrl: 'https://otherapi.com/api/endpoint',
  authenticationConfiguration: {
    '@odata.type': 'microsoft.graph.basicAuthentication',
    username: '<NEW_USERNAME>', 
    password: '<NEW_PASSWORD>'
  }
};

await client.api('/identity/apiConnectors/{identityApiConnectorId}')
	.update(identityApiConnector);


<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\IdentityApiConnector;
use Microsoft\Graph\Generated\Models\BasicAuthentication;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new IdentityApiConnector();
$requestBody->setDisplayName('New Test API');
$requestBody->setTargetUrl('https://otherapi.com/api/endpoint');
$authenticationConfiguration = new BasicAuthentication();
$authenticationConfiguration->setOdataType('microsoft.graph.basicAuthentication');
$authenticationConfiguration->setUsername('<NEW_USERNAME>');
$authenticationConfiguration->setPassword('<NEW_PASSWORD>');
$requestBody->setAuthenticationConfiguration($authenticationConfiguration);

$result = $graphServiceClient->identity()->apiConnectors()->byIdentityApiConnectorId('identityApiConnector-id')->patch($requestBody)->wait();


Import-Module Microsoft.Graph.Identity.SignIns

$params = @{
	displayName = "New Test API"
	targetUrl = "https://otherapi.com/api/endpoint"
	authenticationConfiguration = @{
		"@odata.type" = "microsoft.graph.basicAuthentication"
		username = "<NEW_USERNAME>"
		password = "<NEW_PASSWORD>"
	}
}

Update-MgIdentityApiConnector -IdentityApiConnectorId $identityApiConnectorId -BodyParameter $params


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
from msgraph.generated.models.identity_api_connector import IdentityApiConnector
from msgraph.generated.models.basic_authentication import BasicAuthentication
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = IdentityApiConnector(
	display_name = "New Test API",
	target_url = "https://otherapi.com/api/endpoint",
	authentication_configuration = BasicAuthentication(
		odata_type = "microsoft.graph.basicAuthentication",
		username = "<NEW_USERNAME>",
		password = "<NEW_PASSWORD>",
	),
)

result = await graph_client.identity.api_connectors.by_identity_api_connector_id('identityApiConnector-id').patch(request_body)

响应

以下示例显示了相应的响应。

HTTP/1.1 204 No Content

示例 2：更改 API 连接器以使用客户端证书身份验证

这将覆盖任何以前的 authenticationConfiguration 设置。若要从基本身份验证更改为证书身份验证，请使用此方法。若要向证书列表添加其他证书，请使用 Upload 客户端证书方法。使用此方法时，API 连接器 authenticationConfiguration 的后续“获取”或“列出”操作的类型为 microsoft.graph.clientCertificateAuthentication。

请求