Applications (Generic) REST API
The Application/Generic endpoint allows creating and managing channels through which users can authenticate to HID Authentication Service.
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/Application/Generic |
Retrieve the list of all Generic Applications |
|
Read |
/configuration/{tenant}/v2/ Application/Generic /{uid} |
Retrieve a Generic Application |
|
Create |
/configuration/{tenant}/v2/ Application/Generic |
Create a Generic Application |
|
Replace |
/configuration/{tenant}/v2/ Application/Generic /{uid} |
Replace a Generic Application |
|
Delete |
/configuration/{tenant}/v2/ Application/Generic /{uid} |
Delete a Generic Application |
Get All Generic Applications
GET /Application/Generic
Sample Response
{
"schemas": ["urn:ietf:params:scim:api:messages:2.0:ListResponse"],
"totalResults": 16,
"resources": [
{
"schemas": ["urn:hid:scim:api:idp:2.0:Application"],
"id": "CH_DIRECT",
"meta": {
"resourceType": "Authentication Workflow",
"location": "https://[base-server-url]/scim/tenant/v2/Application/Generic/CH_DIRECT",
"version": "1"
},
"name": "Direct channel",
"notes": "Direct use of the Public API channel",
"type": "Generic"
},
{
"schemas": ["urn:hid:scim:api:idp:2.0:Application"],
"id": "CH_TRMSVC",
"meta": {
"resourceType": "Authentication Workflow",
"location": "https://[base-server-url]/scim/tenant/v2/Application/Generic/CH_TRMSVC",
"version": "1"
},
"name": "Terminal Services",
"notes": "Citrix and Microsoft Terminal Services channel",
"type": "Generic"
},
<--- truncated output --->
]
}
Get a Generic Application
GET /Application/Generic/{uid}
where {uid} is the application id.
Sample Response
{
"schemas": ["urn:hid:scim:api:idp:2.0:Application"],
"id": "CH_ADFS",
"meta": {
"resourceType": "Authentication Workflow",
"location": "https://[base-server-url]/scim/tenant/v2/Application/Generic/CH_ADFS",
"version": "1"
},
"name": "ADFS Agent",
"notes": "ADFS Agent Channel",
"type": "Generic",
"riskScoreProvider": {},
"authenticationPolicies": [
{
"type": "Authenticator",
"value": "AT_ADSOTP",
"$ref": "https://[base-server-url]/scim/tenant/v2/Policy/Authenticator/AT_ADSOTP"
},
{
"type": "Authenticator",
"value": "AT_ADFSAPW",
"$ref": "https://[base-server-url]/scim/tenant/v2/Policy/Authenticator/AT_ADFSAPW"
}
],
"adaptativeAuthenticationRules": {}
}
Create a Generic Application
POST /Application/Generic
Sample Request
{
"id": "CH_2020",
"name": "HID Banking Demo App",
"notes": "Demo app for banking",
"riskScoreProvider": {
"value": "12930",
"failOpenBehavior": true,
"rmschannelId": "IB",
"rmsapplicationId": "HID-Demo"
},
"authenticationPolicies": [
{"value": "AT_CUSTPKI"},
{"value": "AT_PASA"},
{"value": "AT_FIDO"},
{"value": "AT_CUSTOTP"},
{"value": "AT_CUSTPW"}
],
"adaptativeAuthenticationRules": {
"primaryAuthnBlock": [
{
"type": "GlobalRiskScore",
"minValue": 900
}
],
"primaryAuthnReject": [],
"stepUp": [
{
"initialPolicies": [
{
"value": "AT_CUSTPW"
}
],
"conditions": [
{
"type": "GlobalRiskScore",
"minValue": 200
},
{
"type": "DeviceRiskScore",
"minValue": 150
}
],
"stepUpPolicies": [
{
"value": "AT_PASA"
},
{
"value": "AT_FIDO"
}
]
}
],
"secondaryAuthnBlock": [],
"secondaryAuthnReject": []
}
}
Sample Response
{
"schemas": ["urn:hid:scim:api:idp:2.0:Application"],
"id": "CH_2020",
"meta": {
"resourceType": "Authentication Workflow",
"location": "https://[base-server-url]/scim/tenant/v2/Application/Generic/CH_2020",
"version": "1"
},
"name": "HID Banking Demo App",
"notes": "Demo app for banking",
"type": "Generic",
"riskScoreProvider": {
"value": "12930",
"failOpenBehavior": true,
"rmschannelId": "IB",
"rmsapplicationId": "HID-Demo",
"$ref": "https://[base-server-url]/scim/tenant/v2/RiskScoreProvider/12930"
},
"authenticationPolicies": [
{
"type": "Authenticator",
"value": "AT_PASA",
"$ref": "https://[base-server-url]/scim/tenant/v2/Policy/Authenticator/AT_PASA"
},
{
"type": "Authenticator",
"value": "AT_CUSTOTP",
"$ref": "https://[base-server-url]/scim/tenant/v2/Policy/Authenticator/AT_CUSTOTP"
},
{
"type": "Authenticator",
"value": "AT_CUSTPW",
"$ref": "https://[base-server-url]/scim/tenant/v2/Policy/Authenticator/AT_CUSTPW"
},
{
"type": "Authenticator",
"value": "AT_CUSTPKI",
"$ref": "https://[base-server-url]/scim/tenant/v2/Policy/Authenticator/AT_CUSTPKI"
},
{
"type": "Authenticator",
"value": "AT_FIDO",
"$ref": "https://[base-server-url]/scim/tenant/v2/Policy/Authenticator/AT_FIDO"
}
],
"adaptativeAuthenticationRules": {
"primaryAuthnBlock": [{
"type": "GlobalRiskScore",
"minValue": 900
}],
"stepUp": [{
"initialPolicies": [{
"type": "Authenticator",
"value": "AT_CUSTPW",
"$ref": "https://[base-server-url]/scim/tenant/v2/Policy/Authenticator/AT_CUSTPW"
}],
"conditions": [
{
"type": "GlobalRiskScore",
"minValue": 200
},
{
"type": "DeviceRiskScore",
"minValue": 150
}
],
"stepUpPolicies": [
{
"type": "Authenticator",
"value": "AT_PASA",
"$ref": "https://[base-server-url]/scim/tenant/v2/Policy/Authenticator/AT_PASA"
},
{
"type": "Authenticator",
"value": "AT_FIDO",
"$ref": "https://[base-server-url]/scim/tenant/v2/Policy/Authenticator/AT_FIDO"
}
]
}]
}
}
Update a Generic Application
PUT /Application/Generic/{uid}
where {uid} is the adapter id.
Sample request where notes and rmsapplicationId are updated and two authentication policies are removed
{
"schemas": ["urn:hid:scim:api:idp:2.0:Application"],
"id": "CH_2020",
"notes": "Demo app for banking (updated)",
"riskScoreProvider": {
"value": "12930",
"rmsapplicationId": "HID-Demo (updated)"
},
"authenticationPolicies": [
{"value": "AT_FIDO"},
{"value": "AT_PASA"},
{"value": "AT_CUSTPW"}
]
}
Sample Response
{
"schemas": ["urn:hid:scim:api:idp:2.0:Application"],
"id": "CH_2020",
"meta": {
"resourceType": "Authentication Workflow",
"location": "https://[base-server-url]/scim/tenant/v2/Application/Generic/CH_2020",
"version": "1"
},
"name": "HID Banking Demo App",
"notes": "Demo app for banking (updated)",
"type": "Generic",
"riskScoreProvider": {
"value": "12930",
"failOpenBehavior": true,
"rmschannelId": "IB",
"rmsapplicationId": "HID-Demo (updated)",
"$ref": "https://[base-server-url]/scim/tenant/v2/RiskScoreProvider/12930"
},
"authenticationPolicies": [
{
"type": "Authenticator",
"value": "AT_PASA",
"$ref": "https://[base-server-url]/scim/tenant/v2/Policy/Authenticator/AT_PASA"
},
{
"type": "Authenticator",
"value": "AT_CUSTPW",
"$ref": "https://[base-server-url]/scim/tenant/v2/Policy/Authenticator/AT_CUSTPW"
},
{
"type": "Authenticator",
"value": "AT_FIDO",
"$ref": "https://[base-server-url]/scim/tenant/v2/Policy/Authenticator/AT_FIDO"
}
],
"adaptativeAuthenticationRules": {
"primaryAuthnBlock": [{
"type": "GlobalRiskScore",
"minValue": 900
}],
"stepUp": [{
"initialPolicies": [{
"type": "Authenticator",
"value": "AT_CUSTPW",
"$ref": "https://[base-server-url]/scim/tenant/v2/Policy/Authenticator/AT_CUSTPW"
}],
"conditions": [
{
"type": "GlobalRiskScore",
"minValue": 200
},
{
"type": "DeviceRiskScore",
"minValue": 150
}
],
"stepUpPolicies": [
{
"type": "Authenticator",
"value": "AT_PASA",
"$ref": "https://[base-server-url]/scim/tenant/v2/Policy/Authenticator/AT_PASA"
},
{
"type": "Authenticator",
"value": "AT_FIDO",
"$ref": "https://[base-server-url]/scim/tenant/v2/Policy/Authenticator/AT_FIDO"
}
]
}]
}
}
Delete a Generic Application
DELETE /Application/Generic/{uid}
Where {uid} is the adapter id.