Liveness Session Operations - Delete Liveness Session
指定したセッション ID に一致するすべてのセッション関連情報を削除します。
手記
セッションを削除すると、その認証トークンで行われる今後の API 呼び出しをブロックすることで、セッション認証トークンが非アクティブ化されます。 これは、そのトークンのアクセス権を削除するために使用できますが、これらの要求は引き続き全体的なリソース レート制限にカウントされます。 TokenTTL を利用して、不正使用された場合のトークンの長さを制限することをお勧めします。
DELETE {endpoint}/face/{apiVersion}/detectLiveness/singleModal/sessions/{sessionId}
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
api
|
path | True |
string |
API バージョン |
endpoint
|
path | True |
string uri |
サポートされている Cognitive Services エンドポイント (プロトコルとホスト名。例: https://{resource-name}.cognitiveservices.azure.com)。 |
session
|
path | True |
string |
このセッションを参照する一意の ID。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
要求は成功しました。 |
|
Other Status Codes |
予期しないエラー応答。 ヘッダー 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 |
例
Delete Liveness Session
要求のサンプル
DELETE {endpoint}/face/v1.2-preview.1/detectLiveness/singleModal/sessions/b12e033e-bda7-4b83-a211-e721c661f30e
応答のサンプル
定義
名前 | 説明 |
---|---|
Face |
エラー オブジェクト。 Face サービスによって返されるエラー コードとメッセージの詳細については、次のリンクを参照してください: https://aka.ms/face-error-codes-and-messages。 |
Face |
エラーの詳細を含む応答。 |
FaceError
エラー オブジェクト。 Face サービスによって返されるエラー コードとメッセージの詳細については、次のリンクを参照してください: https://aka.ms/face-error-codes-and-messages。
名前 | 型 | 説明 |
---|---|---|
code |
string |
サーバー定義の一連のエラー コードの 1 つ。 |
message |
string |
エラーの人間が判読できる表現。 |
FaceErrorResponse
エラーの詳細を含む応答。
名前 | 型 | 説明 |
---|---|---|
error |
エラー オブジェクト。 |