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.
The API version supported by HID Authentication Service is
Previous versions of the API are also supported with the corresponding functionality.
Method Details
HTTPS Method | Entity Action | Request URI | Description |
---|---|---|---|
Read |
/configuration/{tenant}/v2/RiskScoreProvider |
Get the list of all Risk Score Providers |
|
Read |
/configuration/{tenant}/v2/RiskScoreProvider/{uid} |
Get a Risk Score Provider |
|
Create |
/configuration/{tenant}/v2/RiskScoreProvider |
Create a Risk Score Provider |
|
Replace |
/configuration/{tenant}/v2/RiskScoreProvider/{uid} |
Replace a Risk Score Provider |
|
Delete |
/configuration/{tenant}/v2/RiskScoreProvider/{uid} |
Delete a Risk Score Provider |
Get All Risk Score Providers
GET /RiskScoreProvider
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.
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
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": ""
}
}
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.
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
}
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.