Share via

Liveness Session Operations - Patch Settings

Service:
Azure AI Services
API Version:
v1.3-preview.1

Update the liveness setting object.

PATCH {endpoint}/face/{apiVersion}/settings

URI Parameters

Name In Required Type Description
apiVersion
 path True

string

API Version
endpoint
 path True

string (uri)

Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com).

Request Body

Name Type Description
livenessAbuseMonitoring

LivenessAbuseMonitoringSettingUpdate

Liveness abuse monitoring settings

Responses

Name Type Description
200 OK

Settings

The request has succeeded.
Other Status Codes

FaceErrorResponse

An unexpected error response.

Headers

x-ms-error-code: string

Security

Ocp-Apim-Subscription-Key

The secret key for your Azure AI Face subscription.

Type: apiKey
In: header

AADToken

The Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: accessCode
Authorization URL: https://api.example.com/oauth2/authorize
Token URL: https://api.example.com/oauth2/token

Scopes

Name Description
https://cognitiveservices.azure.com/.default

Examples

Patch LivenessSessionOperations Settings

Sample request

PATCH {endpoint}/face/v1.3-preview.1/settings

{
  "livenessAbuseMonitoring": {
    "enabled": true
  }
}

Sample response

Status code:
200 
{
  "livenessAbuseMonitoring": {
    "enabled": true
  }
}

Definitions

Name Description
FaceError

The error object. For comprehensive details on error codes and messages returned by the Face Service, please refer to the following link: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse

A response containing error details.
LivenessAbuseMonitoringSetting

Settings for liveness abuse monitoring.
LivenessAbuseMonitoringSettingUpdate

Settings for liveness abuse monitoring.
Settings

Response model for settings.
SettingsUpdate

Response model for settings.

FaceError

Object

The error object. For comprehensive details on error codes and messages returned by the Face Service, please refer to the following link: https://aka.ms/face-error-codes-and-messages.

Name Type Description
code

string

One of a server-defined set of error codes.
message

string

A human-readable representation of the error.

FaceErrorResponse

Object

A response containing error details.

Name Type Description
error

FaceError

The error object.

LivenessAbuseMonitoringSetting

Object

Settings for liveness abuse monitoring.

Name Type Description
enabled

object

Whether liveness abuse monitoring is enabled

LivenessAbuseMonitoringSettingUpdate

Object

Settings for liveness abuse monitoring.

Name Type Description
enabled

object

Whether liveness abuse monitoring is enabled

Settings

Object

Response model for settings.

Name Type Description
livenessAbuseMonitoring

LivenessAbuseMonitoringSetting

Liveness abuse monitoring settings

SettingsUpdate

Object

Response model for settings.

Name Type Description
livenessAbuseMonitoring

LivenessAbuseMonitoringSettingUpdate

Liveness abuse monitoring settings