FaceApi
| Method | HTTP request | Description |
|---|---|---|
| create_face_using_post | POST /api/web/v1/users/{userid}/face | Create a Face Biometric for a user |
| delete_face_using_delete | DELETE /api/web/v1/face/{faceid} | Delete the Face Biometric by a given ID |
| get_faces_using_get | GET /api/web/v1/users/{userid}/faces | Get the Face Biometrics for a given user |
| get_user_face_settings_using_get | GET /api/web/v1/users/{userid}/settings/face | Gets a user Face Biometric settings |
| update_face_using_put | PUT /api/web/v1/users/{userid}/face | Update the Face Biometric for a given user |
create_face_using_post
FaceAuthenticator create_face_using_post(userid, face_create_parms)
Create a Face Biometric for a user
Create a Face for the specified user. Caller requires the FACE:ADD permission.
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| userid | str | ||
| face_create_parms | 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 | - |
delete_face_using_delete
delete_face_using_delete(faceid)
Delete the Face Biometric by a given ID
Delete the Face Biometric by the specified ID. Caller requires the FACE:REMOVE permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| faceid | str | The ID of the Face Biometric. |
Return type
void (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 | - |
get_faces_using_get
List[FaceAuthenticator] get_faces_using_get(userid)
Get the Face Biometrics for a given user
Get the Face Biometrics for the specified user. Caller requires the FACE:VIEW permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| userid | str | 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 | - |
get_user_face_settings_using_get
UserFaceSettings get_user_face_settings_using_get(userid)
Gets a user Face Biometric settings
Get Face Biometric settings information for the specified user. Caller requires the FACE:VIEW permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| userid | str | 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 | - |
update_face_using_put
update_face_using_put(userid, face_update_parms)
Update the Face Biometric for a given user
Update the Face Biometric for the specified user. Caller requires the FACE:EDIT permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| userid | str | The UUID of the user to update the Face Biometric for. | |
| face_update_parms | FaceUpdateParms |
Return type
void (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 | - |