KbaApi
| Method | HTTP request | Description |
|---|---|---|
| addKnowledgeBasedAuthenticatorUsingPOST | POST /api/web/v1/users/{userid}/userquestions | Add a knowledge-based authenticator |
| deleteUserKbaChallengesUsingDELETE | DELETE /api/web/v1/users/{userid}/kbachallenges | Delete retained knowledge-based authenticator challenges |
| deleteUserKbaQuestionUsingDELETE | DELETE /api/web/v1/users/{userid}/userquestions/{id} | Delete a question from the knowledge-based authenticator |
| deleteUserKbaUsingDELETE | DELETE /api/web/v1/users/{userid}/userquestions | Delete the knowledge-based authenticator |
| getKbaQuestionsUsingGET | GET /api/web/v1/users/userquestions/{locale} | Get a list of Knowledge-based questions that a user can answer |
| getUserKbaUsingGET | GET /api/web/v1/users/{userid}/userquestions | Get the knowledge-based authenticator |
| updateKnowledgeBasedAuthenticatorUsingPUT | PUT /api/web/v1/users/{userid}/userquestions | Modify a knowledge-based authenticator |
addKnowledgeBasedAuthenticatorUsingPOST
addKnowledgeBasedAuthenticatorUsingPOST(userid, knowledgeBasedAuthenticator)
Add a knowledge-based authenticator
Add a knowledge-based authenticator for the specified user. Caller requires the USERQUESTIONANSWERS:ADD permission.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| userid | String | ||
| knowledgeBasedAuthenticator | KnowledgeBasedAuthenticator |
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 | - |
deleteUserKbaChallengesUsingDELETE
deleteUserKbaChallengesUsingDELETE(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
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| userid | String | The UUID of the user from which the retained KBA challenges are to be deleted. |
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 | - |
deleteUserKbaQuestionUsingDELETE
deleteUserKbaQuestionUsingDELETE(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
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| userid | String | The UUID of the user from which a specific KBA question is to be deleted. | |
| id | String | The UUID of the question to be deleted. |
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 | - |
deleteUserKbaUsingDELETE
deleteUserKbaUsingDELETE(userid)
Delete the knowledge-based authenticator
Delete the knowledge-based authenticator for the specified user. Caller requires the USERQUESTIONS:REMOVE permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| userid | String | The UUID of the user whose KBA infomration is to be removed. |
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 | - |
getKbaQuestionsUsingGET
List<UserQuestion> getKbaQuestionsUsingGET(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
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| locale | String |
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 | - |
getUserKbaUsingGET
KnowledgeBasedAuthenticator getUserKbaUsingGET(userid)
Get the knowledge-based authenticator
Get the knowledge-based authenticator for the specified user. Caller requires the USERQUESTIONS:VIEW permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| userid | String | 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 | - |
updateKnowledgeBasedAuthenticatorUsingPUT
updateKnowledgeBasedAuthenticatorUsingPUT(userid, knowledgeBasedAuthenticator)
Modify a knowledge-based authenticator
Modify a knowledge-based authenticator for the specified user. Caller requires the USERQUESTIONANSWERS:EDIT permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| userid | String | ||
| knowledgeBasedAuthenticator | KnowledgeBasedAuthenticator |
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 | - |