To enable transaction validation via SMS for an end user, you need to register an OOB credential for the end user using the SCIM API REGISTER-OOB function.
Specific parameters to generate a transaction validation OOB credential:
- OOB_CREDENTIALTYPE_CODE – credential type for transaction validation OOB
- OOB_DEVICETYPE_CODE – device type for transaction validation OOB
- useActivationCode – set to false so an activation code credential is not created (not required for transaction validation as only an OOB credential is needed)
Copy
Sample request
POST https://scim.example.com/SCIM/domain/v2/Authenticator HTTP/1.1Content-Type: application/scim+json
Authorization: Bearer RTp7HwAAAW0VlDTQhCrk4etgkODKVAsWIkpJUNL2
{
"schemas": ["urn:hid:scim:api:idp:2.0:Authenticator"],
"urn:hid:scim:api:idp:2.0:Action": {
"action": "REGISTER-OOB",
"attributes": [{
"name": "OOB_CREDENTIALTYPE_CODE",
"value": "CT_TXOOB"
}, {
"name": "OOB_DEVICETYPE_CODE",
"value": "DT_TXOOB"
}]
},
"owner": {
"display": "SMS_User"
},
"policy": {
"value": "AT_TXOOB"
},
"useActivationCode": false
}Copy
Sample response
HTTP/1.1 201 Created
Cache-Control: no-cache
Pragma: no-cache
X-Content-Type-Options: nosniff
Content-Type: application/scim+json;charset=utf-8
{
"schemas": ["urn:hid:scim:api:idp:2.0:Authenticator"],
"id": "21032.AT_TXOOB",
"externalId": "SMS_User",
"meta": {
"resourceType": "Authenticator",
"created": "2019-09-09T15:11:11Z",
"location": "https://scim.example.com/SCIM/domain/v2/Authenticator/21032.AT_TXOOB",
"version": "1"
},
"status": {
"status": "ENABLED",
"active": true,
"expiryDate": "2024-09-07T15:11:11Z",
"startDate": "2019-09-09T15:11:11Z"
},
"owner": {
"type": "User",
"display": "SMS_User",
"value": "21032",
"$ref": "https://scim.example.com/SCIM/domain/v2/Users/21032"
},
"statistics": {
"consecutiveFailed": "0",
"consecutiveSuccess": "0",
"maximumNumberOfUsages": "0",
"totalFailed": "0",
"totalSuccess": "0"
},
"policy": {
"display": "AT_TXOOB",
"value": "AT_TXOOB",
"$ref": "https://scim.example.com/SCIM/domain/v2/Policy/Authenticator/AT_TXOOB"
}
}Result - the authenticator and device with credential are created as follows:
