Partager via

Liveness Session Operations - Create Liveness Session

  • Référence
Service:
Azure AI Services
Version d'API:
v1.2-preview.1

Créez une session détecter la durée de vie.
Une session est idéale pour les scénarios d’appareil client dans lesquels les développeurs souhaitent autoriser un appareil client à effectuer uniquement une détection d’liveness sans accorder un accès total à leur ressource. Les sessions créées ont une durée de vie limitée et autorisent uniquement les clients à effectuer l’action souhaitée avant l’expiration de l’accès.

Les autorisations incluent...

    • Possibilité d’appeler /detectLiveness/singleModal jusqu’à 3 nouvelles tentatives.
    • Durée de vie du jeton de 10 minutes.

Note

L’accès client peut être révoqué en supprimant la session à l’aide de l’opération Delete Liveness Session. Pour récupérer un résultat, utilisez la session Get Liveness. Pour auditer les demandes individuelles qu’un client a adressées à votre ressource, utilisez les entrées d’audit de session De liste dynamique.

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

Paramètres URI

Nom Dans Obligatoire Type Description
apiVersion
 path True

string

Version de l’API
endpoint
 path True

string

uri

Points de terminaison Cognitive Services pris en charge (protocole et nom d’hôte, par exemple : https://{nom-ressource}.cognitiveservices.azure.com).

Corps de la demande

Nom Obligatoire Type Description
livenessOperationMode True

LivenessOperationMode

Type de mode liveness que le client doit suivre.
authTokenTimeToLiveInSeconds

integer

Secondes pendant lesquelles la session doit durer. La plage est comprise entre 60 et 86400 secondes. La valeur par défaut est 600.
deviceCorrelationId

string

Guid unique par appareil de l’utilisateur final. Il s’agit de fournir une limitation de débit et un anti-marteau. Si « deviceCorrelationIdSetInClient » a la valeur true dans cette requête, ce « deviceCorrelationId » doit être null.
deviceCorrelationIdSetInClient

boolean

Indique si le client doit ou non définir son propre « deviceCorrelationId » via le Kit de développement logiciel (SDK) Vision. La valeur par défaut est false et « deviceCorrelationId » doit être définie dans le corps de cette requête.
enableSessionImage

boolean

Indique si vous stockez ou non l’image de session.
livenessSingleModalModel

LivenessModel

Version du modèle utilisée pour la classification liveness. Il s’agit d’un paramètre facultatif et, s’il n’est pas spécifié, la dernière version de modèle prise en charge sera choisie.
sendResultsToClient

boolean

Indique si un corps de réponse « 200 - Réussite » doit être envoyé au client, ce qui peut être indésirable pour des raisons de sécurité. Par défaut, les clients reçoivent une réponse de corps vide « 204 - NoContent ». Quelle que soit la sélection, l’appel de Session GetResult contiendra toujours un corps de réponse permettant l’implémentation de la logique métier.

Réponses

Nom Type Description
200 OK

CreateLivenessSessionResult

Un appel réussi crée une session pour un appareil client et fournit un jeton d’autorisation à utiliser par l’application cliente à des fins limitées et à temps.
Other Status Codes

FaceErrorResponse

Réponse d’erreur inattendue.

En-têtes

x-ms-error-code: string

Sécurité

Ocp-Apim-Subscription-Key

Clé secrète de votre abonnement Azure AI Face.

Type: apiKey
Dans: header

AADToken

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: accessCode
URL d’autorisation: https://api.example.com/oauth2/authorize
URL du jeton: https://api.example.com/oauth2/token

Étendues

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

Exemples

Create Liveness Session

Exemple de requête

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

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

Exemple de réponse

Code d’état:
200 
{
  "sessionId": "b12e033e-bda7-4b83-a211-e721c661f30e",
  "authToken": "eyJhbGciOiJFUzI1NiIsIm"
}

Définitions

Nom Description
CreateLivenessSessionContent

Modèle de demande pour la création d’une session liveness.
CreateLivenessSessionResult

Réponse de la création de session liveness.
FaceError

Objet d’erreur. Pour plus d’informations sur les codes d’erreur et les messages retournés par le service Visage, reportez-vous au lien suivant : https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse

Réponse contenant les détails de l’erreur.
LivenessModel

Version du modèle utilisée pour la classification liveness.
LivenessOperationMode

Mode d’opération liveness pour piloter l’expérience de l’utilisateur final du client.

CreateLivenessSessionContent

Modèle de demande pour la création d’une session liveness.

Nom Type Valeur par défaut Description
authTokenTimeToLiveInSeconds

integer

600

Secondes pendant lesquelles la session doit durer. La plage est comprise entre 60 et 86400 secondes. La valeur par défaut est 600.
deviceCorrelationId

string

Guid unique par appareil de l’utilisateur final. Il s’agit de fournir une limitation de débit et un anti-marteau. Si « deviceCorrelationIdSetInClient » a la valeur true dans cette requête, ce « deviceCorrelationId » doit être null.
deviceCorrelationIdSetInClient

boolean

Indique si le client doit ou non définir son propre « deviceCorrelationId » via le Kit de développement logiciel (SDK) Vision. La valeur par défaut est false et « deviceCorrelationId » doit être définie dans le corps de cette requête.
enableSessionImage

boolean

Indique si vous stockez ou non l’image de session.
livenessOperationMode

LivenessOperationMode

Type de mode liveness que le client doit suivre.
livenessSingleModalModel

LivenessModel

Version du modèle utilisée pour la classification liveness. Il s’agit d’un paramètre facultatif et, s’il n’est pas spécifié, la dernière version de modèle prise en charge sera choisie.
sendResultsToClient

boolean

Indique si un corps de réponse « 200 - Réussite » doit être envoyé au client, ce qui peut être indésirable pour des raisons de sécurité. Par défaut, les clients reçoivent une réponse de corps vide « 204 - NoContent ». Quelle que soit la sélection, l’appel de Session GetResult contiendra toujours un corps de réponse permettant l’implémentation de la logique métier.

CreateLivenessSessionResult

Réponse de la création de session liveness.

Nom Type Description
authToken

string

Jeton du porteur pour fournir l’authentification pour le Kit de développement logiciel (SDK) Vision s’exécutant sur une application cliente. Ce jeton du porteur dispose d’autorisations limitées pour effectuer uniquement l’action requise et expire après la durée de vie. Il est également auditable.
sessionId

string

ID de session unique de la session créée. Il expire 48 heures après sa création ou peut être supprimé plus tôt à l’aide de l’opération de suppression de session correspondante.

FaceError

Objet d’erreur. Pour plus d’informations sur les codes d’erreur et les messages retournés par le service Visage, reportez-vous au lien suivant : https://aka.ms/face-error-codes-and-messages.

Nom Type Description
code

string

Un ensemble de codes d’erreur définis par le serveur.
message

string

Représentation lisible par l’homme de l’erreur.

FaceErrorResponse

Réponse contenant les détails de l’erreur.

Nom Type Description
error

FaceError

Objet d’erreur.

LivenessModel

Version du modèle utilisée pour la classification liveness.

Nom Type Description
2022-10-15-preview.04

string

2023-12-20-preview.06

string

LivenessOperationMode

Mode d’opération liveness pour piloter l’expérience de l’utilisateur final du client.

Nom Type Description
Passive

string

Utilise une technique de liveness passive qui ne nécessite aucune action supplémentaire de l’utilisateur. Nécessite un éclairage intérieur normal et une luminosité d’écran élevée pour des performances optimales. Par conséquent, ce mode a une enveloppe opérationnelle étroite et ne convient pas aux scénarios qui nécessitent que l’utilisateur final soit dans des conditions d’éclairage lumineux. Remarque : il s’agit du seul mode pris en charge pour la solution Mobile (iOS et Android).
PassiveActive

string

Ce mode utilise une technique de liveness passive ou active hybride qui nécessite une coopération utilisateur. Il est optimisé pour exiger un mouvement actif uniquement dans des conditions d’éclairage non optimales. Contrairement au mode passif, ce mode n’a aucune restriction d’éclairage et offre ainsi une enveloppe opérationnelle plus large. Ce mode est préférable sur les solutions web en raison de l’absence de contrôle de luminosité automatique de l’écran disponible sur les navigateurs qui entravent l’enveloppe opérationnelle du mode passif sur les solutions web.