IdentityVerificationProcDef | メタデータ API 開発者ガイド

可能な場合は、Equality の会社の値に一致するように、含めない用語を変更しました。顧客の実装に対する影響を回避するために、一部の用語は変更されていません。

重要

親種別

Metadata メタデータ型を拡張し、その fullName 項目を継承します。

ファイルのサフィックスおよびディレクトリの場所

IdentityVerificationProcDef コンポーネントのサフィックスは .IdentityVerificationProcDef で、IdentityVerificationProcDefs フォルダーに保存されます。

バージョン

IdentityVerificationProcDef コンポーネントは、API バージョン 54.0 以降で使用できます。

特別なアクセスルール

このメタデータ型を使用するには、Health Cloud 権限セットライセンスが必要です。

項目

項目名	説明
identityVerificationProcDtls	項目の型 IdentityVerificationProcDtl[] 説明 ID 検証プロセス詳細要素のリスト。
masterLabel	項目の型 string 説明必須。 ID 検証プロセス定義レコードの表示ラベル。
searchLayoutType	項目の型 IdentityVerificationSearchLayoutType (string 型の列挙) 説明必須。検索コンポーネントの表示レイアウト。有効な値は、次のとおりです。 `Stack` `Tab`

IdentityVerificationProcDtl

検索条件、検証条件、カスタム Apex クラスなどの検証関連の詳細を表します。

項目名	説明
apexClass	項目の型 string 説明外部システムのデータを検索および検証するために使用する Apex クラス。
dataSourceType	項目の型 IdentityVerificationDataSourceType (string 型の列挙) 説明必須。データの取得元種別。有効な値は、次のとおりです。 `External` `Salesforce`
developerName	項目の型 string 説明必須。 ID 検証プロセスの詳細の API 参照名。アンダースコアと英数字のみを使用でき、組織内で一意にする必要があります。最初が文字である、空白を使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。
displayRecordFieldName	項目の型 string 説明本人確認に成功した後に、ユーザーに表示されるレコードについての情報を含む項目の名前。API バージョン 58.0 以降で利用できます。
identityVerificationProcFlds	項目の型 IdentityVerificationProcFld[] 説明 ID 検証プロセス項目要素のリスト。
isActive	項目の型 boolean 説明レコードが有効であるか (`true`)、否か (`false`) を示します。
isRetryAllowedAfterLimit	項目の型 boolean 説明組織内でのみ使用します。
linkedIdVerfProcessDet	項目の型 string 説明リンクされた ID 検証プロセスの詳細を含むレコード。API バージョン 58.0 以降で利用できます。
masterLabel	項目の型 string 説明必須。 ID 検証プロセスの詳細レコードの表示ラベル。
objectName	項目の型 string 説明検索が実行され、データが検証されるオブジェクトの名前。
optionalVerifiersMinVerfCount	項目の型 int 説明確認する必要がある省略可能なベリファイアーの数。
retryLimit	項目の型 int 説明組織内でのみ使用します。
searchFilter	項目の型 string 説明検索範囲を絞り込むために使用する、事前定義済みの検索条件のカンマ区切りリスト。
searchRecordUniqueIdField	項目の型 string 説明検索結果に表示されるレコードの一意の識別子を保存する項目。
searchResultSortBy	項目の型 string 説明検索結果の並べ替えに使用される値。
searchSequenceNumber	項目の型 int 説明必須。検索が実行され、検索結果が表示される順序。
searchType	項目の型 IdentityVerificationSearchType (string 型の列挙) 説明必須。実行される検索の種別。有効な値は、次のとおりです。 `Object-Based` `Text-Based`

IdentityVerificationProcFld

CCA が、通話者に必要な情報を提供する前に、発信者に尋ねる質問を設定するために必要な一連の項目を表します。

項目名	説明
customFieldLabel	項目の型 string 説明検証データを含む項目のカスタム表示ラベル。
dataSourceType	項目の型 IdentityVerificationProcFldDataSourceType (string 型の列挙) 説明必須。データの取得元種別。有効な値は、次のとおりです。 `External` `Salesforce`
developerName	項目の型 string 説明必須。 ID 検証プロセス項目の API 参照名。アンダースコアと英数字のみを使用でき、組織内で一意にする必要があります。最初が文字である、空白を使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。 API バージョン 58.0 以降で利用できます。
fieldDataType	項目の型 IdentityVerificationProcFldFieldDataType (string 型の列挙) 説明 ID 検証プロセスの詳細で定義されている外部データソースの項目のデータ型。API バージョン 58.0 以降で利用できます。有効な値は、次のとおりです。 `address` `checkbox` `currency` `dateonly` `datetime` `email` `number` `other` `percent` `phone` `picklist` `reference` `text` `timeonly` `url`
fieldName	項目の型 string 説明必須。選択した項目のデータ型に基づく検証データを含む項目の表示ラベル。API バージョン 58.0 以降で利用できます。
fieldType	項目の型 IdentityVerificationProcFldFieldType (string 型の列挙) 説明必須。項目の種別を示します。有効な値は、次のとおりです。 `additionalResultField` `optionalVerifier` `requiredVerifier` `resultField` `searchField` `searchFilter`
fieldValueFormula	項目の型 string 説明項目値に適用される数式を保存します。
isActive	項目の型 boolean 説明レコードが有効であるか (`true`)、否か (`false`) を示します。
isManualInput	項目の型 boolean 説明ユーザーが ID 検証の詳細を手動で入力できるか (`true`)、否か (`false`) を示します。この項目のデフォルト値は `false` です。 API バージョン 58.0 以降で利用できます。
masterLabel	項目の型 string 説明必須。 ID 検証プロセス項目のわかりやすい名前。
sequenceNumber	項目の型 int 説明必須。項目の連番。

