KBAApi
| Method | HTTP request | Description |
|---|---|---|
| add_knowledge_based_authenticator_using_post | POST /api/web/v1/users/{userid}/userquestions | Add a knowledge-based authenticator |
| delete_user_kba_challenges_using_delete | DELETE /api/web/v1/users/{userid}/kbachallenges | Delete retained knowledge-based authenticator challenges |
| delete_user_kba_question_using_delete | DELETE /api/web/v1/users/{userid}/userquestions/{id} | Delete a question from the knowledge-based authenticator |
| delete_user_kba_using_delete | DELETE /api/web/v1/users/{userid}/userquestions | Delete the knowledge-based authenticator |
| get_kba_questions_using_get | GET /api/web/v1/users/userquestions/{locale} | Get a list of Knowledge-based questions that a user can answer |
| get_user_kba_using_get | GET /api/web/v1/users/{userid}/userquestions | Get the knowledge-based authenticator |
| update_knowledge_based_authenticator_using_put | PUT /api/web/v1/users/{userid}/userquestions | Modify a knowledge-based authenticator |
add_knowledge_based_authenticator_using_post
add_knowledge_based_authenticator_using_post(userid, knowledge_based_authenticator)
Add a knowledge-based authenticator
Add a knowledge-based authenticator for the specified user. Caller requires the USERQUESTIONANSWERS:ADD permission.
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| userid | str | ||
| knowledge_based_authenticator | KnowledgeBasedAuthenticator |
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 | - |
delete_user_kba_challenges_using_delete
delete_user_kba_challenges_using_delete(userid)
Delete retained knowledge-based authenticator challenges
Delete all retained knowledge-based authenticator challenges for the specified user. Caller requires the USERQUESTIONS:REMOVE permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| userid | str | The UUID of the user from which the retained KBA challenges are to be deleted. |
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 | - |
delete_user_kba_question_using_delete
delete_user_kba_question_using_delete(userid, id)
Delete a question from the knowledge-based authenticator
Delete a specified question from the knowledge-based authenticator of the specified user. Caller requires the USERQUESTIONS:REMOVE permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| userid | str | The UUID of the user from which a specific KBA question is to be deleted. | |
| id | str | The UUID of the question to be deleted. |
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 | - |
delete_user_kba_using_delete
delete_user_kba_using_delete(userid)
Delete the knowledge-based authenticator
Delete the knowledge-based authenticator for the specified user. Caller requires the USERQUESTIONS:REMOVE permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| userid | str | The UUID of the user whose KBA infomration is to be removed. |
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_kba_questions_using_get
List[UserQuestion] get_kba_questions_using_get(locale)
Get a list of Knowledge-based questions that a user can answer
Get a list of Knowledge-based questions for the specified locale (language). The locale should be the two letter Caller requires the USERQUESTIONS:VIEW permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| locale | str |
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_kba_using_get
KnowledgeBasedAuthenticator get_user_kba_using_get(userid)
Get the knowledge-based authenticator
Get the knowledge-based authenticator for the specified user. Caller requires the USERQUESTIONS:VIEW permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| userid | str | The UUID of the user whose KBA information is to be retrieved. |
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_knowledge_based_authenticator_using_put
update_knowledge_based_authenticator_using_put(userid, knowledge_based_authenticator)
Modify a knowledge-based authenticator
Modify a knowledge-based authenticator for the specified user. Caller requires the USERQUESTIONANSWERS:EDIT permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| userid | str | ||
| knowledge_based_authenticator | KnowledgeBasedAuthenticator |
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 | - |