智能 Microsoft 365 Copilot 副驾驶®连接器 (以前Microsoft Graph 连接器) SDK 协定连接管理 API 和模型,在Microsoft 365 管理中心上创建自定义连接器连接的过程中调用。
连接管理 API
| 方法 | 参数 | 返回类型 | 说明 |
|---|---|---|---|
| ValidateAuthentication | ValidateAuthenticationRequest | ValidateAuthenticationResponse | 验证管理员在连接设置步骤中提供的凭据和数据源路径。 |
| ValidateCustomConfiguration | ValidateCustomConfigurationRequest | ValidateCustomConfigurationResponse | 验证管理员在连接配置步骤中提供的可选配置。 如果连接器不需要配置,则此 API 可以返回成功响应。 |
| GetDataSourceSchema | GetDataSourceSchemaRequest | GetDataSourceSchemaResponse | 获取可通过 Microsoft Graph 理解的格式的数据源架构。 |
连接管理 API 模型
以下部分介绍连接管理 API 模型。
ValidateAuthenticationRequest
用于验证对数据源的身份验证请求的请求模型。
| 属性 | 类型 | 说明 |
|---|---|---|
| authenticationData | AuthenticationData | 保存数据源访问 URL 和用于访问它的凭据。 |
ValidateAuthenticationResponse
用于验证对数据源的身份验证响应的响应模型。
| 属性 | 类型 | 说明 |
|---|---|---|
| status | OperationStatus | 显示作的状态以及错误消息等详细信息。 |
| oAuth2ClientCredentialResponse | OAuth2ClientCredentialResponse | 如果在身份验证服务器) 发送 (访问令牌、刷新令牌等使用 OAuth 流,则爬网期间要发送到连接器的凭据信息。 |
ValidateCustomConfigurationRequest
请求模型以验证自定义配置请求信息。
| 属性 | 类型 | 说明 |
|---|---|---|
| customConfiguration | CustomConfiguration | 提供连接器的配置数据。 |
| authenticationData | AuthenticationData | 保存数据源访问 URL 和用于访问它的凭据。 |
ValidateCustomConfigurationResponse
请求模型以验证自定义配置响应信息。
| 属性 | 类型 | 说明 |
|---|---|---|
| status | OperationStatus | 显示作的状态和详细信息,例如错误消息。 |
GetDataSourceSchemaRequest
请求模型以获取数据源的架构请求。
| 属性 | 类型 | 说明 |
|---|---|---|
| customConfiguration | CustomConfiguration | 提供连接器的配置数据。 |
| authenticationData | AuthenticationData | 保存数据源访问 URL 和用于访问它的凭据。 |
GetDataSourceSchemaResponse
请求模型以获取数据源的架构响应。
| 属性 | 类型 | 说明 |
|---|---|---|
| status | OperationStatus | 显示作的状态和详细信息,例如错误消息。 |
| dataSourceSchema | DataSourceSchema | 显示数据源架构。 |