Method and instance management - monetplus/IDport GitHub Wiki

Method and instance management

This section documents API callbacks for management of methods and instances, i.e. manual un/blocking, deactivating.

  1. Get method information IAPI/methodInfo
  2. Block instance IAPI/blockInstance
  3. Unblock instance IAPI/unblockInstance
  4. Deactivate instance IAPI/deactivateInstance
  5. Block method IAPI/blockMethod
  6. Unblock method IAPI/unblockMethod
  7. Deactivate method IAPI/deactivateMethod

Get method information

  • get information about state and blocking rules of specified method types
  • used parameters:
Parameter Description Required Value example
methodTypes array of types of used methods true ["PASSWORD"]
muid user identifier true cg2t1
tenant organisation name, if not supplied, default value from configuration is taken false Monet+
  • REST API callback: IAPI/methodInfo 
POST http://${BASE_URL}/case-iapi/v1/methodInfo
{
  "tenant": "idport",
  "muid": "cg2t1",
  "methodTypes": [
    "PASSWORD"
  ]
}
{
  "status": "success",
  "data": {
    "methodInfo": [
      {
        "methodType": "PASSWORD",
        "state": "ACTIVE",
        "activeInstances": 0,
        "instances": [],
        "failedAttempts": 0,
        "remainingAttempts": 3
      }
    ]
  }
}

Block instance

  • manually block specified instance
  • method state remains unchanged
  • used parameters:
Parameter Description Required Value example
instanceId instance identifier true 9e67b9e786c8a156b6135107841ed44c12e93420be366a02ba91f6fd0efc84c3
methodType type of used method true ["PASSWORD","ACTIVATION_CODE","SMS","CM","SPNEGO","TLS_CLIENT"]
muid user identifier true cg2t1
tenant organisation name, if not supplied, default value from configuration is taken false Monet+
  • REST API callback: IAPI/blockInstance 
POST http://${BASE_URL}/case-iapi/v1/blockInstance
{
  "tenant": "idport",
  "muid": "cg2t1",
  "methodType": "PASSWORD",
  "instanceId": "PASSWORD:15059c3c-c3b4-48cf-8642-54c951caa3dd:cg2t1"
}
{
  "status": "success",
  "data": null
}

Unblock instance

  • unblock specified instance
  • method state remains unchanged
  • used parameters:
Parameter Description Required Value example
instanceId instance identifier true 9e67b9e786c8a156b6135107841ed44c12e93420be366a02ba91f6fd0efc84c3
methodType type of used method true ["PASSWORD","ACTIVATION_CODE","SMS","CM","SPNEGO","TLS_CLIENT"]
muid user identifier true cg2t1
tenant organisation name, if not supplied, default value from configuration is taken false Monet+
  • REST API callback: IAPI/unblockInstance 
POST http://${BASE_URL}/case-iapi/v1/unblockInstance
{
  "tenant": "idport",
  "muid": "cg2t1",
  "methodType": "PASSWORD",
  "instanceId": "PASSWORD:15059c3c-c3b4-48cf-8642-54c951caa3dd:cg2t1"
}
{
  "status": "success",
  "data": null
}

Deactivate instance

  • deactivate specified instance
  • deactivated instance cannot be re-activated
  • method state remains unchanged
  • used parameters:
Parameter Description Required Value example
instanceId instance identifier true 9e67b9e786c8a156b6135107841ed44c12e93420be366a02ba91f6fd0efc84c3
methodType type of used method true ["PASSWORD","ACTIVATION_CODE","SMS","CM","SPNEGO","TLS_CLIENT"]
muid user identifier true cg2t1
tenant organisation name, if not supplied, default value from configuration is taken false Monet+
  • REST API callback: IAPI/deactivateInstance 
POST http://${BASE_URL}/case-iapi/v1/deactivateInstance
{
  "tenant": "idport",
  "muid": "cg2t1",
  "methodType": "PASSWORD",
  "instanceId": "PASSWORD:15059c3c-c3b4-48cf-8642-54c951caa3dd:cg2t1"
}
{
  "status": "success",
  "data": null
}

Block method

  • manually block method
  • instances state remains unchanged but their usage is limited
  • used parameters:
Parameter Description Required Value example
methodType type of used method true ["PASSWORD","ACTIVATION_CODE","SMS","CM","SPNEGO","TLS_CLIENT"]
muid user identifier true cg2t1
tenant organisation name, if not supplied, default value from configuration is taken false Monet+
  • REST API callback: IAPI/blockMethod 
POST http://${BASE_URL}/case-iapi/v1/blockMethod
{
  "tenant": "idport",
  "muid": "cg2t1",
  "methodType": "PASSWORD"
}
{
  "status": "success",
  "data": null
}

Unblock method

  • unblock method
  • instances state remains unchanged
  • used parameters:
Parameter Description Required Value example
methodType type of used method true ["PASSWORD","ACTIVATION_CODE","SMS","CM","SPNEGO","TLS_CLIENT"]
muid user identifier true cg2t1
tenant organisation name, if not supplied, default value from configuration is taken false Monet+
  • REST API callback: IAPI/unblockMethod 
POST http://${BASE_URL}/case-iapi/v1/unblockMethod
{
  "tenant": "idport",
  "muid": "cg2t1",
  "methodType": "PASSWORD"
}
{
  "status": "success",
  "data": null
}

Deactivate method

  • deactivate method
  • all usable instances are deactivated
  • used parameters:
Parameter Description Required Value example
methodType type of used method true ["PASSWORD","ACTIVATION_CODE","SMS","CM","SPNEGO","TLS_CLIENT"]
muid user identifier true cg2t1
tenant organisation name, if not supplied, default value from configuration is taken false Monet+
  • REST API callback: IAPI/deactivateMethod 
POST http://${BASE_URL}/case-iapi/v1/deactivateMethod
{
  "tenant": "idport",
  "muid": "cg2t1",
  "methodType": "PASSWORD"
}
{
  "status": "success",
  "data": null
}
⚠️ **GitHub.com Fallback** ⚠️