Liveness Session Operations - Create Liveness Session

リファレンス

サービス:: Azure AI Services

API バージョン:: v1.1-preview.1

新しいライブネス検出セッションをCreateします。
セッションは、開発者がクライアントデバイスがリソースへのフルアクセスを許可せずにライブネス検出のみを実行することを承認する必要があるクライアントデバイスのシナリオに最適です。作成されたセッションの有効期間は限られており、アクセスが期限切れになる前にクライアントが必要なアクションを実行することを承認するだけです。

アクセス許可には、次のものが含まれます...

- 最大 3 回の再試行に対して /detectLiveness/singleModal を呼び出す機能。
- トークンの有効期間は 10 分です。

注意

クライアントアクセスは、ライブネスセッションの削除操作を使用してセッションを削除することで取り消すことができます。結果を取得するには、Get Liveness Session を使用します。クライアントがリソースに対して行った個々の要求を監査するには、ライブネスセッション監査エントリの一覧表示を使用します。

POST {endpoint}/face/{apiVersion}/detectLiveness/singleModal/sessions

URI パラメーター

名前	/	必須	型	説明
apiVersion	path	True	string	API バージョン
endpoint	path	True	string uri	サポートされている Cognitive Services エンドポイント (プロトコルとホスト名(例: https://{resource-name}.cognitiveservices.azure.com)。

要求本文

名前	必須	型	説明
livenessOperationMode	True	LivenessOperationMode	クライアントが従う必要があるライブネスモードの種類。
authTokenTimeToLiveInSeconds		integer	セッションが続く秒数。範囲は 60 ~ 86400 秒です。既定値は 600 です。
deviceCorrelationId		string	各エンドユーザーデバイスごとの一意の Guid。これはレート制限と反ハンマーを提供するためです。この要求で 'deviceCorrelationIdSetInClient' が true の場合、この 'deviceCorrelationId' は null である必要があります。
deviceCorrelationIdSetInClient		boolean	クライアントが Vision SDK を介して独自の 'deviceCorrelationId' を設定することを許可するかどうか。既定値は false で、この要求本文で 'deviceCorrelationId' を設定する必要があります。
sendResultsToClient		boolean	"200 - 成功" 応答本文をクライアントに送信することを許可するかどうか。これは、セキュリティ上の理由から望ましくない可能性があります。既定値は false で、クライアントは '204 - NoContent' の空の本文応答を受け取ります。選択に関係なく、Session GetResult を呼び出すと、常に応答本文が含まれるので、ビジネスロジックを実装できます。

応答

名前	型	説明
200 OK	CreateLivenessSessionResult	呼び出しが成功すると、クライアントデバイスのセッションが作成され、限られた目的と時間のためにクライアントアプリケーションで使用される承認トークンが提供されます。
Other Status Codes	FaceErrorResponse	予期しないエラー応答。ヘッダー x-ms-error-code: string

名前

型

説明

200 OK

CreateLivenessSessionResult

呼び出しが成功すると、クライアントデバイスのセッションが作成され、限られた目的と時間のためにクライアントアプリケーションで使用される承認トークンが提供されます。

Other Status Codes

FaceErrorResponse

予期しないエラー応答。

ヘッダー

x-ms-error-code: string

セキュリティ

Ocp-Apim-Subscription-Key

Azure AI Face サブスクリプションの秘密鍵。

型: apiKey
/: header

AADToken

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: accessCode
Authorization URL (承認 URL): https://api.example.com/oauth2/authorize
Token URL (トークン URL): https://api.example.com/oauth2/token

スコープ

名前	説明
https://cognitiveservices.azure.com/.default

例

Create Liveness Session

要求のサンプル

HTTP

POST {endpoint}/face/v1.1-preview.1/detectLiveness/singleModal/sessions

{
  "livenessOperationMode": "Passive",
  "sendResultsToClient": true,
  "deviceCorrelationIdSetInClient": true,
  "deviceCorrelationId": "your_device_correlation_id",
  "authTokenTimeToLiveInSeconds": 60
}

応答のサンプル

状態コード:: 200

{
  "sessionId": "b12e033e-bda7-4b83-a211-e721c661f30e",
  "authToken": "eyJhbGciOiJFUzI1NiIsIm"
}

定義

名前	説明
CreateLivenessSessionContent	ライブネスセッションを作成するための要求。
CreateLivenessSessionResult	ライブネスセッション作成の応答。
FaceError	error オブジェクト。 Face Service によって返されるエラーコードとメッセージの包括的な詳細については、次のリンクを参照してください。 https://aka.ms/face-error-codes-and-messages
FaceErrorResponse	エラーの詳細を含む応答。
LivenessOperationMode	クライアントのエンドユーザーエクスペリエンスを駆動するライブネス操作モード。

CreateLivenessSessionContent

ライブネスセッションを作成するための要求。

名前	型	規定値	説明
authTokenTimeToLiveInSeconds	integer	600	セッションが続く秒数。範囲は 60 ~ 86400 秒です。既定値は 600 です。
deviceCorrelationId	string		各エンドユーザーデバイスごとの一意の Guid。これはレート制限と反ハンマーを提供するためです。この要求で 'deviceCorrelationIdSetInClient' が true の場合、この 'deviceCorrelationId' は null である必要があります。
deviceCorrelationIdSetInClient	boolean		クライアントが Vision SDK を介して独自の 'deviceCorrelationId' を設定することを許可するかどうか。既定値は false で、この要求本文で 'deviceCorrelationId' を設定する必要があります。
livenessOperationMode	LivenessOperationMode		クライアントが従う必要があるライブネスモードの種類。
sendResultsToClient	boolean		"200 - 成功" 応答本文をクライアントに送信することを許可するかどうか。これは、セキュリティ上の理由から望ましくない可能性があります。既定値は false で、クライアントは '204 - NoContent' の空の本文応答を受け取ります。選択に関係なく、Session GetResult を呼び出すと、常に応答本文が含まれるので、ビジネスロジックを実装できます。

CreateLivenessSessionResult

ライブネスセッション作成の応答。

名前	型	説明
authToken	string	クライアントアプリケーションで実行されている Vision SDK の認証を提供するベアラートークン。このベアラートークンには、必要なアクションのみを実行するためのアクセス許可が制限されており、TTL 時間後に期限切れになります。また、監査可能です。
sessionId	string	作成されたセッションの一意のセッション ID。これは、作成されてから 48 時間後に期限切れになるか、対応するセッション削除操作を使用して、より早く削除される可能性があります。

FaceError

error オブジェクト。 Face Service によって返されるエラーコードとメッセージの包括的な詳細については、次のリンクを参照してください。 https://aka.ms/face-error-codes-and-messages

名前	型	説明
code	string	サーバー定義のエラーコードのセットの 1 つ。
message	string	エラーの人間が判読できる表現。

FaceErrorResponse

エラーの詳細を含む応答。

名前	型	説明
error	FaceError	error オブジェクト。

LivenessOperationMode

クライアントのエンドユーザーエクスペリエンスを駆動するライブネス操作モード。

名前	型	説明
Passive	string	ユーザーからの追加のアクションを必要としないパッシブなライブネス手法を利用します。最適なパフォーマンスを得るには、通常の屋内照明と高い画面の明るさが必要です。したがって、このモードは狭い運用エンベロープを持ち、エンドユーザーが明るい照明状態である必要があるシナリオには適していません。注: これは、Mobile (iOS および Android) ソリューションでサポートされている唯一のモードです。
PassiveActive	string	このモードでは、ユーザーの協力を必要とするハイブリッドパッシブまたはアクティブなライブネス手法を利用します。これは、最適でない照明条件下でのみアクティブなモーションを必要とするように最適化されています。パッシブモードとは異なり、このモードには照明の制限がないため、より広範な運用エンベロープが提供されます。このモードは、Web ベースのソリューションでパッシブモードの運用エンベロープを妨げるブラウザーで使用できる自動画面の明るさ制御がないため、Web ベースのソリューションで推奨されます。

次の方法で共有

Liveness Session Operations - Create Liveness Session

URI パラメーター

要求本文

応答

セキュリティ

Ocp-Apim-Subscription-Key

AADToken

スコープ

例

Create Liveness Session

要求のサンプル

応答のサンプル

定義

CreateLivenessSessionContent

CreateLivenessSessionResult

FaceError

FaceErrorResponse

LivenessOperationMode

その他のリソース