checkCTC – Check cached token validity service

The check cached token validity service returns a JSON document that indicates if the MFA generated authentication token specified in the request is currently valid for the userid that is specified in the request.

checkCTC Request

Table 1. checkCTC request
Method: POST
URL: https://host:port/checkCTC/
Version: HTTP/1.1
Headers required:
Content-Length:<length>
Content-Type: Either application/json or text/plain may be specified. You must specify text/plain when using Javascript fetch().
Body: JSON checkTokenRequest object

checkCTC successful response

Table 2. checkCTC successful response
Status: 200 – Normal completion
Headers returned: Content-Type:application/json
Body: JSON checkTokenResponse object

checkCTC JSON request objects

Note: See Table 1 for the type and attribute values for the IBM® MFA web API JSON request and response objects.
Table 3. checkCTC JSON request objects
Key Name Type Attr Description
checkTokenRequest object
userid S Z The userid to use for the request.
apiVersion I The request format. Specify a value of 2.
Ctc S Z The MFA generated token to check for validity.

checkCTC JSON response objects

Note: See Table 1 for the type and attribute values for the IBM MFA web API JSON request and response objects.
Table 4. checkCTC JSON response objects
Key Name Type Attr Description
checkTokenResponse object
rc I Request return code.
rsn I Request reason code.

checkCTC request return/reason codes

Table 5. checkCTC request return/reason codes
Rc Rsn Description
0 N/A The authentication was successful for the token.
44 0 The authentication was not successful for the token.
48 n An internal error occurred. The reason codes are not documented.

Request/Response examples

Successful verification
Request 
https://host:port/checkCTC/
{
  "userid": "TESTUSER",
  "apiVersion": 2,
  "ctc": "ABCDEFGH"
 }

Response

{
  "rc": 0,
  "rsn": 0
 }
Unsuccessful verification

Request

https://host:port/checkCTC/

{
  "userid": "",
  "apiVersion": 2,
  "ctc": "ABCDEFGH"
 }

Response

{
  "rc": 44,
  "rsn": 0
 }