Espacio de nombres: microsoft.graph
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.
Actualizar las propiedades de un objeto verifiedIdProfile .
Esta API está disponible en las siguientes implementaciones en la nube nacional.
| Servicio global |
Administración pública de EE. UU. |
Gobierno de EE. UU. L5 (DOD) |
China operado por 21Vianet |
| ✅ |
❌ |
❌ |
❌ |
Permissions
Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use uno o varios permisos con privilegios más altos 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) |
VerifiedId-Profile.ReadWrite.All |
No disponible. |
| Delegado (cuenta personal de Microsoft) |
No admitida. |
No admitida. |
| Aplicación |
No admitida. |
No admitida. |
Importante
Para el acceso delegado con cuentas profesionales o educativas, el usuario que ha iniciado sesión debe tener asignado un rol compatible de Microsoft Entra o un rol personalizado que conceda los permisos necesarios para esta operación.
El administrador de directivas de autenticación es el rol con privilegios mínimos admitido para esta operación.
Solicitud HTTP
PATCH /identity/verifiedId/profiles/{verifiedIdProfileId}
| Nombre |
Descripción |
| Authorization |
{token} de portador. Obligatorio. Obtenga más información sobre autenticación y autorización. |
| Content-Type |
application/json. Obligatorio. |
Cuerpo de la solicitud
En el cuerpo de la solicitud, proporcione solo los valores de las propiedades que se van a actualizar. Las propiedades existentes que no están incluidas en el cuerpo de la solicitud mantienen sus valores anteriores o se recalculan en función de los cambios realizados en otros valores de propiedad.
En la tabla siguiente se especifican las propiedades que se pueden actualizar.
| Propiedad |
Tipo |
Descripción |
| description |
Cadena |
Descripción del perfil de id. verificado. |
| faceCheckConfiguration |
faceCheckConfiguration |
Conjunto de propiedades que configuran el Id. verificada por Microsoft Entra Comportamiento de Face Check. |
| lastModifiedDateTime |
DateTimeOffset |
Fecha y hora en que se modificó por última vez el perfil. |
| mobileDriversLicenseConfiguration |
mobileDriversLicenseConfiguration |
Configuración para aceptar licencias de conducir móviles. |
| name |
Cadena |
Nombre para mostrar del perfil de id. verificado. |
| prioridad |
Int32 |
Define la prioridad de procesamiento de perfiles si se configuran varios perfiles. |
| selfServiceIssuance |
verifiedIdSelfServiceIssuance |
Configuración para la emisión de autoservicio. |
| state |
verifiedIdProfileState |
Estado de habilitación para el perfil. Los valores posibles son: enabled, disabled, unknownFutureValue. |
| verifiedIdProfileConfiguration |
verifiedIdProfileConfiguration |
Conjunto de propiedades que expresan el emisor aceptado, el enlace de notificaciones y el tipo de credencial. |
| verifiedIdUsageConfigurations |
Colección verifiedIdUsageConfiguration |
Colección que define el propósito de uso del perfil. Los valores posibles son: recovery, onboarding, all, unknownFutureValue, verification. Use el Prefer: include-unknown-enum-members encabezado de solicitud para obtener el siguiente valor de esta enumeración evolutiva: verification. |
| verifierDid |
Cadena |
Cadena de identificador descentralizado (DID) que representa al verificador en el intercambio de credenciales comprobables. |
Respuesta
Si se ejecuta correctamente, este método devuelve un código de respuesta 204 No Content.
Ejemplos
Solicitud
En el ejemplo siguiente se muestra la solicitud.
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)
Respuesta
En el ejemplo siguiente se muestra la respuesta.
HTTP/1.1 204 No Content