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 Eigenschaften eines verifiedIdProfile-Objekts .
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) |
VerifiedId-Profile.ReadWrite.All |
Nicht verfügbar. |
| Delegiert (persönliches Microsoft-Konto) |
Nicht unterstützt |
Nicht unterstützt |
| Application |
Nicht unterstützt |
Nicht unterstützt |
Wichtig
Für den delegierten Zugriff mit Geschäfts-, Schul- oder Unikonten muss dem angemeldeten Benutzer eine unterstützte Microsoft Entra-Rolle oder eine benutzerdefinierte Rolle zugewiesen werden, die die für diesen Vorgang erforderlichen Berechtigungen gewährt.
Der Authentifizierungsrichtlinienadministrator ist die Rolle mit den geringsten Berechtigungen, die für diesen Vorgang unterstützt wird.
HTTP-Anforderung
PATCH /identity/verifiedId/profiles/{verifiedIdProfileId}
Anforderungstext
Geben Sie im Anforderungstext nur die Werte für die zu aktualisierenden Eigenschaften an. Vorhandene Eigenschaften, die nicht im Anforderungstext enthalten sind, behalten ihre vorherigen Werte bei oder werden basierend auf Änderungen an anderen Eigenschaftswerten neu berechnet.
In der folgenden Tabelle sind die Eigenschaften angegeben, die aktualisiert werden können.
| Eigenschaft |
Typ |
Beschreibung |
| description |
Zeichenfolge |
Beschreibung des verifizierten ID-Profils. |
| faceCheckConfiguration |
faceCheckConfiguration |
Eigenschaftensatz zum Konfigurieren des Verhaltens der Gesichtsprüfung von Microsoft Entra Verified ID. |
| lastModifiedDateTime |
DateTimeOffset |
Datum und Uhrzeit, wann das Profil zuletzt geändert wurde. |
| mobileDriversLicenseConfiguration |
mobileDriversLicenseConfiguration |
Konfiguration für die Annahme mobiler Führerscheine. |
| name |
Zeichenfolge |
Anzeigename für das verifizierte ID-Profil. |
| Priorität |
Int32 |
Definiert die Priorität der Profilverarbeitung, wenn mehrere Profile konfiguriert sind. |
| selfServiceIssuance |
verifiedIdSelfServiceIssuance |
Konfiguration für die Self-Service-Ausgabe. |
| state |
verifiedIdProfileState |
Aktivierungsstatus für das Profil. Die möglichen Werte sind: enabled, disabled, unknownFutureValue. |
| verifiedIdProfileConfiguration |
verifiedIdProfileConfiguration |
Satz von Eigenschaften, die den akzeptierten Aussteller, die Anspruchsbindung und den Anmeldeinformationstyp angeben. |
| verifiedIdUsageConfigurations |
verifiedIdUsageConfiguration collection |
Sammlung, die den Verwendungszweck des Profils definiert. Mögliche Werte sind: recovery, onboarding, all, unknownFutureValue, verification. Verwenden Sie den Prefer: include-unknown-enum-members Anforderungsheader, um den folgenden Wert aus dieser entwicklungsfähigen Aufzählung zu erhalten: verification. |
| verifierDid |
Zeichenfolge |
Dezentralisierte Identifier (DID-Zeichenfolge), die den Verifizierer im verifizierbaren Anmeldeinformationsaustausch darstellt. |
Antwort
Wenn die Methode erfolgreich verläuft, wird der Antwortcode 204 No Content zurückgegeben.
Beispiele
Anforderung
Das folgende Beispiel zeigt eine Anfrage.
PATCH https://graph.microsoft.com/beta/identity/verifiedId/profiles/ca15ec56-7adf-42ee-847b-00c3008264fb
Content-Type: application/json
{
"verifiedIdProfileConfiguration": {
"methodType": "tenantCustomCredential",
"manifestUrl": "https://verifiedid.contoso.com/manifest"
},
"mobileDriversLicenseConfiguration": {
"acceptedRegions": [
"region-code"
],
"documentStandard": "document-standard"
},
"selfServiceIssuance": {
"isEnabled": true,
"issuanceUrl": "https://verifiedid.contoso.com/issue"
},
"verifiedIdUsageConfigurations": [
{
"isEnabledForTestOnly": false,
"purpose": "verification"
}
]
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.Models;
var requestBody = new VerifiedIdProfile
{
VerifiedIdProfileConfiguration = new VerifiedIdProfileConfiguration
{
MethodType = VerifiedIdMethodType.TenantCustomCredential,
ManifestUrl = "https://verifiedid.contoso.com/manifest",
},
MobileDriversLicenseConfiguration = new MobileDriversLicenseConfiguration
{
AcceptedRegions = new List<string>
{
"region-code",
},
DocumentStandard = "document-standard",
},
SelfServiceIssuance = new VerifiedIdSelfServiceIssuance
{
IsEnabled = true,
IssuanceUrl = "https://verifiedid.contoso.com/issue",
},
VerifiedIdUsageConfigurations = new List<VerifiedIdUsageConfiguration>
{
new VerifiedIdUsageConfiguration
{
IsEnabledForTestOnly = false,
Purpose = VerifiedIdUsageConfigurationPurpose.Verification,
},
},
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Identity.VerifiedId.Profiles["{verifiedIdProfile-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.NewVerifiedIdProfile()
verifiedIdProfileConfiguration := graphmodels.NewVerifiedIdProfileConfiguration()
methodType := graphmodels.TENANTCUSTOMCREDENTIAL_VERIFIEDIDMETHODTYPE
verifiedIdProfileConfiguration.SetMethodType(&methodType)
manifestUrl := "https://verifiedid.contoso.com/manifest"
verifiedIdProfileConfiguration.SetManifestUrl(&manifestUrl)
requestBody.SetVerifiedIdProfileConfiguration(verifiedIdProfileConfiguration)
mobileDriversLicenseConfiguration := graphmodels.NewMobileDriversLicenseConfiguration()
acceptedRegions := []string {
"region-code",
}
mobileDriversLicenseConfiguration.SetAcceptedRegions(acceptedRegions)
documentStandard := "document-standard"
mobileDriversLicenseConfiguration.SetDocumentStandard(&documentStandard)
requestBody.SetMobileDriversLicenseConfiguration(mobileDriversLicenseConfiguration)
selfServiceIssuance := graphmodels.NewVerifiedIdSelfServiceIssuance()
isEnabled := true
selfServiceIssuance.SetIsEnabled(&isEnabled)
issuanceUrl := "https://verifiedid.contoso.com/issue"
selfServiceIssuance.SetIssuanceUrl(&issuanceUrl)
requestBody.SetSelfServiceIssuance(selfServiceIssuance)
verifiedIdUsageConfiguration := graphmodels.NewVerifiedIdUsageConfiguration()
isEnabledForTestOnly := false
verifiedIdUsageConfiguration.SetIsEnabledForTestOnly(&isEnabledForTestOnly)
purpose := graphmodels.VERIFICATION_VERIFIEDIDUSAGECONFIGURATIONPURPOSE
verifiedIdUsageConfiguration.SetPurpose(&purpose)
verifiedIdUsageConfigurations := []graphmodels.VerifiedIdUsageConfigurationable {
verifiedIdUsageConfiguration,
}
requestBody.SetVerifiedIdUsageConfigurations(verifiedIdUsageConfigurations)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
profiles, err := graphClient.Identity().VerifiedId().Profiles().ByVerifiedIdProfileId("verifiedIdProfile-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);
VerifiedIdProfile verifiedIdProfile = new VerifiedIdProfile();
VerifiedIdProfileConfiguration verifiedIdProfileConfiguration = new VerifiedIdProfileConfiguration();
verifiedIdProfileConfiguration.setMethodType(VerifiedIdMethodType.TenantCustomCredential);
verifiedIdProfileConfiguration.setManifestUrl("https://verifiedid.contoso.com/manifest");
verifiedIdProfile.setVerifiedIdProfileConfiguration(verifiedIdProfileConfiguration);
MobileDriversLicenseConfiguration mobileDriversLicenseConfiguration = new MobileDriversLicenseConfiguration();
LinkedList<String> acceptedRegions = new LinkedList<String>();
acceptedRegions.add("region-code");
mobileDriversLicenseConfiguration.setAcceptedRegions(acceptedRegions);
mobileDriversLicenseConfiguration.setDocumentStandard("document-standard");
verifiedIdProfile.setMobileDriversLicenseConfiguration(mobileDriversLicenseConfiguration);
VerifiedIdSelfServiceIssuance selfServiceIssuance = new VerifiedIdSelfServiceIssuance();
selfServiceIssuance.setIsEnabled(true);
selfServiceIssuance.setIssuanceUrl("https://verifiedid.contoso.com/issue");
verifiedIdProfile.setSelfServiceIssuance(selfServiceIssuance);
LinkedList<VerifiedIdUsageConfiguration> verifiedIdUsageConfigurations = new LinkedList<VerifiedIdUsageConfiguration>();
VerifiedIdUsageConfiguration verifiedIdUsageConfiguration = new VerifiedIdUsageConfiguration();
verifiedIdUsageConfiguration.setIsEnabledForTestOnly(false);
verifiedIdUsageConfiguration.setPurpose(VerifiedIdUsageConfigurationPurpose.Verification);
verifiedIdUsageConfigurations.add(verifiedIdUsageConfiguration);
verifiedIdProfile.setVerifiedIdUsageConfigurations(verifiedIdUsageConfigurations);
VerifiedIdProfile result = graphClient.identity().verifiedId().profiles().byVerifiedIdProfileId("{verifiedIdProfile-id}").patch(verifiedIdProfile);
const options = {
authProvider,
};
const client = Client.init(options);
const verifiedIdProfile = {
verifiedIdProfileConfiguration: {
methodType: 'tenantCustomCredential',
manifestUrl: 'https://verifiedid.contoso.com/manifest'
},
mobileDriversLicenseConfiguration: {
acceptedRegions: [
'region-code'
],
documentStandard: 'document-standard'
},
selfServiceIssuance: {
isEnabled: true,
issuanceUrl: 'https://verifiedid.contoso.com/issue'
},
verifiedIdUsageConfigurations: [
{
isEnabledForTestOnly: false,
purpose: 'verification'
}
]
};
await client.api('/identity/verifiedId/profiles/ca15ec56-7adf-42ee-847b-00c3008264fb')
.version('beta')
.update(verifiedIdProfile);
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Models\VerifiedIdProfile;
use Microsoft\Graph\Beta\Generated\Models\VerifiedIdProfileConfiguration;
use Microsoft\Graph\Beta\Generated\Models\VerifiedIdMethodType;
use Microsoft\Graph\Beta\Generated\Models\MobileDriversLicenseConfiguration;
use Microsoft\Graph\Beta\Generated\Models\VerifiedIdSelfServiceIssuance;
use Microsoft\Graph\Beta\Generated\Models\VerifiedIdUsageConfiguration;
use Microsoft\Graph\Beta\Generated\Models\VerifiedIdUsageConfigurationPurpose;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new VerifiedIdProfile();
$verifiedIdProfileConfiguration = new VerifiedIdProfileConfiguration();
$verifiedIdProfileConfiguration->setMethodType(new VerifiedIdMethodType('tenantCustomCredential'));
$verifiedIdProfileConfiguration->setManifestUrl('https://verifiedid.contoso.com/manifest');
$requestBody->setVerifiedIdProfileConfiguration($verifiedIdProfileConfiguration);
$mobileDriversLicenseConfiguration = new MobileDriversLicenseConfiguration();
$mobileDriversLicenseConfiguration->setAcceptedRegions(['region-code', ]);
$mobileDriversLicenseConfiguration->setDocumentStandard('document-standard');
$requestBody->setMobileDriversLicenseConfiguration($mobileDriversLicenseConfiguration);
$selfServiceIssuance = new VerifiedIdSelfServiceIssuance();
$selfServiceIssuance->setIsEnabled(true);
$selfServiceIssuance->setIssuanceUrl('https://verifiedid.contoso.com/issue');
$requestBody->setSelfServiceIssuance($selfServiceIssuance);
$verifiedIdUsageConfigurationsVerifiedIdUsageConfiguration1 = new VerifiedIdUsageConfiguration();
$verifiedIdUsageConfigurationsVerifiedIdUsageConfiguration1->setIsEnabledForTestOnly(false);
$verifiedIdUsageConfigurationsVerifiedIdUsageConfiguration1->setPurpose(new VerifiedIdUsageConfigurationPurpose('verification'));
$verifiedIdUsageConfigurationsArray []= $verifiedIdUsageConfigurationsVerifiedIdUsageConfiguration1;
$requestBody->setVerifiedIdUsageConfigurations($verifiedIdUsageConfigurationsArray);
$result = $graphServiceClient->identity()->verifiedId()->profiles()->byVerifiedIdProfileId('verifiedIdProfile-id')->patch($requestBody)->wait();
Import-Module Microsoft.Graph.Beta.Identity.SignIns
$params = @{
verifiedIdProfileConfiguration = @{
methodType = "tenantCustomCredential"
manifestUrl = "https://verifiedid.contoso.com/manifest"
}
mobileDriversLicenseConfiguration = @{
acceptedRegions = @(
"region-code"
)
documentStandard = "document-standard"
}
selfServiceIssuance = @{
isEnabled = $true
issuanceUrl = "https://verifiedid.contoso.com/issue"
}
verifiedIdUsageConfigurations = @(
@{
isEnabledForTestOnly = $false
purpose = "verification"
}
)
}
Update-MgBetaIdentityVerifiedIdProfile -VerifiedIdProfileId $verifiedIdProfileId -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.verified_id_profile import VerifiedIdProfile
from msgraph_beta.generated.models.verified_id_profile_configuration import VerifiedIdProfileConfiguration
from msgraph_beta.generated.models.verified_id_method_type import VerifiedIdMethodType
from msgraph_beta.generated.models.mobile_drivers_license_configuration import MobileDriversLicenseConfiguration
from msgraph_beta.generated.models.verified_id_self_service_issuance import VerifiedIdSelfServiceIssuance
from msgraph_beta.generated.models.verified_id_usage_configuration import VerifiedIdUsageConfiguration
from msgraph_beta.generated.models.verified_id_usage_configuration_purpose import VerifiedIdUsageConfigurationPurpose
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = VerifiedIdProfile(
verified_id_profile_configuration = VerifiedIdProfileConfiguration(
method_type = VerifiedIdMethodType.TenantCustomCredential,
manifest_url = "https://verifiedid.contoso.com/manifest",
),
mobile_drivers_license_configuration = MobileDriversLicenseConfiguration(
accepted_regions = [
"region-code",
],
document_standard = "document-standard",
),
self_service_issuance = VerifiedIdSelfServiceIssuance(
is_enabled = True,
issuance_url = "https://verifiedid.contoso.com/issue",
),
verified_id_usage_configurations = [
VerifiedIdUsageConfiguration(
is_enabled_for_test_only = False,
purpose = VerifiedIdUsageConfigurationPurpose.Verification,
),
],
)
result = await graph_client.identity.verified_id.profiles.by_verified_id_profile_id('verifiedIdProfile-id').patch(request_body)
Antwort
Das folgende Beispiel zeigt die Antwort.
HTTP/1.1 204 No Content