Edit

Share via


verifiedIdProfile resource type

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Verified ID profiles defining set of properties and usage patterns.

Inherits from entity.

Methods

Method Return type Description
List verifiedIdProfile collection Get a list of the verifiedIdProfile objects and their properties.
Create verifiedIdProfile Create a new verifiedIdProfile object.
Get verifiedIdProfile Read the properties and relationships of verifiedIdProfile object.
Update verifiedIdProfile Update the properties of a verifiedIdProfile object.
Delete None Delete a verifiedIdProfile object.

Properties

Property Type Description
description String Description for the verified ID profile. Required.
faceCheckConfiguration faceCheckConfiguration Set of properties configuring Entra Verified ID Face Check behavior. Required.
id String Profile identifier. Inherited from entity.
lastModifiedDateTime DateTimeOffset DateTime the profile was last modified. Optional.
name String Display name for the verified ID profile. Required.
priority Int32 Defines profile processing priority if multiple profiles are configured. Optional.
state verifiedIdProfileState Enablement state for the profile. The possible values are: enabled, disabled, unknownFutureValue. Required.
verifierDid String Decentralized Identifier (DID) string that represents the verifier in the verifiable credential exchange. Required.
verifiedIdProfileConfiguration verifiedIdProfileConfiguration Set of properties expressing the accepted issuer, claims binding, and credential type. Required.
verifiedIdUsageConfigurations verifiedIdUsageConfiguration collection Collection defining the usage purpose for the profile. The possible values are: recovery, onboarding, all, unknownFutureValue. Required.

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.verifiedIdProfile",
  "id": "String (identifier)",
  "name": "String",
  "description": "String",
  "lastModifiedDateTime": "String (timestamp)",
  "state": "String",
  "verifierDid": "String",
  "priority": "Integer",
  "verifiedIdProfileConfiguration": {
    "@odata.type": "microsoft.graph.verifiedIdProfileConfiguration"
  },
  "faceCheckConfiguration": {
    "@odata.type": "microsoft.graph.faceCheckConfiguration"
  },
  "verifiedIdUsageConfigurations": [
    {
      "@odata.type": "microsoft.graph.verifiedIdUsageConfiguration"
    }
  ]
}