STI

View Certificates

Method: GET
URL: https://api.clearip.com/certificates

Response Body:

{
  "certificates": [
    {
      "createdAt": CREATED_AT_UNIX_TIME_HERE,
      "updatedAt": UPDATED_AT_UNIX_TIME_HERE,
      "id": "CLEARIP_CERTIFICATE_ID_HERE",
      "name": "CERTIFICATE_NAME_HERE",
      "spid": "SPID_HERE",
      "stiPaAccountId": "STI-PA_ACCOUNT_ID_HERE",
      "stiPaUserId": "STI-PA_USER_ID_HERE",
      "comment": "COMMENT_HERE",
      "reseller": "CLEARIP_RESELLER_ID_HERE",
      "operator": "CLEARIP_OPERATOR_ID_HERE "
    }
  ]
}

Add Authentication Policy

Method: POST
URL: https://api.clearip.com/authenticationPolicies

Request Body:

{
  "authenticationPolicy": {
    "sbc": "CLEARIP_SBC_ID_HERE",
    "serviceProvider": "CLEARIP_SERVICE_PROVIDER_ID_HERE",
    "group": "CLEARIP_GROUP_ID_HERE",
    "user": "CLEARIP_USER_ID_HERE",
    "callingSpid": "SPID_HERE",
    "callingNumber": "CALLING_NUMBER_HERE",
    "originationIdentifierAlgorithm": "RANDOM_OR_AUTOMATIC",
    "useAttestationInfoHeader": TRUE_OR_FALSE,
    "useOriginationIdHeader": TRUE_OR_FALSE,
    "status": "ENABLED_OR_DISABLED",
    "method": "METHOD_HERE: in-band, out-of-band, in-band-and-out-of-band",
    "action": "ACTION_HERE",
    "certificate": "CLEARIP_CERTIFICATE_ID_HERE",
    "comment": "COMMENT_HERE"
  }
}

Response Body:

{
  "authenticationPolicies": [
    {
      "createdAt": CREATED_AT_UNIX_TIME_HERE,
      "updatedAt": UPDATED_AT_UNIX_TIME_HERE,
      "id": "CLEARIP_AUTHENTICATION_POLICY_ID_HERE",
      "callingSpid": "SPID_HERE",
      "callingNumber": "CALLING_NUMBER_HERE",
      "status": "ENABLED_OR_DISABLED",
      "method": "METHOD_HERE",
      "action": "ACTION_HERE",
      "originationIdentifierAlgorithm": "RANDOM_OR_AUTOMATIC",
      "useAttestationInfoHeader": TRUE_OR_FALSE,
      "useOriginationIdHeader": TRUE_OR_FALSE,
      "comment": "",
      "identifier": "...",
      "reseller": "CLEARIP_RESELLER_ID_HERE",
      "operator": "CLEARIP_OPERATOR_ID_HERE",
      "sbc": "CLEARIP_SBC_ID_HERE",
      "serviceProvider": "CLEARIP_SERVICE_PROVIDER_ID_HERE",
      "group": "CLEARIP_GROUP_ID_HERE",
      "user": "CLEARIP_USER_ID_HERE",
      "certificate": "CLEARIP_CERTIFICATE_ID_HERE"
    }
  ]
}

Example Request: Add Authentication Policy

{
  "authenticationPolicy": {
    "sbc": null,
    "serviceProvider": null,
    "group": null,
    "user": null,
    "callingSpid": "",
    "callingNumber": "14045266060",
    "originationIdentifierAlgorithm": "random",
    "useAttestationInfoHeader": false,
    "useOriginationIdHeader": false,
    "status": "enabled",
    "method": "in-band",
    "action": "attest-a",
    "certificate": "994f5a9b-d05e-4c19-a3c6-2365e1c6864f",
    "comment": ""
  }
}

Example Response: Add Authentication Policy

{
  "authenticationPolicies": [
    {
      "createdAt": 1595909843471,
      "updatedAt": 1595909843471,
      "id": "29679790-a66b-4cb8-a906-ef879ebc6737",
      "callingSpid": "",
      "callingNumber": "14045266060",
      "originationIdentifierAlgorithm": "random",
      "useAttestationInfoHeader": false,
      "useOriginationIdHeader": false,
      "status": "enabled",
      "method": "in-band",
      "action": "attest-a",
      "comment": "",
      "identifier": "bf783dcd-78cf-49b7-b75f-ffa4c2c7daf6:::14045266065",
      "reseller": "a00c4269-81bb-4ace-b395-cfe000015289",
      "operator": "bf783dcd-78cf-49b7-b75f-ffa4c2c7daf6",
      "sbc": null,
      "serviceProvider": null,
      "group": null,
      "user": null,
      "certificate": "994f5a9b-d05e-4c19-a3c6-2365e1c6864f"
    }
  ]
}

View Authentication Policy for Specific Calling Number

An GET Request can be used to retrieve information about an existing authentication policy. To update or delete an existing authentication policy, you need to reference the existing authentication policy using the ID. Specific parameters within the URL must be set to indicate which policy records should be returned.

This example GET request can be used to return the authentication policy record associated with calling number 14045266060.

Method: GET
URL: https://api.clearip.com/authenticationPolicies?limit=20&skip=0&sort=callingNumber%20ASC&where%5BcallingNumber%5D=14045266060

