Namespace: microsoft.graph
Wichtig
Die APIs unter der /beta Version in Microsoft Graph können sich ändern. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in v1.0 verfügbar ist, verwenden Sie die Version Selektor.
Aktualisieren Sie die angegebene mutualTlsOauthConfiguration-Ressource .
Sie können nur die folgenden beiden Eigenschaften aktualisieren: displayName, certificateAuthority.
Um eine Teilmenge von Objekten in der certificateAuthorities-Auflistung zu aktualisieren, rufen Sie zuerst die vollständige Liste ab, nehmen Sie Ihre Änderungen vor, und stellen Sie dann den gesamten Inhalt der attributliste certificateAuthorities im Anforderungstext erneut bereit. Durch das Ausschließen einer Teilmenge von -Objekten werden diese aus der Auflistung entfernt.
Diese API ist in den folgenden nationalen Cloudbereitstellungen verfügbar.
| Weltweiter Service |
US Government L4 |
US Government L5 (DOD) |
China, betrieben von 21Vianet |
| ✅ |
❌ |
❌ |
❌ |
Berechtigungen
Wählen Sie die Berechtigungen aus, die für diese API als am wenigsten privilegiert markiert sind. Verwenden Sie eine höhere Berechtigung oder Berechtigungen nur, wenn Ihre App dies erfordert. Ausführliche Informationen zu delegierten Berechtigungen und Anwendungsberechtigungen finden Sie unter Berechtigungstypen. Weitere Informationen zu diesen Berechtigungen finden Sie in der Berechtigungsreferenz.
| Berechtigungstyp |
Berechtigungen mit den geringsten Berechtigungen |
Berechtigungen mit höheren Berechtigungen |
| Delegiert (Geschäfts-, Schul- oder Unikonto) |
MutualTlsOauthConfiguration.ReadWrite.All |
Nicht verfügbar. |
| Delegiert (persönliches Microsoft-Konto) |
Nicht unterstützt |
Nicht unterstützt |
| Application |
MutualTlsOauthConfiguration.ReadWrite.All |
Nicht verfügbar. |
Wichtig
In delegierten Szenarien mit Geschäfts-, Schul- oder Unikonten muss dem angemeldeten Benutzer eine unterstützte Microsoft Entra Rolle oder eine benutzerdefinierte Rolle mit einer unterstützten Rollenberechtigung zugewiesen werden. Für diesen Vorgang werden die folgenden Rollen mit den geringsten Berechtigungen unterstützt:
- Cloudgeräteadministrator
- IoT-Geräteadministrator
HTTP-Anforderung
PATCH /directory/certificateAuthorities/mutualTlsOauthConfigurations/{mutualTlsOauthConfigurationId}
Anforderungstext
Geben Sie im Anforderungstext eine JSON-Darstellung des mutualTlsOauthConfiguration-Objekts an .
Sie können die folgenden Eigenschaften angeben, wenn Sie mutualTlsOauthConfiguration aktualisieren.
| Eigenschaft |
Typ |
Beschreibung |
| certificateAuthority |
certificateAuthority-Sammlung |
Mehrwertige Eigenschaft, die eine Liste vertrauenswürdiger Zertifizierungsstellen darstellt. |
| displayName |
Zeichenfolge |
Anzeigename. |
Antwort
Bei erfolgreicher Ausführung gibt die Methode den 200 OK Antwortcode und ein mutualTlsOauthConfiguration-Objekt im Antworttext zurück. Wenn während der Schritte zur Zertifikatüberprüfung ein Validierungsfehler auftritt, gibt die Methode zusammen mit der Fehlermeldung Invalid value specified for property 'certificate' of resource 'CertificateAuthorityInformation'zurück400 Bad Request. Weitere Informationen finden Sie unter Microsoft Graph-Fehlerantworten und -Ressourcentypen.
Beispiele
Beispiel 1: Aktualisieren des Anzeigenamens
Das folgende Beispiel zeigt, wie der Anzeigename eines mutualTlsOauthConfiguration-Objekts von in DoorCamera_Model_X_TrustedCAsTHIS_IS_A_NEW_NAMEaktualisiert wird.
Anforderung
Das folgende Beispiel zeigt eine Anfrage.
PATCH https://graph.microsoft.com/beta/directory/certificateAuthorities/mutualTlsOauthConfigurations/eec5ba11-2fc0-4113-83a2-ed986ed13cdb
Content-Type: application/json
{
"displayName": "THIS_IS_A_NEW_NAME"
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.Models;
var requestBody = new MutualTlsOauthConfiguration
{
DisplayName = "THIS_IS_A_NEW_NAME",
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Directory.CertificateAuthorities.MutualTlsOauthConfigurations["{mutualTlsOauthConfiguration-id}"].PatchAsync(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"
graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
//other-imports
)
requestBody := graphmodels.NewMutualTlsOauthConfiguration()
displayName := "THIS_IS_A_NEW_NAME"
requestBody.SetDisplayName(&displayName)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
mutualTlsOauthConfigurations, err := graphClient.Directory().CertificateAuthorities().MutualTlsOauthConfigurations().ByMutualTlsOauthConfigurationId("mutualTlsOauthConfiguration-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);
MutualTlsOauthConfiguration mutualTlsOauthConfiguration = new MutualTlsOauthConfiguration();
mutualTlsOauthConfiguration.setDisplayName("THIS_IS_A_NEW_NAME");
MutualTlsOauthConfiguration result = graphClient.directory().certificateAuthorities().mutualTlsOauthConfigurations().byMutualTlsOauthConfigurationId("{mutualTlsOauthConfiguration-id}").patch(mutualTlsOauthConfiguration);
const options = {
authProvider,
};
const client = Client.init(options);
const mutualTlsOauthConfiguration = {
displayName: 'THIS_IS_A_NEW_NAME'
};
await client.api('/directory/certificateAuthorities/mutualTlsOauthConfigurations/eec5ba11-2fc0-4113-83a2-ed986ed13cdb')
.version('beta')
.update(mutualTlsOauthConfiguration);
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Models\MutualTlsOauthConfiguration;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new MutualTlsOauthConfiguration();
$requestBody->setDisplayName('THIS_IS_A_NEW_NAME');
$result = $graphServiceClient->directory()->certificateAuthorities()->mutualTlsOauthConfigurations()->byMutualTlsOauthConfigurationId('mutualTlsOauthConfiguration-id')->patch($requestBody)->wait();
Import-Module Microsoft.Graph.Beta.Identity.DirectoryManagement
$params = @{
displayName = "THIS_IS_A_NEW_NAME"
}
Update-MgBetaDirectoryCertificateAuthorityMutualTlOauthConfiguration -MutualTlsOauthConfigurationId $mutualTlsOauthConfigurationId -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.mutual_tls_oauth_configuration import MutualTlsOauthConfiguration
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = MutualTlsOauthConfiguration(
display_name = "THIS_IS_A_NEW_NAME",
)
result = await graph_client.directory.certificate_authorities.mutual_tls_oauth_configurations.by_mutual_tls_oauth_configuration_id('mutualTlsOauthConfiguration-id').patch(request_body)
Antwort
Das folgende Beispiel zeigt die Antwort.
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#directory/certificateAuthorities/mutualTlsOauthConfigurations/$entity",
"id":"eec5ba11-2fc0-4113-83a2-ed986ed13cdb",
"displayName": "THIS_IS_A_NEW_NAME",
"tlsClientAuthParameter": "tls_client_auth_subject_dn",
"certificateAuthorities": [
{
"@odata.type": "microsoft.graph.certificateAuthority"
}
]
}
Beispiel 2: Entfernen eines Zertifikats aus der Liste von certificateAuthorities
In diesem Beispiel wird davon ausgegangen, dass das ursprüngliche gespeicherte Objekt den folgenden Wert aufweist. Beachten Sie, dass die Startressource zwei Werte in der Liste der Zertifizierungsstellen enthält.
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#directory/certificateAuthorities/mutualTlsOauthConfigurations/$entity",
"id": "eec5ba11-2fc0-4113-83a2-ed986ed13cdb",
"displayName": "DoorCamera_Model_X_TrustedCAs",
"tlsClientAuthParameter": "tls_client_auth_subject_dn",
"certificateAuthorities": [
{
"isRootAuthority": true,
"certificateRevocationListUrl": "http://LakeshoreRetail.com/root.crl",
"deltaCertificateRevocationListUrl": null,
"certificate": "joGrWL+Yqkik/CABWG0d1w....",
"issuer": "Lakeshore Retail",
"issuerSubjectkeyIdentifier": "SKI"
},
{
"isRootAuthority": true,
"certificateRevocationListUrl": "http://LakeshoreRetail.com/root.crl",
"deltaCertificateRevocationListUrl": null,
"certificate": "koGrWL+Yqkik/CABWG0d1w....",
"issuer": "Lakeshore Retail",
"issuerSubjectkeyIdentifier": "SKI"
}
]
}
Anforderung
Das folgende Beispiel zeigt eine Anforderung, die die Liste der Zertifizierungsstellen aktualisiert, sodass sie nur ein einzelnes Zertifikat enthält, wodurch das andere entfernt wird.
PATCH https://graph.microsoft.com/beta/directory/certificateAuthorities/mutualTlsOauthConfigurations/00001111-aaaa-2222-bbbb-3333cccc4444
Content-Type: application/json
{
"certificateAuthorities": [
{
"isRootAuthority": true,
"certificateRevocationListUrl": "http://LakeshoreRetail.com/root.crl",
"deltaCertificateRevocationListUrl": null,
"certificate": "Binary",
"issuer": "Lakeshore Retail",
"issuerSubjectkeyIdentifier": "SKI"
}
]
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.Models;
var requestBody = new MutualTlsOauthConfiguration
{
CertificateAuthorities = new List<CertificateAuthority>
{
new CertificateAuthority
{
IsRootAuthority = true,
CertificateRevocationListUrl = "http://LakeshoreRetail.com/root.crl",
DeltaCertificateRevocationListUrl = null,
Certificate = Convert.FromBase64String("Binary"),
Issuer = "Lakeshore Retail",
AdditionalData = new Dictionary<string, object>
{
{
"issuerSubjectkeyIdentifier" , "SKI"
},
},
},
},
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Directory.CertificateAuthorities.MutualTlsOauthConfigurations["{mutualTlsOauthConfiguration-id}"].PatchAsync(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"
graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
//other-imports
)
requestBody := graphmodels.NewMutualTlsOauthConfiguration()
certificateAuthority := graphmodels.NewCertificateAuthority()
isRootAuthority := true
certificateAuthority.SetIsRootAuthority(&isRootAuthority)
certificateRevocationListUrl := "http://LakeshoreRetail.com/root.crl"
certificateAuthority.SetCertificateRevocationListUrl(&certificateRevocationListUrl)
deltaCertificateRevocationListUrl := null
certificateAuthority.SetDeltaCertificateRevocationListUrl(&deltaCertificateRevocationListUrl)
certificate := []byte("binary")
certificateAuthority.SetCertificate(&certificate)
issuer := "Lakeshore Retail"
certificateAuthority.SetIssuer(&issuer)
additionalData := map[string]interface{}{
"issuerSubjectkeyIdentifier" : "SKI",
}
certificateAuthority.SetAdditionalData(additionalData)
certificateAuthorities := []graphmodels.CertificateAuthorityable {
certificateAuthority,
}
requestBody.SetCertificateAuthorities(certificateAuthorities)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
mutualTlsOauthConfigurations, err := graphClient.Directory().CertificateAuthorities().MutualTlsOauthConfigurations().ByMutualTlsOauthConfigurationId("mutualTlsOauthConfiguration-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);
MutualTlsOauthConfiguration mutualTlsOauthConfiguration = new MutualTlsOauthConfiguration();
LinkedList<CertificateAuthority> certificateAuthorities = new LinkedList<CertificateAuthority>();
CertificateAuthority certificateAuthority = new CertificateAuthority();
certificateAuthority.setIsRootAuthority(true);
certificateAuthority.setCertificateRevocationListUrl("http://LakeshoreRetail.com/root.crl");
certificateAuthority.setDeltaCertificateRevocationListUrl(null);
byte[] certificate = Base64.getDecoder().decode("Binary");
certificateAuthority.setCertificate(certificate);
certificateAuthority.setIssuer("Lakeshore Retail");
HashMap<String, Object> additionalData = new HashMap<String, Object>();
additionalData.put("issuerSubjectkeyIdentifier", "SKI");
certificateAuthority.setAdditionalData(additionalData);
certificateAuthorities.add(certificateAuthority);
mutualTlsOauthConfiguration.setCertificateAuthorities(certificateAuthorities);
MutualTlsOauthConfiguration result = graphClient.directory().certificateAuthorities().mutualTlsOauthConfigurations().byMutualTlsOauthConfigurationId("{mutualTlsOauthConfiguration-id}").patch(mutualTlsOauthConfiguration);
const options = {
authProvider,
};
const client = Client.init(options);
const mutualTlsOauthConfiguration = {
certificateAuthorities: [
{
isRootAuthority: true,
certificateRevocationListUrl: 'http://LakeshoreRetail.com/root.crl',
deltaCertificateRevocationListUrl: null,
certificate: 'Binary',
issuer: 'Lakeshore Retail',
issuerSubjectkeyIdentifier: 'SKI'
}
]
};
await client.api('/directory/certificateAuthorities/mutualTlsOauthConfigurations/00001111-aaaa-2222-bbbb-3333cccc4444')
.version('beta')
.update(mutualTlsOauthConfiguration);
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Models\MutualTlsOauthConfiguration;
use Microsoft\Graph\Beta\Generated\Models\CertificateAuthority;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new MutualTlsOauthConfiguration();
$certificateAuthoritiesCertificateAuthority1 = new CertificateAuthority();
$certificateAuthoritiesCertificateAuthority1->setIsRootAuthority(true);
$certificateAuthoritiesCertificateAuthority1->setCertificateRevocationListUrl('http://LakeshoreRetail.com/root.crl');
$certificateAuthoritiesCertificateAuthority1->setDeltaCertificateRevocationListUrl(null);
$certificateAuthoritiesCertificateAuthority1->setCertificate(\GuzzleHttp\Psr7\Utils::streamFor(base64_decode('Binary')));
$certificateAuthoritiesCertificateAuthority1->setIssuer('Lakeshore Retail');
$additionalData = [
'issuerSubjectkeyIdentifier' => 'SKI',
];
$certificateAuthoritiesCertificateAuthority1->setAdditionalData($additionalData);
$certificateAuthoritiesArray []= $certificateAuthoritiesCertificateAuthority1;
$requestBody->setCertificateAuthorities($certificateAuthoritiesArray);
$result = $graphServiceClient->directory()->certificateAuthorities()->mutualTlsOauthConfigurations()->byMutualTlsOauthConfigurationId('mutualTlsOauthConfiguration-id')->patch($requestBody)->wait();
Import-Module Microsoft.Graph.Beta.Identity.DirectoryManagement
$params = @{
certificateAuthorities = @(
@{
isRootAuthority = $true
certificateRevocationListUrl = "http://LakeshoreRetail.com/root.crl"
deltaCertificateRevocationListUrl = $null
certificate = [System.Text.Encoding]::ASCII.GetBytes("Binary")
issuer = "Lakeshore Retail"
issuerSubjectkeyIdentifier = "SKI"
}
)
}
Update-MgBetaDirectoryCertificateAuthorityMutualTlOauthConfiguration -MutualTlsOauthConfigurationId $mutualTlsOauthConfigurationId -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.mutual_tls_oauth_configuration import MutualTlsOauthConfiguration
from msgraph_beta.generated.models.certificate_authority import CertificateAuthority
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = MutualTlsOauthConfiguration(
certificate_authorities = [
CertificateAuthority(
is_root_authority = True,
certificate_revocation_list_url = "http://LakeshoreRetail.com/root.crl",
delta_certificate_revocation_list_url = None,
certificate = base64.urlsafe_b64decode("Binary"),
issuer = "Lakeshore Retail",
additional_data = {
"issuer_subjectkey_identifier" : "SKI",
}
),
],
)
result = await graph_client.directory.certificate_authorities.mutual_tls_oauth_configurations.by_mutual_tls_oauth_configuration_id('mutualTlsOauthConfiguration-id').patch(request_body)
Antwort
Das folgende Beispiel zeigt die Antwort.
HTTP/1.1 200 OK
Location: "https://graph.microsoft.com/beta/directory/certificateAuthorities/mutualTlsOauthConfigurations/00001111-aaaa-2222-bbbb-3333cccc4444"
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#directory/certificateAuthorities/mutualTlsOauthConfigurations/$entity",
"id":"eec5ba11-2fc0-4113-83a2-ed986ed13cdb",
"displayName": "DoorCamera_Model_X_TrustedCAs",
"tlsClientAuthParameter": "tls_client_auth_subject_dn",
"certificateAuthorities": [
{
"isRootAuthority": true,
"certificateRevocationListUrl": "http://LakeshoreRetail.com/root.crl",
"deltaCertificateRevocationListUrl": null,
"certificate": "Binary",
"issuer": "Lakeshore Retail",
"issuerSubjectkeyIdentifier": "SKI"
}
]
}