宣言的なメタデータの定義のサンプル

IdentityVerificationProcDef コンポーネントの例を次に示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<IdentityVerificationProcDef xmlns="http://soap.sforce.com/2006/04/metadata">
3   <identityVerificationProcDtls>
4      <fullName>Sample93AccountSearch</fullName>
5      <dataSourceType>Salesforce</dataSourceType>
6      <developerName>Sample93AccountSearch</developerName>
7      <identityVerificationProcFlds>
8         <fullName>Sample93AccountName</fullName>
9         <dataSourceType>Salesforce</dataSourceType>
10         <developerName>Sample93AccountName</developerName>
11         <fieldName>Name</fieldName>
12         <fieldType>requiredVerifier</fieldType>
13         <isActive>false</isActive>
14         <masterLabel>Sample93 Account Name</masterLabel>
15         <fieldValueFormula>abcd</fieldValueFormula>
16         <customFieldLabel>Name</customFieldLabel>
17         <sequenceNumber>1</sequenceNumber>
18         <isManualInput>false</isManualInput>
19      </identityVerificationProcFlds>
20      <identityVerificationProcFlds>
21         <fullName>Sample93Phone</fullName>
22         <dataSourceType>Salesforce</dataSourceType>
23         <developerName>Sample93Phone</developerName>
24         <fieldName>phone</fieldName>
25         <fieldType>optionalVerifier</fieldType>
26         <isActive>false</isActive>
27         <masterLabel>Sample93 Phone</masterLabel>
28         <sequenceNumber>93</sequenceNumber>
29         <isManualInput>false</isManualInput>
30      </identityVerificationProcFlds>
31      <identityVerificationProcFlds>
32         <fullName>Sample93PostalCode</fullName>
33         <dataSourceType>Salesforce</dataSourceType>
34         <developerName>Sample93PostalCode</developerName>
35         <fieldName>BillingPostalCode</fieldName>
36         <fieldType>optionalVerifier</fieldType>
37         <isActive>true</isActive>
38         <masterLabel>Sample93 Postal Code</masterLabel>
39         <sequenceNumber>4</sequenceNumber>
40         <isManualInput>false</isManualInput>
41      </identityVerificationProcFlds>
42      <identityVerificationProcFlds>
43         <fullName>Sample93Account</fullName>
44         <dataSourceType>Salesforce</dataSourceType>
45         <developerName>Sample93Account</developerName>
46         <fieldName>Name</fieldName>
47         <fieldType>resultField</fieldType>
48         <isActive>false</isActive>
49         <masterLabel>Sample93 Account</masterLabel>
50         <sequenceNumber>1</sequenceNumber>
51         <isManualInput>false</isManualInput>
52      </identityVerificationProcFlds>
53      <isActive>true</isActive>
54      <masterLabel>Sample93 Account Search</masterLabel>
55      <objectName>Account</objectName>
56      <searchRecordUniqueIdField>Id</searchRecordUniqueIdField>
57      <searchSequenceNumber>1</searchSequenceNumber>
58      <searchType>Text-Based</searchType>
59      <searchResultSortBy>Name</searchResultSortBy>
60      <optionalVerifiersMinVerfCount>1</optionalVerifiersMinVerfCount>
61      <isRetryAllowedAfterLimit>false</isRetryAllowedAfterLimit>
62      <retryLimit>5</retryLimit>
63      <searchFilter></searchFilter>
64      <displayRecordFieldName>LastModifiedById</displayRecordFieldName>
65   </identityVerificationProcDtls>
66   <masterLabel>Sample93 Verification Flow</masterLabel>
67   <searchLayoutType>Tab</searchLayoutType>
68</IdentityVerificationProcDef>

前の定義を参照する package.xml の例を次に示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>*</members>
5        <name>IdentityVerificationProcDef</name>
6    </types>
7    <version>54.0</version>
8</Package>

マニフェストファイル内のワイルドカードのサポート

このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。