FaceApi

Method	HTTP request	Description
CreateFaceAuthenticatorUsingPOST	POST /api/web/v2/users/{userid}/face	Create a Face Biometric for a user
CreateFaceUsingPOST	POST /api/web/v1/users/{userid}/face	Create a Face Biometric for a user
DeleteFaceUsingDELETE	DELETE /api/web/v1/face/{faceid}	Delete a Face Biometric
GetFacesUsingGET	GET /api/web/v1/users/{userid}/faces	Get the Face Biometrics for a given user
GetUserFaceSettingsUsingGET	GET /api/web/v1/users/{userid}/settings/face	Gets a users Face Biometric settings
SendFaceActivationEmailUsingPUT	PUT /api/web/v1/face/{faceid}/activation	Send an activation email for the Face Biometric
UpdateFaceUsingPUT	PUT /api/web/v1/users/{userid}/face	Update the Face Biometric for a given user

CreateFaceAuthenticatorUsingPOST

FaceCreateResponse CreateFaceAuthenticatorUsingPOST (string userid, FaceCreateParms faceCreateParms)

Create a Face Biometric for a user

Create a Face for the specified user. Caller requires the FACE:ADD permission.

Using the CreateFaceAuthenticatorUsingPOSTWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters

Name	Type	Description	Notes
userid	string
faceCreateParms	FaceCreateParms

Return type

FaceCreateResponse

Authorization

AdminAPIAuthentication

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful	-
400	Bad Request	-
401	Access denied	-
403	Forbidden	-
404	Not Found	-
409	Conflict	-

CreateFaceUsingPOST

FaceAuthenticator CreateFaceUsingPOST (string userid, FaceCreateParms faceCreateParms)

Create a Face Biometric for a user

Create a Face for the specified user. Caller requires the FACE:ADD permission.

Example

Using the CreateFaceUsingPOSTWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters

Name	Type	Description	Notes
userid	string
faceCreateParms	FaceCreateParms

Return type

FaceAuthenticator

Authorization

AdminAPIAuthentication

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful	-
400	Bad Request	-
401	Access denied	-
403	Forbidden	-
404	Not Found	-
409	Conflict	-

DeleteFaceUsingDELETE

void DeleteFaceUsingDELETE (string faceid)

Delete a Face Biometric

Delete a Face Biometric by the specified ID. Caller requires the FACE:REMOVE permission.

Example

Using the DeleteFaceUsingDELETEWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters

Name	Type	Description	Notes
faceid	string	The ID of the Face Biometric.

Return type

void (empty response body)

Authorization

AdminAPIAuthentication

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful	-
400	Bad Request	-
401	Access denied	-
403	Forbidden	-
404	Not Found	-
409	Conflict	-

GetFacesUsingGET

List<FaceAuthenticator> GetFacesUsingGET (string userid)

Get the Face Biometrics for a given user

Get the Face Biometrics for the specified user. Caller requires the FACE:VIEW permission.

Example

Using the GetFacesUsingGETWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters

Name	Type	Description	Notes
userid	string	The UUID of the user to get the Face Biometrics for.

Return type

List<FaceAuthenticator>

Authorization

AdminAPIAuthentication

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful	-
400	Bad Request	-
401	Access denied	-
403	Forbidden	-
404	Not Found	-
409	Conflict	-

GetUserFaceSettingsUsingGET

UserFaceSettings GetUserFaceSettingsUsingGET (string userid)

Gets a users Face Biometric settings

Get Face Biometric settings information for the specified user. Caller requires the FACE:VIEW permission.

Example

Using the GetUserFaceSettingsUsingGETWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters

Name	Type	Description	Notes
userid	string	The UUID of the user whose Face Biometric settings information is to be fetched.

Return type

UserFaceSettings

Authorization

AdminAPIAuthentication

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful	-
400	Bad Request	-
401	Access denied	-
403	Forbidden	-
404	Not Found	-
409	Conflict	-

SendFaceActivationEmailUsingPUT

void SendFaceActivationEmailUsingPUT (string faceid)

Send an activation email for the Face Biometric

Send an activation email for the Face Biometric specified by ID. Caller requires the FACE:ADD permission.

Example

Using the SendFaceActivationEmailUsingPUTWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters

Name	Type	Description	Notes
faceid	string	The ID of the Face Biometric.

Return type

void (empty response body)

Authorization

AdminAPIAuthentication

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful	-
400	Bad Request	-
401	Access denied	-
403	Forbidden	-
404	Not Found	-
409	Conflict	-

UpdateFaceUsingPUT

void UpdateFaceUsingPUT (string userid, FaceUpdateParms faceUpdateParms)

Update the Face Biometric for a given user

Update the Face Biometric for the specified user. Caller requires the FACE:EDIT permission.

Example

Using the UpdateFaceUsingPUTWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters

Name	Type	Description	Notes
userid	string	The UUID of the user to update the Face Biometric for.
faceUpdateParms	FaceUpdateParms

Return type

void (empty response body)

Authorization

AdminAPIAuthentication

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful	-
400	Bad Request	-
401	Access denied	-
403	Forbidden	-
404	Not Found	-
409	Conflict	-