Validate endpoints

GET /validate/simplecheck

check the authentication for a user or a serial number. Either a serial or a user is required to authenticate. The PIN and OTP value is sent in the parameter pass.

TODO: This API call does not honour the policies AUTHZ:tokentype and AUTHZ:serial!

Parameters:

• serial – The serial number of the token, that tries to authenticate.
• user – The loginname/username of the user, who tries to authenticate.
• realm – The realm of the user, who tries to authenticate. If the realm is omitted, the user is looked up in the default realm.
• pass – The password, that consists of the OTP PIN and the OTP value.

Return:

a json result with a boolean “result”: true

Example response for a succesful authentication:

HTTP/1.1 200 OK
Content-Type: application/text

:-)

POST /validate/simplecheck

check the authentication for a user or a serial number. Either a serial or a user is required to authenticate. The PIN and OTP value is sent in the parameter pass.

TODO: This API call does not honour the policies AUTHZ:tokentype and AUTHZ:serial!

Parameters:

• serial – The serial number of the token, that tries to authenticate.
• user – The loginname/username of the user, who tries to authenticate.
• realm – The realm of the user, who tries to authenticate. If the realm is omitted, the user is looked up in the default realm.
• pass – The password, that consists of the OTP PIN and the OTP value.

Return:

a json result with a boolean “result”: true

Example response for a succesful authentication:

HTTP/1.1 200 OK
Content-Type: application/text

:-)

GET /validate/check

check the authentication for a user or a serial number. Either a serial or a user is required to authenticate. The PIN and OTP value is sent in the parameter pass.

Parameters:

• serial – The serial number of the token, that tries to authenticate.
• user – The loginname/username of the user, who tries to authenticate.
• realm – The realm of the user, who tries to authenticate. If the realm is omitted, the user is looked up in the default realm.
• pass – The password, that consists of the OTP PIN and the OTP value.

Return:

a json result with a boolean “result”: true

Example response for a successful authentication:

HTTP/1.1 200 OK
Content-Type: application/json

 {
   "detail": {
     "message": "matching 1 tokens",
     "serial": "PISP0000AB00",
     "type": "spass"
   },
   "id": 1,
   "jsonrpc": "2.0",
   "result": {
     "status": true,
     "value": true
   },
   "version": "privacyIDEA unknown"
 }

POST /validate/check

check the authentication for a user or a serial number. Either a serial or a user is required to authenticate. The PIN and OTP value is sent in the parameter pass.

Parameters:

• serial – The serial number of the token, that tries to authenticate.
• user – The loginname/username of the user, who tries to authenticate.
• realm – The realm of the user, who tries to authenticate. If the realm is omitted, the user is looked up in the default realm.
• pass – The password, that consists of the OTP PIN and the OTP value.

Return:

a json result with a boolean “result”: true

Example response for a successful authentication:

HTTP/1.1 200 OK
Content-Type: application/json

 {
   "detail": {
     "message": "matching 1 tokens",
     "serial": "PISP0000AB00",
     "type": "spass"
   },
   "id": 1,
   "jsonrpc": "2.0",
   "result": {
     "status": true,
     "value": true
   },
   "version": "privacyIDEA unknown"
 }