Get the knowledge-based authenticator

GET 
/api/web/v1/users/:userid/userquestions

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

Request

Path Parameters

userid stringrequired

The UUID of the user whose KBA information is to be retrieved.

Responses

200

Successful

application/json

Schema

Schema

maximumNumberOfQuestions int32

The maximum number of questions a user can answer for KBA. If zero, then KBA is disabled. This value is not used when adding or updating a KBA. If provided, it will be ignored.

maximumResponseSize int32

The maximum number of characters in an answer. This value is not used when adding or updating a KBA. If provided, it will be ignored.

minimumNumberOfQuestions int32

The minimum number of questions a user must answer to perform KBA. Defaults to the maximum Q&A challenge size setting. This value is not used when adding or updating a KBA. If provided, it will be ignored.

userQuestions

object[]

required

The list of question/answer pairs stored for a user. This is the only attribute required when adding or updating a KBA.

Array [

answer string

The question's answer.

id string

The UUID of the KBA question/answer.

question string

The question.

]

Example (from schema)

{
  "maximumNumberOfQuestions": 0,
  "maximumResponseSize": 0,
  "minimumNumberOfQuestions": 0,
  "userQuestions": [
    {
      "answer": "string",
      "id": "string",
      "question": "string"
    }
  ]
}

400

Bad Request

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

401

Access denied

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

403

Forbidden

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

404

Not Found

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

409

Conflict

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

Loading...