Espacio de nombres: microsoft.graph.industryData
Importante
Las API de la versión /beta de Microsoft Graph están sujetas a cambios. No se admite el uso de estas API en aplicaciones de producción. Para determinar si una API está disponible en la versión 1.0, use el selector de Versión.
Cree un nuevo objeto oneRosterApiDataConnector .
Esta API está disponible en las siguientes implementaciones nacionales de nube.
| Servicio global |
Gobierno de EE. UU. L4 |
Us Government L5 (DOD) |
China operada por 21Vianet |
| ✅ |
❌ |
❌ |
❌ |
Permissions
Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use un permiso o permisos con privilegios superiores solo si la aplicación lo requiere. Para obtener más información sobre los permisos delegados y de aplicación, consulte Tipos de permisos. Para obtener más información sobre estos permisos, consulte la referencia de permisos.
| Tipo de permiso |
Permisos con privilegios mínimos |
Permisos con privilegios más altos |
| Delegado (cuenta profesional o educativa) |
IndustryData-DataConnector.ReadWrite.All |
No disponible. |
| Delegado (cuenta personal de Microsoft) |
No admitida. |
No admitida. |
| Aplicación |
IndustryData-DataConnector.ReadWrite.All |
No disponible. |
Solicitud HTTP
POST /external/industryData/dataConnectors
| Nombre |
Descripción |
| Authorization |
{token} de portador. Obligatorio. Obtenga más información sobre la autenticación y la autorización. |
| Content-Type |
application/json. Obligatorio. |
Cuerpo de la solicitud
En el cuerpo de la solicitud, proporcione una representación JSON del objeto oneRosterApiDataConnector .
En la tabla siguiente se enumeran las propiedades necesarias y opcionales para crear un objeto oneRosterApiDataConnector .
| Propiedad |
Tipo |
Descripción |
| displayName |
Cadena |
El nombre del conector de datos. Heredado de industryDataConnector. Obligatorio. |
| apiFormat |
microsoft.graph.industryData.apiFormat |
El formato de API del sistema externo al que se está conectando. Se hereda de apiDataConnector. Los valores posibles son: oneRoster, unknownFutureValue. Obligatorio. |
| baseUrl |
Cadena |
El URI base, incluido el esquema, el host y la ruta de acceso, con o sin un '/' final. Por ejemplo, "https://example.com/ims/oneRoster/v1p1". Se hereda de apiDataConnector. Obligatorio. |
| credencial |
microsoft.graph.industryData.credential |
Tipo base para todas las credenciales admitidas. Se hereda de apiDataConnector. Obligatorio. |
| apiVersion |
Cadena |
La versión de API del origen de OneRoster. Obligatorio. |
| isDemographicsEnabled |
Booleano |
Indica si el usuario especificó para importar datos demográficos opcionales. Obligatorio. |
| isFlagsEnabled |
Booleano |
Indica si el usuario especificado para importar datos de marcas opcionales. Obligatorio. |
| isContactsEnabled |
Booleano |
Indica si el usuario especificó para importar datos de contactos opcionales. Obligatorio. |
Respuesta
Si se ejecuta correctamente, este método devuelve un 201 Created código de respuesta y un objeto microsoft.graph.industryData.oneRosterApiDataConnector actualizado en el cuerpo de la respuesta.
Ejemplos
Solicitud
En el ejemplo siguiente se muestra la solicitud.
POST https://graph.microsoft.com/beta/external/industryData/dataConnectors
Content-Type: application/json
{
"@odata.type": "#microsoft.graph.industryData.oneRosterApiDataConnector",
"displayName": "Generic OAuth2 Connector",
"sourceSystem@odata.bind": "https://graph.microsoft.com/beta/external/industryData/sourceSystems('c93a6e02-aeb7-437f-cc52-08dc3fc158af')",
"apiFormat": "oneRoster",
"baseUrl": "https://fakeProvider.net/ims/oneroster/v1p1",
"apiVersion": "1.1",
"credential": {
"@odata.type": "#microsoft.graph.industryData.oAuth2ClientCredential",
"displayName": "One Roster API Credentials",
"clientId": "530be723-6af3-4952-8658-668fb2598ad7",
"clientSecret": "thisIsASecret",
"tokenUrl": "https://login.microsoftonline.com/c27f982b-f7ee-4b8b-bb0e-3c55bd1dc02c/oauth2/token",
"scope": null
},
"isDemographicsEnabled": false,
"isFlagsEnabled": false,
"isContactsEnabled": false
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.Models.IndustryData;
var requestBody = new OneRosterApiDataConnector
{
OdataType = "#microsoft.graph.industryData.oneRosterApiDataConnector",
DisplayName = "Generic OAuth2 Connector",
ApiFormat = ApiFormat.OneRoster,
BaseUrl = "https://fakeProvider.net/ims/oneroster/v1p1",
ApiVersion = "1.1",
Credential = new OAuth2ClientCredential
{
OdataType = "#microsoft.graph.industryData.oAuth2ClientCredential",
DisplayName = "One Roster API Credentials",
ClientId = "530be723-6af3-4952-8658-668fb2598ad7",
ClientSecret = "thisIsASecret",
TokenUrl = "https://login.microsoftonline.com/c27f982b-f7ee-4b8b-bb0e-3c55bd1dc02c/oauth2/token",
Scope = null,
},
IsDemographicsEnabled = false,
IsFlagsEnabled = false,
IsContactsEnabled = false,
AdditionalData = new Dictionary<string, object>
{
{
"sourceSystem@odata.bind" , "https://graph.microsoft.com/beta/external/industryData/sourceSystems('c93a6e02-aeb7-437f-cc52-08dc3fc158af')"
},
},
};
// To initialize your graphClient, see https://dotnet.territoriali.olinfo.it/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.External.IndustryData.DataConnectors.PostAsync(requestBody);
// Code snippets are only available for the latest major version. Current major version is $v0.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
graphmodelsindustrydata "github.com/microsoftgraph/msgraph-beta-sdk-go/models/industrydata"
//other-imports
)
requestBody := graphmodelsindustrydata.NewIndustryDataConnector()
displayName := "Generic OAuth2 Connector"
requestBody.SetDisplayName(&displayName)
apiFormat := graphmodels.ONEROSTER_APIFORMAT
requestBody.SetApiFormat(&apiFormat)
baseUrl := "https://fakeProvider.net/ims/oneroster/v1p1"
requestBody.SetBaseUrl(&baseUrl)
apiVersion := "1.1"
requestBody.SetApiVersion(&apiVersion)
credential := graphmodelsindustrydata.NewOAuth2ClientCredential()
displayName := "One Roster API Credentials"
credential.SetDisplayName(&displayName)
clientId := "530be723-6af3-4952-8658-668fb2598ad7"
credential.SetClientId(&clientId)
clientSecret := "thisIsASecret"
credential.SetClientSecret(&clientSecret)
tokenUrl := "https://login.microsoftonline.com/c27f982b-f7ee-4b8b-bb0e-3c55bd1dc02c/oauth2/token"
credential.SetTokenUrl(&tokenUrl)
scope := null
credential.SetScope(&scope)
requestBody.SetCredential(credential)
isDemographicsEnabled := false
requestBody.SetIsDemographicsEnabled(&isDemographicsEnabled)
isFlagsEnabled := false
requestBody.SetIsFlagsEnabled(&isFlagsEnabled)
isContactsEnabled := false
requestBody.SetIsContactsEnabled(&isContactsEnabled)
additionalData := map[string]interface{}{
"sourceSystem@odata.bind" : "https://graph.microsoft.com/beta/external/industryData/sourceSystems('c93a6e02-aeb7-437f-cc52-08dc3fc158af')",
}
requestBody.SetAdditionalData(additionalData)
// To initialize your graphClient, see https://dotnet.territoriali.olinfo.it/en-us/graph/sdks/create-client?from=snippets&tabs=go
dataConnectors, err := graphClient.External().IndustryData().DataConnectors().Post(context.Background(), requestBody, nil)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
com.microsoft.graph.beta.models.industrydata.OneRosterApiDataConnector industryDataConnector = new com.microsoft.graph.beta.models.industrydata.OneRosterApiDataConnector();
industryDataConnector.setOdataType("#microsoft.graph.industryData.oneRosterApiDataConnector");
industryDataConnector.setDisplayName("Generic OAuth2 Connector");
industryDataConnector.setApiFormat(com.microsoft.graph.beta.models.industrydata.ApiFormat.OneRoster);
industryDataConnector.setBaseUrl("https://fakeProvider.net/ims/oneroster/v1p1");
industryDataConnector.setApiVersion("1.1");
com.microsoft.graph.beta.models.industrydata.OAuth2ClientCredential credential = new com.microsoft.graph.beta.models.industrydata.OAuth2ClientCredential();
credential.setOdataType("#microsoft.graph.industryData.oAuth2ClientCredential");
credential.setDisplayName("One Roster API Credentials");
credential.setClientId("530be723-6af3-4952-8658-668fb2598ad7");
credential.setClientSecret("thisIsASecret");
credential.setTokenUrl("https://login.microsoftonline.com/c27f982b-f7ee-4b8b-bb0e-3c55bd1dc02c/oauth2/token");
credential.setScope(null);
industryDataConnector.setCredential(credential);
industryDataConnector.setIsDemographicsEnabled(false);
industryDataConnector.setIsFlagsEnabled(false);
industryDataConnector.setIsContactsEnabled(false);
HashMap<String, Object> additionalData = new HashMap<String, Object>();
additionalData.put("sourceSystem@odata.bind", "https://graph.microsoft.com/beta/external/industryData/sourceSystems('c93a6e02-aeb7-437f-cc52-08dc3fc158af')");
industryDataConnector.setAdditionalData(additionalData);
com.microsoft.graph.models.industrydata.IndustryDataConnector result = graphClient.external().industryData().dataConnectors().post(industryDataConnector);
const options = {
authProvider,
};
const client = Client.init(options);
const industryDataConnector = {
'@odata.type': '#microsoft.graph.industryData.oneRosterApiDataConnector',
displayName: 'Generic OAuth2 Connector',
'sourceSystem@odata.bind': 'https://graph.microsoft.com/beta/external/industryData/sourceSystems(\'c93a6e02-aeb7-437f-cc52-08dc3fc158af\')',
apiFormat: 'oneRoster',
baseUrl: 'https://fakeProvider.net/ims/oneroster/v1p1',
apiVersion: '1.1',
credential: {
'@odata.type': '#microsoft.graph.industryData.oAuth2ClientCredential',
displayName: 'One Roster API Credentials',
clientId: '530be723-6af3-4952-8658-668fb2598ad7',
clientSecret: 'thisIsASecret',
tokenUrl: 'https://login.microsoftonline.com/c27f982b-f7ee-4b8b-bb0e-3c55bd1dc02c/oauth2/token',
scope: null
},
isDemographicsEnabled: false,
isFlagsEnabled: false,
isContactsEnabled: false
};
await client.api('/external/industryData/dataConnectors')
.version('beta')
.post(industryDataConnector);
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Models\IndustryData\OneRosterApiDataConnector;
use Microsoft\Graph\Beta\Generated\Models\IndustryData\ApiFormat;
use Microsoft\Graph\Beta\Generated\Models\IndustryData\OAuth2ClientCredential;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new OneRosterApiDataConnector();
$requestBody->setOdataType('#microsoft.graph.industryData.oneRosterApiDataConnector');
$requestBody->setDisplayName('Generic OAuth2 Connector');
$requestBody->setApiFormat(new ApiFormat('oneRoster'));
$requestBody->setBaseUrl('https://fakeProvider.net/ims/oneroster/v1p1');
$requestBody->setApiVersion('1.1');
$credential = new OAuth2ClientCredential();
$credential->setOdataType('#microsoft.graph.industryData.oAuth2ClientCredential');
$credential->setDisplayName('One Roster API Credentials');
$credential->setClientId('530be723-6af3-4952-8658-668fb2598ad7');
$credential->setClientSecret('thisIsASecret');
$credential->setTokenUrl('https://login.microsoftonline.com/c27f982b-f7ee-4b8b-bb0e-3c55bd1dc02c/oauth2/token');
$credential->setScope(null);
$requestBody->setCredential($credential);
$requestBody->setIsDemographicsEnabled(false);
$requestBody->setIsFlagsEnabled(false);
$requestBody->setIsContactsEnabled(false);
$additionalData = [
'sourceSystem@odata.bind' => 'https://graph.microsoft.com/beta/external/industryData/sourceSystems(\'c93a6e02-aeb7-437f-cc52-08dc3fc158af\')',
];
$requestBody->setAdditionalData($additionalData);
$result = $graphServiceClient->external()->industryData()->dataConnectors()->post($requestBody)->wait();
Import-Module Microsoft.Graph.Beta.Search
$params = @{
"@odata.type" = "#microsoft.graph.industryData.oneRosterApiDataConnector"
displayName = "Generic OAuth2 Connector"
"sourceSystem@odata.bind" = "https://graph.microsoft.com/beta/external/industryData/sourceSystems('c93a6e02-aeb7-437f-cc52-08dc3fc158af')"
apiFormat = "oneRoster"
baseUrl = "https://fakeProvider.net/ims/oneroster/v1p1"
apiVersion = "1.1"
credential = @{
"@odata.type" = "#microsoft.graph.industryData.oAuth2ClientCredential"
displayName = "One Roster API Credentials"
clientId = "530be723-6af3-4952-8658-668fb2598ad7"
clientSecret = "thisIsASecret"
tokenUrl = "https://login.microsoftonline.com/c27f982b-f7ee-4b8b-bb0e-3c55bd1dc02c/oauth2/token"
scope = $null
}
isDemographicsEnabled = $false
isFlagsEnabled = $false
isContactsEnabled = $false
}
New-MgBetaExternalIndustryDataConnector -BodyParameter $params
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.models.industry_data.one_roster_api_data_connector import OneRosterApiDataConnector
from msgraph_beta.generated.models.api_format import ApiFormat
from msgraph_beta.generated.models.industry_data.o_auth2_client_credential import OAuth2ClientCredential
# To initialize your graph_client, see https://dotnet.territoriali.olinfo.it/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = OneRosterApiDataConnector(
odata_type = "#microsoft.graph.industryData.oneRosterApiDataConnector",
display_name = "Generic OAuth2 Connector",
api_format = ApiFormat.OneRoster,
base_url = "https://fakeProvider.net/ims/oneroster/v1p1",
api_version = "1.1",
credential = OAuth2ClientCredential(
odata_type = "#microsoft.graph.industryData.oAuth2ClientCredential",
display_name = "One Roster API Credentials",
client_id = "530be723-6af3-4952-8658-668fb2598ad7",
client_secret = "thisIsASecret",
token_url = "https://login.microsoftonline.com/c27f982b-f7ee-4b8b-bb0e-3c55bd1dc02c/oauth2/token",
scope = None,
),
is_demographics_enabled = False,
is_flags_enabled = False,
is_contacts_enabled = False,
additional_data = {
"source_system@odata_bind" : "https://graph.microsoft.com/beta/external/industryData/sourceSystems('c93a6e02-aeb7-437f-cc52-08dc3fc158af')",
}
)
result = await graph_client.external.industry_data.data_connectors.post(request_body)
Respuesta
En el ejemplo siguiente se muestra la respuesta.
HTTP/1.1 201 Created
Content-Type: application/json
{
"@odata.type": "#microsoft.graph.industryData.oneRosterApiDataConnector",
"id": "f72b2c92-4b8b-461d-3725-08dc3fc158ff",
"displayName": "Generic OAuth2 Connector",
"apiFormat": "oneRoster",
"baseUrl": "https://fakeProvider.net/ims/oneroster/v1p1",
"apiVersion": "1.1",
"isDemographicsEnabled": false,
"isFlagsEnabled": false,
"isContactsEnabled": false,
"credential": {
"@odata.type": "#microsoft.graph.industryData.oAuth2ClientCredential",
"displayName": "One Roster API Credentials",
"isValid": true,
"lastValidDateTime": null,
"clientId": "530be723-6af3-4952-8658-668fb2598ad7",
"tokenUrl": "https://login.microsoftonline.com/c27f982b-f7ee-4b8b-bb0e-3c55bd1dc02c/oauth2/token",
"scope": null
}
}