Important: This API is deprecated and should no longer be used. Use the updated API in /configuration instead.
Method Details
| HTTPS Method | Entity Action | Request URI | Description |
|---|---|---|---|
|
GET |
Read |
/scim/{tenant}/v2/Policy/Authenticator/{id}:(String) |
Retrieve authenticator policy |
|
GET |
Read |
/scim/{tenant}/v2/Policy/Authenticator/ |
Get all authenticator policies |
Required Permissions
| Function | Required Permissions |
|---|---|
|
GET |
|
|
GET ALL |
|
Get a Password Authenticator Policy
[GET] /Policy/Authenticator/{id}
Where {id} is the Authentication Policy (for further details, see Configure Authentication Policies).
Copy
Sample Response
{
"schemas": [
"urn:hid:scim:api:idp:2.0:policy:Authenticator",
"urn:hid:scim:api:idp:2.0:policy:authenticator:Password"
],
"id": "AT_EMPPWD",
"meta": {
"resourceType": "AuthenticatorPolicy",
"location": "https://scim.example.com/scim/domain/v2/Policy/Authenticator/AT_EMPPWD",
"version": "1"
},
"allowExpiredReset": "3",
"challengeDisableThreshold": "-1",
"defaultExpiryThreshold": "-1",
"challengeTimeoutPeriod": "-1",
"defaultValidDaysAdd": "1825",
"defaultValidDaysEdit": "1825",
"name": "Employee Static Password",
"notes": "Static password login for employee authentication",
"sessionTimeout": "3600000",
"sessionValidPeriod": "86400000",
"validChannelCodes": [
"CH_IIS",
"CH_SSP",
"CH_STAP",
"CH_TRMSVC",
"CH_VPN"
],
"onlyIndirect": "false",
"urn:hid:scim:api:idp:2.0:policy:authenticator:Password": {
"passwordpolicy": {
"numOrAlpha": "true",
"maxLength": "20",
"minLength": "6",
"notEnglish": "true",
"minDiffChars": "3",
"caseInsensitive": "true",
"notUserAttribute": "true"
},
"seedingType": "BOTH",
"disableThreshold": "8"
}
}Get a Security Question Authenticator Policy
[GET] /Policy/Authenticator/{id}
Copy
Sample Response
{
"schemas": [
"urn:hid:scim:api:idp:2.0:policy:Authenticator",
"urn:hid:scim:api:idp:2.0:policy:authenticator:SecurityQuestion"
],
"id": "AT_EMPQA",
"meta": {
"resourceType": "AuthenticatorPolicy",
"location": "https://scim.example.com/scim/domain/v2/Policy/Authenticator/AT_EMPQA",
"version": "1"
},
"allowExpiredReset": "0",
"challengeDisableThreshold": "-1",
"defaultExpiryThreshold": "0",
"challengeTimeoutPeriod": "-1",
"defaultValidDaysAdd": "1825",
"defaultValidDaysEdit": "1825",
"failureDisplay": "ALL",
"name": "Employee Emergency Questions & Answers",
"notes": "Emergency authentication for employees",
"sessionTimeout": "3600000",
"sessionValidPeriod": "86400000",
"validChannelCodes": [
"CH_IIS",
"CH_SSP",
"CH_STAP",
"CH_TRMSVC",
"CH_VPN"
],
"onlyIndirect": "false",
"urn:hid:scim:api:idp:2.0:policy:authenticator:SecurityQuestion": {
"prompts": [
{
"prompt": {
"display": "In what town was your first job?",
"value": "PR_1ST_JOB"
},
"policy": {
"maxLength": "20",
"minLength": "4",
"caseInsensitive": "true"
}
},
{
"prompt": {
"display": "Enter a memorable word (greater than 8 chars)",
"value": "PR_MEMWRD"
},
"policy": {
"maxLength": "20",
"minLength": "4",
"caseInsensitive": "true"
}
},
{
"prompt": {
"display": "Where does your nearest sibling live",
"value": "PR_PLACE"
},
"policy": {
"maxLength": "20",
"minLength": "4",
"caseInsensitive": "true"
}
},
{
"prompt": {
"display": "Childhood ph num including area code",
"value": "PR_PHONE"
},
"policy": {
"maxLength": "20",
"minLength": "4",
"caseInsensitive": "true"
}
},
{
"prompt": {
"display": "Childhood nickname",
"value": "PR_NICK"
},
"policy": {
"maxLength": "20",
"minLength": "4",
"caseInsensitive": "true"
}
},
{
"prompt": {
"display": "Name of your elementary/primary school?",
"value": "PR_E_SCHL"
},
"policy": {
"maxLength": "20",
"minLength": "4",
"caseInsensitive": "true"
}
},
{
"prompt": {
"display": "City or town did your mother and father meet",
"value": "PR_TOWN"
},
"policy": {
"maxLength": "20",
"minLength": "4",
"caseInsensitive": "true"
}
},
{
"prompt": {
"display": "Color of your first car",
"value": "PR_CAR_CLR"
},
"policy": {
"maxLength": "20",
"minLength": "4",
"caseInsensitive": "true"
}
},
{
"prompt": {
"display": "City you met your spouse/significant other",
"value": "PR_MEET"
},
"policy": {
"maxLength": "20",
"minLength": "4",
"caseInsensitive": "true"
}
},
{
"prompt": {
"display": "Your youngest brother's birthday",
"value": "PR_BR_BDAY"
},
"policy": {
"maxLength": "20",
"minLength": "4",
"caseInsensitive": "true"
}
}
],
"promptsRequiredForCreation": "3"
}
}Get All Authenticator Policies
[GET] /Policy/Authenticator/{id}
Copy
Sample Response
{
"schemas": ["urn:ietf:params:scim:api:messages:2.0:ListResponse"],
"totalResults": 36,
"resources": [
{
"schemas": [
"urn:hid:scim:api:idp:2.0:policy:Authenticator",
"urn:hid:scim:api:idp:2.0:policy:authenticator:SecurityQuestion"
],
"id": "AT_EMPQA",
"meta": {
"resourceType": "AuthenticatorPolicy",
"location": "https://scim.example.com/scim/domain/v2/Policy/Authenticator/AT_EMPQA",
"version": "1"
},
************** TRUNCATED OUPUT **************
