FaceApi
| Method | HTTP request | Description |
|---|---|---|
| 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 |
createFaceUsingPOST
FaceAuthenticator createFaceUsingPOST(userid, faceCreateParms)
Create a Face Biometric for a user
Create a Face for the specified user. Caller requires the FACE:ADD permission.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| userid | String | ||
| faceCreateParms | FaceCreateParms |
Return type
Authorization
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
deleteFaceUsingDELETE(faceid)
Delete a Face Biometric
Delete a Face Biometric by the specified ID. Caller requires the FACE:REMOVE permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| faceid | String | The ID of the Face Biometric. |
Return type
null (empty response body)
Authorization
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(userid)
Get the Face Biometrics for a given user
Get the Face Biometrics for the specified user. Caller requires the FACE:VIEW permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| userid | String | The UUID of the user to get the Face Biometrics for. |
Return type
Authorization
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(userid)
Gets a users Face Biometric settings
Get Face Biometric settings information for the specified user. Caller requires the FACE:VIEW permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| userid | String | The UUID of the user whose Face Biometric settings information is to be fetched. |
Return type
Authorization
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
sendFaceActivationEmailUsingPUT(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
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| faceid | String | The ID of the Face Biometric. |
Return type
null (empty response body)
Authorization
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
updateFaceUsingPUT(userid, faceUpdateParms)
Update the Face Biometric for a given user
Update the Face Biometric for the specified user. Caller requires the FACE:EDIT permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| userid | String | The UUID of the user to update the Face Biometric for. | |
| faceUpdateParms | FaceUpdateParms |
Return type
null (empty response body)
Authorization
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 | - |