New-MgIdentityVerifiedIdProfile

Module:
Microsoft.Graph.Identity.SignIns Module

Create a new verifiedIdProfile object.

Note

To view the beta release of this cmdlet, view New-MgBetaIdentityVerifiedIdProfile

Syntax

CreateExpanded (Default) 

New-MgIdentityVerifiedIdProfile
    [-ResponseHeadersVariable <string>]
    [-AdditionalProperties <hashtable>]
    [-Description <string>]
    [-FaceCheckConfiguration <IMicrosoftGraphFaceCheckConfiguration>]
    [-Id <string>]
    [-LastModifiedDateTime <datetime>]
    [-Name <string>]
    [-Priority <int>]
    [-State <string>]
    [-VerifiedIdProfileConfiguration <IMicrosoftGraphVerifiedIdProfileConfiguration>]
    [-VerifiedIdUsageConfigurations <IMicrosoftGraphVerifiedIdUsageConfiguration[]>]
    [-VerifierDid <string>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Create 

New-MgIdentityVerifiedIdProfile
    -BodyParameter <IMicrosoftGraphVerifiedIdProfile>
    [-ResponseHeadersVariable <string>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Create a new verifiedIdProfile object.

Examples

Example 1: Code snippet


Import-Module Microsoft.Graph.Identity.SignIns

$params = @{
	name = "Contoso Verified ID"
	description = "Contoso Verified Identity"
	lastModifiedDateTime = $null
	state = "enabled"
	verifierDid = "did:web:eu.did-dev.contoso.io"
	priority = 0
	verifiedIdProfileConfiguration = @{
		type = "verifiedIdentity"
		acceptedIssuer = "did:web:eu.did-dev.contoso.io"
		claimBindingSource = "directory"
		claimBindings = @(
			@{
				matchConfidenceLevel = "exact"
				sourceAttribute = "First name"
				verifiedIdClaim = "vc.credentialSubject.firstName"
			}
			@{
				matchConfidenceLevel = "exact"
				sourceAttribute = "Last name"
				verifiedIdClaim = "vc.credentialSubject.lastName"
			}
		)
		claimValidation = @{
			isEnabled = $true
			customExtensionId = "00aa00aa-bb11-cc22-dd33-44ee44ee44ee"
		}
	}
	faceCheckConfiguration = @{
		isEnabled = $true
		sourcePhotoClaimName = "portrait"
	}
	verifiedIdUsageConfigurations = @(
		@{
			isEnabledForTestOnly = $true
			purpose = "recovery"
		}
	)
}

New-MgIdentityVerifiedIdProfile -BodyParameter $params

This example shows how to use the New-MgIdentityVerifiedIdProfile Cmdlet.

Parameters

-AdditionalProperties

Additional Parameters

Parameter properties

Type:System.Collections.Hashtable
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-BodyParameter

verifiedIdProfile To construct, see NOTES section for BODYPARAMETER properties and create a hash table.

Parameter properties

Type:Microsoft.Graph.PowerShell.Models.IMicrosoftGraphVerifiedIdProfile
Supports wildcards:False
DontShow:False

Parameter sets

Create
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Break

Wait for .NET debugger to attach

Parameter properties

Type:System.Management.Automation.SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:System.Management.Automation.SwitchParameter
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Description

Description for the verified ID profile. Required.

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-FaceCheckConfiguration

faceCheckConfiguration To construct, see NOTES section for FACECHECKCONFIGURATION properties and create a hash table.

Parameter properties

Type:Microsoft.Graph.PowerShell.Models.IMicrosoftGraphFaceCheckConfiguration
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Headers

Optional headers that will be added to the request.

Parameter properties

Type:System.Collections.IDictionary
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-HttpPipelineAppend

SendAsync Pipeline Steps to be appended to the front of the pipeline

Parameter properties

Type:

Microsoft.Graph.PowerShell.Runtime.SendAsyncStep[]

Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-HttpPipelinePrepend

SendAsync Pipeline Steps to be prepended to the front of the pipeline

Parameter properties

Type:

Microsoft.Graph.PowerShell.Runtime.SendAsyncStep[]

Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Id

The unique identifier for an entity. Read-only.

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-LastModifiedDateTime

DateTime the profile was last modified. Optional.

Parameter properties

Type:System.DateTime
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

Display name for the verified ID profile. Required.

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Priority

Defines profile processing priority if multiple profiles are configured. Optional.

Parameter properties

Type:System.Int32
Default value:0
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Proxy

The URI for the proxy server to use

Parameter properties

Type:System.Uri
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ProxyCredential

Credentials for a proxy server to use for the remote call

Parameter properties

Type:System.Management.Automation.PSCredential
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ProxyUseDefaultCredentials

Use the default credentials for the proxy

Parameter properties

Type:System.Management.Automation.SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ResponseHeadersVariable

Optional Response Headers Variable.

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False
Aliases:RHV

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-State

verifiedIdProfileState

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-VerifiedIdProfileConfiguration

verifiedIdProfileConfiguration To construct, see NOTES section for VERIFIEDIDPROFILECONFIGURATION properties and create a hash table.

Parameter properties

Type:Microsoft.Graph.PowerShell.Models.IMicrosoftGraphVerifiedIdProfileConfiguration
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-VerifiedIdUsageConfigurations

Collection defining the usage purpose for the profile. Required. To construct, see NOTES section for VERIFIEDIDUSAGECONFIGURATIONS properties and create a hash table.

Parameter properties

Type:

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphVerifiedIdUsageConfiguration[]

Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-VerifierDid

Decentralized Identifier (DID) string that represents the verifier in the verifiable credential exchange. Required.

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Runs the command in a mode that only reports what would happen without performing the actions.

Parameter properties

Type:System.Management.Automation.SwitchParameter
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphVerifiedIdProfile

{{ Fill in the Description }}

System.Collections.IDictionary

{{ Fill in the Description }}

Outputs

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphVerifiedIdProfile

{{ Fill in the Description }}

Notes

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

BODYPARAMETER <IMicrosoftGraphVerifiedIdProfile>: verifiedIdProfile [(Any) <Object>]: This indicates any property can be added to this object. [Id <String>]: The unique identifier for an entity. Read-only. [Description <String>]: Description for the verified ID profile. Required. [FaceCheckConfiguration <IMicrosoftGraphFaceCheckConfiguration>]: faceCheckConfiguration [(Any) <Object>]: This indicates any property can be added to this object. [IsEnabled <Boolean?>]: Defines if Face Check is required. Currently must always be true. [SourcePhotoClaimName <String>]: Source of photo to validate Face Check against. Currently must always be portrait. [LastModifiedDateTime <DateTime?>]: 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 <String>]: verifiedIdProfileState [VerifiedIdProfileConfiguration <IMicrosoftGraphVerifiedIdProfileConfiguration>]: verifiedIdProfileConfiguration [(Any) <Object>]: This indicates any property can be added to this object. [AcceptedIssuer <String>]: Trusted Verified ID issuer. [ClaimBindingSource <String>]: claimBindingSource [ClaimBindings <IMicrosoftGraphClaimBinding[]>]: Claim bindings from Verified ID to source attributes. [MatchConfidenceLevel <String>]: matchConfidenceLevel [SourceAttribute <String>]: Source attribute name from the source system, for example a directory attribute. [VerifiedIdClaim <String>]: Verified ID claim name or path, for example vc.credentialSubject.firstName. [ClaimValidation <IMicrosoftGraphClaimValidation>]: claimValidation [(Any) <Object>]: This indicates any property can be added to this object. [CustomExtensionId <String>]: The identifier of a custom extension for claim validation. [IsEnabled <Boolean?>]: Indicates whether claim validation is enabled. [Type <String>]: Verified ID type. [VerifiedIdUsageConfigurations <IMicrosoftGraphVerifiedIdUsageConfiguration[]>]: Collection defining the usage purpose for the profile. Required. [IsEnabledForTestOnly <Boolean?>]: Sets profile usage for evaluation (test-only) or production. [Purpose <String>]: verifiedIdUsageConfigurationPurpose [VerifierDid <String>]: Decentralized Identifier (DID) string that represents the verifier in the verifiable credential exchange. Required.

FACECHECKCONFIGURATION <IMicrosoftGraphFaceCheckConfiguration>: faceCheckConfiguration [(Any) <Object>]: This indicates any property can be added to this object. [IsEnabled <Boolean?>]: Defines if Face Check is required. Currently must always be true. [SourcePhotoClaimName <String>]: Source of photo to validate Face Check against. Currently must always be portrait.

VERIFIEDIDPROFILECONFIGURATION <IMicrosoftGraphVerifiedIdProfileConfiguration>: verifiedIdProfileConfiguration [(Any) <Object>]: This indicates any property can be added to this object. [AcceptedIssuer <String>]: Trusted Verified ID issuer. [ClaimBindingSource <String>]: claimBindingSource [ClaimBindings <IMicrosoftGraphClaimBinding[]>]: Claim bindings from Verified ID to source attributes. [MatchConfidenceLevel <String>]: matchConfidenceLevel [SourceAttribute <String>]: Source attribute name from the source system, for example a directory attribute. [VerifiedIdClaim <String>]: Verified ID claim name or path, for example vc.credentialSubject.firstName. [ClaimValidation <IMicrosoftGraphClaimValidation>]: claimValidation [(Any) <Object>]: This indicates any property can be added to this object. [CustomExtensionId <String>]: The identifier of a custom extension for claim validation. [IsEnabled <Boolean?>]: Indicates whether claim validation is enabled. [Type <String>]: Verified ID type.

VERIFIEDIDUSAGECONFIGURATIONS <IMicrosoftGraphVerifiedIdUsageConfiguration[]>: Collection defining the usage purpose for the profile. Required. [IsEnabledForTestOnly <Boolean?>]: Sets profile usage for evaluation (test-only) or production. [Purpose <String>]: verifiedIdUsageConfigurationPurpose