verified_id_profiles

Creates, updates, deletes, gets or lists a verified_id_profiles resource.

Overview

Name	verified_id_profiles
Type	Resource
Id	entra_id.identity.verified_id_profiles

Fields

The following fields are returned by SELECT queries:

get

Retrieved navigation property

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
name	string	Display name for the verified ID profile. Required.
description	string	Description for the verified ID profile. Required.
faceCheckConfiguration	object	(title: faceCheckConfiguration)
lastModifiedDateTime	string (date-time)	DateTime the profile was last modified. Optional. (pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$)
priority	number (int32)	Defines profile processing priority if multiple profiles are configured. Optional.
state	string	(enabled, disabled, unknownFutureValue) (title: verifiedIdProfileState)
verifiedIdProfileConfiguration	object	(title: verifiedIdProfileConfiguration)
verifiedIdUsageConfigurations	array	Collection defining the usage purpose for the profile. Required.
verifierDid	string	Decentralized Identifier (DID) string that represents the verifier in the verifiable credential exchange. Required.

list

Retrieved collection

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
name	string	Display name for the verified ID profile. Required.
description	string	Description for the verified ID profile. Required.
faceCheckConfiguration	object	(title: faceCheckConfiguration)
lastModifiedDateTime	string (date-time)	DateTime the profile was last modified. Optional. (pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$)
priority	number (int32)	Defines profile processing priority if multiple profiles are configured. Optional.
state	string	(enabled, disabled, unknownFutureValue) (title: verifiedIdProfileState)
verifiedIdProfileConfiguration	object	(title: verifiedIdProfileConfiguration)
verifiedIdUsageConfigurations	array	Collection defining the usage purpose for the profile. Required.
verifierDid	string	Decentralized Identifier (DID) string that represents the verifier in the verifiable credential exchange. Required.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	verified_id_profile_id		Read the properties and relationships of verifiedIdProfile object.
list	select			Get a list of the verifiedIdProfile objects and their properties.
insert	insert			Create a new verifiedIdProfile object.
update	update	verified_id_profile_id		Update the properties of a verifiedIdProfile object.
delete	delete	verified_id_profile_id	If-Match	Delete a verifiedIdProfile object.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
verified_id_profile_id	string	The unique identifier of verifiedIdProfile
If-Match	string	ETag

SELECT examples

get

Read the properties and relationships of verifiedIdProfile object.

SELECT
id,
name,
description,
faceCheckConfiguration,
lastModifiedDateTime,
priority,
state,
verifiedIdProfileConfiguration,
verifiedIdUsageConfigurations,
verifierDid
FROM entra_id.identity.verified_id_profiles
WHERE verified_id_profile_id = '{{ verified_id_profile_id }}' -- required
;

list

Get a list of the verifiedIdProfile objects and their properties.

SELECT
id,
name,
description,
faceCheckConfiguration,
lastModifiedDateTime,
priority,
state,
verifiedIdProfileConfiguration,
verifiedIdUsageConfigurations,
verifierDid
FROM entra_id.identity.verified_id_profiles
;

INSERT examples

insert

Create a new verifiedIdProfile object.

INSERT INTO entra_id.identity.verified_id_profiles (
id,
description,
faceCheckConfiguration,
lastModifiedDateTime,
name,
priority,
state,
verifiedIdProfileConfiguration,
verifiedIdUsageConfigurations,
verifierDid
)
SELECT 
'{{ id }}',
'{{ description }}',
'{{ faceCheckConfiguration }}',
'{{ lastModifiedDateTime }}',
'{{ name }}',
{{ priority }},
'{{ state }}',
'{{ verifiedIdProfileConfiguration }}',
'{{ verifiedIdUsageConfigurations }}',
'{{ verifierDid }}'
RETURNING
id,
name,
description,
faceCheckConfiguration,
lastModifiedDateTime,
priority,
state,
verifiedIdProfileConfiguration,
verifiedIdUsageConfigurations,
verifierDid
;

Manifest

# Description fields are for documentation purposes
- name: verified_id_profiles
props:
  - name: id
    value: "{{ id }}"
    description: |
      The unique identifier for an entity. Read-only.
  - name: description
    value: "{{ description }}"
    description: |
      Description for the verified ID profile. Required.
  - name: faceCheckConfiguration
    value:
      isEnabled: {{ isEnabled }}
      sourcePhotoClaimName: "{{ sourcePhotoClaimName }}"
  - name: lastModifiedDateTime
    value: "{{ lastModifiedDateTime }}"
    description: |
      DateTime the profile was last modified. Optional.
  - name: name
    value: "{{ name }}"
    description: |
      Display name for the verified ID profile. Required.
  - name: priority
    value: {{ priority }}
    description: |
      Defines profile processing priority if multiple profiles are configured. Optional.
  - name: state
    value: "{{ state }}"
    valid_values: ['enabled', 'disabled', 'unknownFutureValue']
  - name: verifiedIdProfileConfiguration
    value:
      acceptedIssuer: "{{ acceptedIssuer }}"
      claimBindings:
        - matchConfidenceLevel: "{{ matchConfidenceLevel }}"
          sourceAttribute: "{{ sourceAttribute }}"
          verifiedIdClaim: "{{ verifiedIdClaim }}"
      claimBindingSource: "{{ claimBindingSource }}"
      claimValidation:
        customExtensionId: "{{ customExtensionId }}"
        isEnabled: {{ isEnabled }}
      type: "{{ type }}"
  - name: verifiedIdUsageConfigurations
    description: |
      Collection defining the usage purpose for the profile. Required.
    value:
      - isEnabledForTestOnly: {{ isEnabledForTestOnly }}
        purpose: "{{ purpose }}"
  - name: verifierDid
    value: "{{ verifierDid }}"
    description: |
      Decentralized Identifier (DID) string that represents the verifier in the verifiable credential exchange. Required.

UPDATE examples

update

Update the properties of a verifiedIdProfile object.

UPDATE entra_id.identity.verified_id_profiles
SET 
id = '{{ id }}',
description = '{{ description }}',
faceCheckConfiguration = '{{ faceCheckConfiguration }}',
lastModifiedDateTime = '{{ lastModifiedDateTime }}',
name = '{{ name }}',
priority = {{ priority }},
state = '{{ state }}',
verifiedIdProfileConfiguration = '{{ verifiedIdProfileConfiguration }}',
verifiedIdUsageConfigurations = '{{ verifiedIdUsageConfigurations }}',
verifierDid = '{{ verifierDid }}'
WHERE 
verified_id_profile_id = '{{ verified_id_profile_id }}' --required
RETURNING
id,
name,
description,
faceCheckConfiguration,
lastModifiedDateTime,
priority,
state,
verifiedIdProfileConfiguration,
verifiedIdUsageConfigurations,
verifierDid;

DELETE examples

delete

Delete a verifiedIdProfile object.

DELETE FROM entra_id.identity.verified_id_profiles
WHERE verified_id_profile_id = '{{ verified_id_profile_id }}' --required
AND If-Match = '{{ If-Match }}'
;