Share via

Liveness Session Operations - Get Client Assets Access Token

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

Get access token to get access to client AI model assets.

GET {endpoint}/face/{apiVersion}/settings/getClientAssetsAccessToken

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).

Responses

Name Type Description
200 OK

ClientAssetsAccessTokenResponse

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

Get LivenessSessionOperations Settings ClientAssetsAccessToken

Sample request

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

Sample response

Status code:
200 
{
  "expiry": "2025-07-03T15:30:00.000Z",
  "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9",
  "base64AccessToken": "ZXlKaGJHY2lPaUpJVXpJMU5pSXNJblI1="
}

Definitions

Name Description
ClientAssetsAccessTokenResponse

Response model for client assets access token.
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.

ClientAssetsAccessTokenResponse

Object

Response model for client assets access token.

Name Type Description
accessToken

string

The access token for client assets.
base64AccessToken

string

The base64 encoded access token.
expiry

string (date-time)

The expiry time of the access token.

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.