Risk Score Provider REST API

The RiskScoreProvider endpoint allows managing the configuration of the HID Risk Management Solution service provider used to fetch and validate risk scores.

Note: The API version supported by HID Authentication Service is 10.1.0.

To use the version-specific parameters/attributes, you must add api-version=N to the query parameter.

Previous versions of the API are also supported with the corresponding functionality. For details of the version updates, see SCIM API Revision History.

Method Details

HTTPS Method	Entity Action	Request URI	Description
GET	Read	/configuration/{tenant}/v2/RiskScoreProvider	Get the list of all Risk Score Providers
GET	Read	/configuration/{tenant}/v2/RiskScoreProvider/{uid}	Get a Risk Score Provider
POST	Create	/configuration/{tenant}/v2/RiskScoreProvider	Create a Risk Score Provider
PUT	Replace	/configuration/{tenant}/v2/RiskScoreProvider/{uid}	Replace a Risk Score Provider
DELETE	Delete	/configuration/{tenant}/v2/RiskScoreProvider/{uid}	Delete a Risk Score Provider

Required Permissions

Function	Required Permissions
GET ALL	Read reference data
GET	Read reference data
CREATE	Read reference data Manage OOB Adapter Configuration
REPLACE	Read reference data Manage OOB Adapter Configuration
DELETE	Read reference data Manage OOB Adapter Configuration

Get All Risk Score Providers

GET /RiskScoreProvider

Copy

Sample Request URI

GET /configuration/{tenant}/v2/RiskScoreProvider

Copy

Sample Request

GET /configuration/{tenant}/v2/RiskScoreProvider

Copy

Sample Response

{
   "schemas": ["urn:ietf:params:scim:api:messages:2.0:ListResponse"],
   "totalResults": 2,
   "resources": [
      {
         "schemas": ["urn:hid:scim:api:idp:2.0:RiskScoreProvider"],
         "id": "12670",
         "externalId": "RMS_CFG_TM",
         "meta": {
            "resourceType": "Risk Score Provider",
            "location": "https://[base-server-url]/configuration/tenant/v2/RiskScoreProvider/12670",
            "version": "1"
         },
         "name": "HID RMS",
         "url": "https://c120.rms.com:8053/v3",
         "connectionTimeOut": 10000,
         "credentials": {
            "apiKey": "",
            "user": "Test",
            "password": ""
         }
      },
            <--- truncated output --->
   ]
}

Get Risk Score Provider

GET /RiskScoreProvider/{uid}

Where {uid} is the adapter id.

Copy

Sample Request URI

GET /configuration/{tenant}/v2/RiskScoreProvider/12670

Copy

Sample Request

GET /configuration/{tenant}/v2/RiskScoreProvider/12670

Copy

Sample Response

{
   "schemas": ["urn:hid:scim:api:idp:2.0:RiskScoreProvider"],
   "id": "12670",
   "externalId": "RMS_CFG_TM",
   "meta": {
      "resourceType": "Risk Score Provider",
      "location": "https://[base-server-url]/configuration/tenant/v2/RiskScoreProvider/12670",
      "version": "1"
   },
   "name": "HID RMS",
   "url": "https://c120.rms.com:8053/v3",
   "connectionTimeOut": 10000,
   "credentials": {
      "apiKey": "",
      "user": "Test",
      "password": ""
   }
}

Create Risk Score Provider

POST /RiskScoreProvider

Copy

Sample Request URI

POST /configuration/{tenant}/v2/RiskScoreProvider

Copy

Sample Request

{
   "schemas": ["urn:hid:scim:api:idp:2.0:RiskScoreProvider"],
   "externalId": "RMS_CFG_TM",
   "name": "HID RMS 2",
   "url": "https://c120.rms.com:8053/v2",
   "connectionTimeOut": 20000,
   "credentials":    {
      "apiKey": "",
      "user": "Test2",
      "password": ""
   }
}

Copy

Sample Response

{
   "schemas": ["urn:hid:scim:api:idp:2.0:RiskScoreProvider"],
   "id": "12910",
   "externalId": "RMS_CFG_TM",
   "meta":    {
      "resourceType": "Risk Score Provider",
      "location": "https://[base-server-url]/configuration/tenant/v2/RiskScoreProvider/12910",
      "version": "1"
   },
   "name": "HD RMS 2",
   "url": "https://c120.rms.com:8053/v2",
   "connectionTimeOut": 20000,
   "credentials":    {
      "apiKey": "",
      "user": "Test2",
      "password": ""
   }
}

Replace Risk Score Provider

PUT /RiskScoreProvider/{uid}

Where {uid} is the resource ID.

Note: As a best practice, use GET to retrieve the current data for the resource before using PUT.

Copy

Sample Request URI

PUT /configuration/{tenant}/v2/RiskScoreProvider/12670

Copy

Sample request where notes are added and the connectionTimeout is changed

{
   "schemas": ["urn:hid:scim:api:idp:2.0:RiskScoreProvider"],
   "externalId": "RMS_CFG_TM",
   "notes": "HID RMS RSP",
   "connectionTimeOut": 40000
}

Copy

Sample Response

{
   "schemas": ["urn:hid:scim:api:idp:2.0:RiskScoreProvider"],
   "id": "12670",
   "externalId": "RMS_CFG_TM",
   "meta": {
      "resourceType": "Risk Score Provider",
      "location": "https://[base-server-url]/configuration/tenant/v2/RiskScoreProvider/12670",
      "version": "1"
   },
   "name": "HID RMS",
   "notes": "HID RMS RSP",
   "url": "https://c120.rms.com:8053/v3",
   "connectionTimeOut": 40000,
   "credentials": {
      "apiKey": "",
      "user": "Test",
      "password": ""
   }
}

Delete Risk Score Provider

DELETE /RiskScoreProvider/{uid}

Where {uid} is the adapter id.

Copy

Sample Request URI

DELETE /configuration/{tenant}/v2/RiskScoreProvider/12670

Copy

Sample Response

HTTP 204 No Content