Rest API Documentation

REST API Documentation for Group challenge-response, application /webconsole Version: 4.2.1.2

Endpoints (DRAFT)

POST /rest/api/challengeResponse/delete

Challenge Response API Doc

Query Params:

• id [{'type': 'string'}]:

Responses:

• Status Code: 200 OK.

  Content-type: /,

  Schema: /components/schemas/BasicAjaxResponse

GET /rest/api/challengeResponse/groups

Challenge Response API Doc, Get all Identity Question Groups

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/BeanResponse

• Status Code: 404 Not Found.

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/BeanResponse

GET /rest/api/challengeResponse/question/(questionId)

Challenge Response API Doc, Get Question by id

Path Params:

• questionId [{'type': 'string'}]:

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/IdentityQuestion

• Status Code: 404 Not Found.

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/IdentityQuestion

POST /rest/api/challengeResponse/save

Challenge Response API Doc, Save challenge response

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/BasicAjaxResponse

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/BasicAjaxResponse

GET /rest/api/challengeResponse/search

Challenge Response API Doc, Get questions list

Query Params:

• from [{'type': 'integer', 'format': 'int32'}]:
• size [{'type': 'integer', 'format': 'int32'}]:

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/BasicAjaxResponse

• Status Code: 404 Not Found.

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/IdentityQuestionSearchResultBean

DELETE /rest/api/challengeResponse/(id)

Challenge Response API Doc, Remove challenge response

Path Params:

• id [{'type': 'string'}]:

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/BeanResponse

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/BeanResponse## Definitions