Response Body:

{
  "authenticationPolicies": [
  {
    "createdAt": CREATED_AT_UNIX_TIME_HERE,
    "updatedAt": UPDATED_AT_UNIX_TIME_HERE,
    "id": "CLEARIP_AUTHENTICATION_POLICY_ID_HERE",
    "callingSpid": "SPID_HERE",
    "callingNumber": "CALLING_NUMBER_HERE",
    "originationIdentifierAlgorithm": "RANDOM_OR_AUTOMATIC",
    "useAttestationInfoHeader": TRUE_OR_FALSE,
    "useOriginationIdHeader": TRUE_OR_FALSE,
    "status": "STATUS_HERE",
    "method": "METHOD_HERE",
    "action": "ACTION_HERE",
    "comment": "COMMENT_HERE",
    "reseller": "CLEARIP_RESELLER_ID_HERE",
    "operator": "CLEARIP_OPERATOR_ID_HERE",
    "sbc": "CLEARIP_SBC_ID_HERE",
    "serviceProvider": "CLEARIP_SERVICE_PROVIDER_ID_HERE",
    "group": "CLEARIP_GROUP_ID_HERE",
    "user": "CLEARIP_USER_ID_HERE",
    "certificate": "CLEARIP_CERTIFICATE_ID_HERE",
    }
  ]
}

Update Existing Authentication Policy

Method: PATCH
URL: https://api.clearip.com/authenticationPolicies/CLEARIP_AUTHENTICATION_POLICY_ID_HERE

Request Body:

{
  "authenticationPolicy": {
    "sbc": "CLEARIP_SBC_ID_HERE",
    "serviceProvider": "CLEARIP_SERVICE_PROVIDER_ID_HERE",
    "group": "CLEARIP_GROUP_ID_HERE",
    "user": "CLEARIP_USER_ID_HERE",
    "callingSpid": "SPID_HERE",
    "callingNumber": "CALLING_NUMBER_HERE",
    "originationIdentifierAlgorithm": "RANDOM_OR_AUTOMATIC",
    "useAttestationInfoHeader": TRUE_OR_FALSE,
    "useOriginationIdHeader": TRUE_OR_FALSE,
    "status": "STATUS_HERE",
    "method": "METHOD_HERE",
    "action": "ACTION_HERE",
    "certificate": "CLEARIP_CERTIFICATE_ID_HERE",
    "comment": "COMMENT_HERE"
  }
}

Response Body:

{
  "authenticationPolicies": [
    {
      "createdAt": CREATED_AT_UNIX_TIME_HERE,
      "updatedAt": UPDATED_AT_UNIX_TIME_HERE,
      "id": "CLEARIP_AUTHENTICATION_POLICY_ID_HERE",
      "callingSpid": "SPID_HERE",
      "callingNumber": "CALLING_NUMBER_HERE",
      "originationIdentifierAlgorithm": "RANDOM_OR_AUTOMATIC",
      "useAttestationInfoHeader": TRUE_OR_FALSE,
      "useOriginationIdHeader": TRUE_OR_FALSE,
      "status": "STATUS_HERE",
      "method": "METHOD_HERE",
      "action": "ACTION_HERE",
      "comment": "COMMENT_HERE",
      "identifier": "...",
      "reseller": "CLEARIP_RESELLER_ID_HERE",
      "operator": "CLEARIP_OPERATOR_ID_HERE",
      "sbc": "CLEARIP_SBC_ID_HERE",
      "serviceProvider": "CLEARIP_SERVICE_PROVIDER_ID_HERE",
      "group": "CLEARIP_GROUP_ID_HERE",
      "user": "CLEARIP_USER_ID_HERE",
      "certificate": "CLEARIP_CERTIFICATE_ID_HERE"
    }
  ]
}

Delete Authentication Policy

Method: DELETE
URL: https://api.clearip.com/authenticationPolicies/CLEARIP_AUTHENTICATION_POLICY_ID_HERE

Response Body:

{
  "authenticationPolicies": [
    {
      "createdAt": CREATED_AT_UNIX_TIME_HERE,
      "updatedAt": UPDATED_AT_UNIX_TIME_HERE,
      "id": "CLEARIP_AUTHENTICATION_POLICY_ID_HERE",
      "callingSpid": "SPID_HERE",
      "callingNumber": "CALLING_NUMBER_HERE",
      "originationIdentifierAlgorithm": "RANDOM_OR_AUTOMATIC",
      "useAttestationInfoHeader": TRUE_OR_FALSE,
      "useOriginationIdHeader": TRUE_OR_FALSE,
      "status": "STATUS_HERE",
      "method": "METHOD_HERE",
      "action": "ACTION_HERE",
      "comment": "COMMENT_HERE",
      "identifier": "...",
      "reseller": "CLEARIP_RESELLER_ID_HERE",
      "operator": "CLEARIP_OPERATOR_ID_HERE",
      "sbc": "CLEARIP_SBC_ID_HERE",
      "serviceProvider": "CLEARIP_SERVICE_PROVIDER_ID_HERE",
      "group": "CLEARIP_GROUP_ID_HERE",
      "user": "CLEARIP_USER_ID_HERE",
      "certificate": "CLEARIP_CERTIFICATE_ID_HERE"
    }
  ]
}