verifiedIdProfile の作成

名前空間: microsoft.graph

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

新しい verifiedIdProfile オブジェクトを作成します。

この API は、次の国内クラウド展開で使用できます。

グローバル サービス 米国政府機関 L4 米国政府機関 L5 (DOD) 21Vianet が運営する中国
✅ ❌ ❌ ❌

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。

アクセス許可の種類 最小特権アクセス許可 より高い特権のアクセス許可
委任 (職場または学校のアカウント) VerifiedId-Profile.ReadWrite.All 注意事項なし。
委任 (個人用 Microsoft アカウント) サポートされていません。 サポートされていません。
アプリケーション サポートされていません。 サポートされていません。

重要

職場または学校アカウントを使用してアクセスを委任するには、サインインしたユーザーに、サポートされている Microsoft Entra ロール、またはこの操作に必要なアクセス許可を付与するカスタム ロールが割り当てられている必要があります。 認証ポリシー管理者 は、この操作でサポートされる最小特権ロールです。

HTTP 要求

POST /identity/verifiedId/profiles

要求ヘッダー

名前 説明
Authorization ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。
Content-Type application/json. 必須です。

要求本文

リクエストの本文には、 verifiedIdProfile オブジェクトの JSON 表現を指定します。

verifiedIdProfile を作成するときに、次のプロパティを指定できます。

プロパティ 型 説明
description String 検証済み ID プロファイルの説明。 必須です。
faceCheckConfiguration faceCheckConfiguration Face Check Entra Verified ID動作を構成するプロパティ セット。 必須です。
lastModifiedDateTime DateTimeOffset プロファイルが最後に変更された日時。 省略可能。
mobileDriversLicenseConfiguration mobileDriversLicenseConfiguration モバイル運転免許証を受け入れるための構成。 省略可能。
name String 検証済み ID プロファイルの表示名。 必須です。
priority Int32 複数のプロファイルが構成されている場合のプロファイル処理の優先順位を定義します。 省略可能。
selfServiceIssuance verifiedIdSelfServiceIssuance セルフサービス発行の構成。 省略可能。
state verifiedIdProfileState プロファイルの有効化状態。 使用可能な値: enabled、disabled、unknownFutureValue。 必須です。
verifiedIdProfileConfiguration verifiedIdProfileConfiguration 承認された発行者、クレームのバインド、資格情報の種類を表すプロパティのセット。 必須です。
verifiedIdUsageConfigurations verifiedIdUsageConfiguration コレクション プロファイルの使用目的を定義するコレクション。 使用可能な値: recovery、onboarding、all、unknownFutureValue、verification。 Prefer: include-unknown-enum-members 要求ヘッダーを使用して、この進化可能な列挙型から verification という値を取得します。 必須です。
verifierDid 文字列 検証可能な資格情報交換の検証ツールを表す分散識別子 (DID) 文字列。 必須です。

応答

成功した場合、このメソッドは応答本文で 201 Created 応答コードと verifiedIdProfile オブジェクトを返します。

例

要求

次の例は要求を示しています。

POST https://graph.microsoft.com/beta/identity/verifiedId/profiles
Content-Type: application/json

{
  "name": "Contoso Verified ID",
  "description": "Contoso Verified Identity",
  "lastModifiedDateTime": null,
  "state": "enabled",
  "verifierDid": "did:web:eu.did-dev.contoso.io",
  "priority": 0,
  "verifiedIdProfileConfiguration": {
      "methodType": "tenantCustomCredential",
      "type": "verifiedIdentity",
      "manifestUrl": "https://verifiedid.contoso.com/manifest",
      "acceptedIssuer": "did:web:eu.did-dev.contoso.io",
      "claimBindingSource": "directory",
      "claimBindings": [
          {
              "sourceAttribute": "First name",
              "verifiedIdClaim": "vc.credentialSubject.firstName"
          },
          {
              "sourceAttribute": "Last name",
              "verifiedIdClaim": "vc.credentialSubject.lastName"
          }
      ]
  },
  "faceCheckConfiguration": {
      "isEnabled": true,
      "sourcePhotoClaimName": "portrait"
  },
  "mobileDriversLicenseConfiguration": {
      "acceptedRegions": [
          "region-code"
      ],
      "documentStandard": "document-standard"
  },
  "verifiedIdUsageConfigurations": [
      {
          "isEnabledForTestOnly": true,
          "purpose": "verification"
      }
  ],
  "selfServiceIssuance": {
      "isEnabled": true,
      "issuanceUrl": "https://verifiedid.contoso.com/issue"
  }
}

応答

次の例は応答を示しています。

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

HTTP/1.1 201 Created
Content-Type: application/json

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#identity/verifiedId/profiles/$entity",
    "id": "ca15ec56-7adf-42ee-847b-00c3008264fb",
    "name": "Contoso Verified ID",
    "description": "Contoso Verified ID",
    "lastModifiedDateTime": null,
    "state": "enabled",
    "verifierDid": "did:web:eu.did-dev.contoso.io",
    "priority": 0,
    "verifiedIdProfileConfiguration": {
        "methodType": "tenantCustomCredential",
        "type": "verifiedIdentity",
        "manifestUrl": "https://verifiedid.contoso.com/manifest",
        "acceptedIssuer": "did:web:eu.did-dev.contoso.io",
        "claimBindingSource": "directory",
        "claimBindings": [
            {
                "sourceAttribute": "First name",
                "verifiedIdClaim": "vc.credentialSubject.firstName"
            },
            {
                "sourceAttribute": "Last name",
                "verifiedIdClaim": "vc.credentialSubject.lastName"
            }
        ]
    },
    "faceCheckConfiguration": {
        "isEnabled": true,
        "sourcePhotoClaimName": "portrait"
    },
    "mobileDriversLicenseConfiguration": {
        "acceptedRegions": [
            "region-code"
        ],
        "documentStandard": "document-standard"
    },
    "verifiedIdUsageConfigurations": [
        {
            "isEnabledForTestOnly": true,
            "purpose": "verification"
        }
    ],
    "selfServiceIssuance": {
        "isEnabled": true,
        "issuanceUrl": "https://verifiedid.contoso.com/issue"
    }
}
  • Last updated on