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

void AddKnowledgeBasedAuthenticatorUsingPOST (string userid, KnowledgeBasedAuthenticator knowledgeBasedAuthenticator)

Add a knowledge-based authenticator

Add a knowledge-based authenticator for the specified user. Caller requires the USERQUESTIONANSWERS:ADD permission.

Using the AddKnowledgeBasedAuthenticatorUsingPOSTWithHttpInfo variant

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

Parameters

Name	Type	Description	Notes
userid	string
knowledgeBasedAuthenticator	KnowledgeBasedAuthenticator

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	-

DeleteUserKbaChallengesUsingDELETE

void DeleteUserKbaChallengesUsingDELETE (string 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

Using the DeleteUserKbaChallengesUsingDELETEWithHttpInfo 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 from which the retained KBA challenges are to be deleted.

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	-

DeleteUserKbaQuestionUsingDELETE

void DeleteUserKbaQuestionUsingDELETE (string userid, string 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

Using the DeleteUserKbaQuestionUsingDELETEWithHttpInfo 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 from which a specific KBA question is to be deleted.
id	string	The UUID of the question to be deleted.

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	-

DeleteUserKbaUsingDELETE

void DeleteUserKbaUsingDELETE (string userid)

Delete the knowledge-based authenticator

Delete the knowledge-based authenticator for the specified user. Caller requires the USERQUESTIONS:REMOVE permission.

Example

Using the DeleteUserKbaUsingDELETEWithHttpInfo 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 KBA infomration is to be removed.

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	-

GetKbaQuestionsUsingGET

List<UserQuestion> GetKbaQuestionsUsingGET (string 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

Using the GetKbaQuestionsUsingGETWithHttpInfo variant

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

Parameters

Name	Type	Description	Notes
locale	string

Return type

List<UserQuestion>

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	-

GetUserKbaUsingGET

KnowledgeBasedAuthenticator GetUserKbaUsingGET (string userid)

Get the knowledge-based authenticator

Get the knowledge-based authenticator for the specified user. Caller requires the USERQUESTIONS:VIEW permission.

Example

Using the GetUserKbaUsingGETWithHttpInfo 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 KBA information is to be retrieved.

Return type

KnowledgeBasedAuthenticator

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	-

UpdateKnowledgeBasedAuthenticatorUsingPUT

void UpdateKnowledgeBasedAuthenticatorUsingPUT (string userid, KnowledgeBasedAuthenticator knowledgeBasedAuthenticator)

Modify a knowledge-based authenticator

Modify a knowledge-based authenticator for the specified user. Caller requires the USERQUESTIONANSWERS:EDIT permission.

Example

Using the UpdateKnowledgeBasedAuthenticatorUsingPUTWithHttpInfo variant

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

Parameters

Name	Type	Description	Notes
userid	string
knowledgeBasedAuthenticator	KnowledgeBasedAuthenticator

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	-