API e modelos de gerenciamento de conexões do SDK dos conectores do Microsoft Graph
A API e os modelos de gerenciamento de conexão dos conectores do Microsoft Graph são chamados durante o processo de criação de conexão do conector personalizado no Centro de administração do Microsoft 365.
APIs de gerenciamento de conexão
| Método | Parâmetros | Tipo de retorno | Descrição |
|---|---|---|---|
| ValidateAuthentication | ValidateAuthenticationRequest | ValidateAuthenticationResponse | Valida as credenciais e o caminho da fonte de dados fornecido pelo administrador na etapa de configurações de conexão. |
| ValidateCustomConfiguration | ValidateCustomConfigurationRequest | ValidateCustomConfigurationResponse | Valida a configuração opcional fornecida pelo administrador na etapa de configuração de conexão. Se nenhuma configuração for necessária para o conector, essa API poderá retornar uma resposta de sucesso. |
| GetDataSourceSchema | GetDataSourceSchemaRequest | GetDataSourceSchemaResponse | Obtém o esquema de fonte de dados em um formato que pode ser compreendido pelo Microsoft Graph. |
Modelos de API de gerenciamento de conexões
As seções a seguir descrevem os modelos de API de gerenciamento de conexões.
ValidateAuthenticationRequest
Modelo de solicitação para validar a solicitação de autenticação para a fonte de dados.
| Propriedade | Tipo | Descrição |
|---|---|---|
| Authenticationdata | Authenticationdata | Contém a URL de acesso à fonte de dados e as credenciais para acessá-la. |
ValidateAuthenticationResponse
Modelo de resposta para validar a resposta de autenticação à fonte de dados.
| Propriedade | Tipo | Descrição |
|---|---|---|
| status | OperationStatus | Mostra o status da operação e detalhes como mensagens de erro. |
| oAuth2ClientCredentialResponse | OAuth2ClientCredentialResponse | Informações de credencial a serem enviadas ao conector durante o rastreamento se o fluxo OAuth for usado (token de acesso, token de atualização e assim por diante, enviado pelo servidor de auth). |
ValidateCustomConfigurationRequest
Solicitar modelo para validar informações de solicitação de configuração personalizadas.
| Propriedade | Tipo | Descrição |
|---|---|---|
| customConfiguration | CustomConfiguration | Fornece dados de configuração para o conector. |
| Authenticationdata | Authenticationdata | Contém a URL de acesso à fonte de dados e as credenciais para acessá-la. |
ValidateCustomConfigurationResponse
Solicitar modelo para validar informações de resposta de configuração personalizadas.
| Propriedade | Tipo | Descrição |
|---|---|---|
| status | OperationStatus | Mostra o status da operação e detalhes, como mensagens de erro. |
GetDataSourceSchemaRequest
Solicite o modelo para obter a solicitação de esquema da fonte de dados.
| Propriedade | Tipo | Descrição |
|---|---|---|
| customConfiguration | CustomConfiguration | Fornece dados de configuração para o conector. |
| Authenticationdata | Authenticationdata | Contém a URL de acesso à fonte de dados e as credenciais para acessá-la. |
GetDataSourceSchemaResponse
Solicite o modelo para obter a resposta de esquema da fonte de dados.
| Propriedade | Tipo | Descrição |
|---|---|---|
| status | OperationStatus | Mostra o status da operação e detalhes, como mensagens de erro. |
| dataSourceSchema | DataSourceSchema | Mostra o esquema de fonte de dados. |