acquireAccessToken

命名空间：microsoft.graph

获取 OAuth 访问令牌，以授权 Azure AD 预配服务将用户预配到应用程序中。

权限

调用此 API 需要以下权限之一。 若要了解详细信息，包括如何选择权限的信息，请参阅权限。

权限类型	权限（从最低特权到最高特权）
委派（工作或学校帐户）	Synchronization.ReadWrite.All
委派（个人 Microsoft 帐户）	不支持。
应用程序	Application.ReadWrite.OwnedBy、Synchronization.ReadWrite.All

若要配置应用程序预配或 HR 驱动的预配，还必须为调用用户分配 应用程序管理员 或 云应用程序管理员目录角色。

若要配置 Azure AD 云同步，还必须为调用用户分配 混合标识管理员 目录角色。

HTTP 请求

POST /applications/{applicationsId}/synchronization/acquireAccessToken
POST /servicePrincipals/{servicePrincipalsId}/synchronization/acquireAccessToken

请求标头

名称	说明
Authorization	持有者 {token}。 必填。
Content-Type	application/json. 必需。

请求正文

在请求正文中，提供参数的 JSON 表示形式。

下表显示了可用于此操作的参数。

参数	类型	说明
凭据	synchronizationSecretKeyStringValuePair 集合	表示单个机密值。

响应

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

示例

请求

HTTP

POST https://graph.microsoft.com/beta/applications/{applicationsId}/synchronization/acquireAccessToken
Content-Type: application/json

{
  "credentials": [
    {
      "@odata.type": "microsoft.graph.synchronizationSecretKeyStringValuePair"
    }
  ]
}

C#

var graphClient = new GraphServiceClient(requestAdapter);

var requestBody = new Microsoft.Graph.Beta.Applications.Item.Synchronization.AcquireAccessToken.AcquireAccessTokenPostRequestBody
{
	Credentials = new List<SynchronizationSecretKeyStringValuePair>
	{
		new SynchronizationSecretKeyStringValuePair
		{
			OdataType = "microsoft.graph.synchronizationSecretKeyStringValuePair",
		},
	},
};
await graphClient.Applications["{application-id}"].Synchronization.AcquireAccessToken.PostAsync(requestBody);

重要

默认情况下，Microsoft Graph SDK 使用 v1.0 版本的 API，不支持 beta 版本中提供的所有类型、属性和 API。 有关使用 SDK 访问 beta API 的详细信息，请参阅 将 Microsoft Graph SDK 与 beta API 配合使用。

有关如何 将 SDK 添加到 项目并 创建 authProvider 实例的详细信息，请参阅 SDK 文档。

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const acquireAccessToken = {
  credentials: [
    {
      '@odata.type': 'microsoft.graph.synchronizationSecretKeyStringValuePair'
    }
  ]
};

await client.api('/applications/{applicationsId}/synchronization/acquireAccessToken')
	.version('beta')
	.post(acquireAccessToken);

重要

默认情况下，Microsoft Graph SDK 使用 v1.0 版本的 API，不支持 beta 版本中提供的所有类型、属性和 API。 有关使用 SDK 访问 beta API 的详细信息，请参阅 将 Microsoft Graph SDK 与 beta API 配合使用。

有关如何 将 SDK 添加到 项目并 创建 authProvider 实例的详细信息，请参阅 SDK 文档。

Java

GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

LinkedList<SynchronizationSecretKeyStringValuePair> credentialsList = new LinkedList<SynchronizationSecretKeyStringValuePair>();
SynchronizationSecretKeyStringValuePair credentials = new SynchronizationSecretKeyStringValuePair();

credentialsList.add(credentials);

graphClient.applications("{applicationsId}").synchronization()
	.acquireAccessToken(SynchronizationAcquireAccessTokenParameterSet
		.newBuilder()
		.withCredentials(credentialsList)
		.build())
	.buildRequest()
	.post();

重要

默认情况下，Microsoft Graph SDK 使用 v1.0 版本的 API，不支持 beta 版本中提供的所有类型、属性和 API。 有关使用 SDK 访问 beta API 的详细信息，请参阅 将 Microsoft Graph SDK 与 beta API 配合使用。

有关如何 将 SDK 添加到 项目并 创建 authProvider 实例的详细信息，请参阅 SDK 文档。

转到

//THE GO SDK IS IN PREVIEW. NON-PRODUCTION USE ONLY
graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)

requestBody := graphmodels.NewAcquireAccessTokenPostRequestBody()


synchronizationSecretKeyStringValuePair := graphmodels.NewSynchronizationSecretKeyStringValuePair()

credentials := []graphmodels.SynchronizationSecretKeyStringValuePairable {
	synchronizationSecretKeyStringValuePair,

}
requestBody.SetCredentials(credentials)

graphClient.ApplicationsById("application-id").Synchronization().AcquireAccessToken().Post(context.Background(), requestBody, nil)

重要

默认情况下，Microsoft Graph SDK 使用 v1.0 版本的 API，不支持 beta 版本中提供的所有类型、属性和 API。 有关使用 SDK 访问 beta API 的详细信息，请参阅 将 Microsoft Graph SDK 与 beta API 配合使用。

有关如何 将 SDK 添加到 项目并 创建 authProvider 实例的详细信息，请参阅 SDK 文档。

PowerShell

Import-Module Microsoft.Graph.Applications

$params = @{
	Credentials = @(
		@{
			"@odata.type" = "microsoft.graph.synchronizationSecretKeyStringValuePair"
		}
	)
}

Get-MgApplicationSynchronizationAccessToken -ApplicationId $applicationId -BodyParameter $params

重要

默认情况下，Microsoft Graph SDK 使用 v1.0 版本的 API，不支持 beta 版本中提供的所有类型、属性和 API。 有关使用 SDK 访问 beta API 的详细信息，请参阅 将 Microsoft Graph SDK 与 beta API 配合使用。

有关如何 将 SDK 添加到 项目并 创建 authProvider 实例的详细信息，请参阅 SDK 文档。

PHP

<?php

// THIS SNIPPET IS A PREVIEW FOR THE KIOTA BASED SDK. NON-PRODUCTION USE ONLY
$graphServiceClient = new GraphServiceClient($requestAdapter);

$requestBody = new AcquireAccessTokenPostRequestBody();
$credentialsSynchronizationSecretKeyStringValuePair1 = new SynchronizationSecretKeyStringValuePair();
$credentialsSynchronizationSecretKeyStringValuePair1->set@odatatype('microsoft.graph.synchronizationSecretKeyStringValuePair');


$credentialsArray []= $credentialsSynchronizationSecretKeyStringValuePair1;
$requestBody->setCredentials($credentialsArray);




$graphServiceClient->applicationsById('application-id')->synchronization()->acquireAccessToken()->post($requestBody);

重要

默认情况下，Microsoft Graph SDK 使用 v1.0 版本的 API，不支持 beta 版本中提供的所有类型、属性和 API。 有关使用 SDK 访问 beta API 的详细信息，请参阅 将 Microsoft Graph SDK 与 beta API 配合使用。

有关如何 将 SDK 添加到 项目并 创建 authProvider 实例的详细信息，请参阅 SDK 文档。

响应

注意：为了提高可读性，可能缩短了此处显示的响应对象。

HTTP/1.1 204 No Content