1. OAA Runtime API
  2. Tasks
  3. Preferences

User Preferences are truncated.

put

/oaa/runtime/preferences/v1/truncateuserpreferencessecurely

Truncates user preferences. This API truncates user's preferences. It does not actually remove user from the OAA system.
If uniqueUserId is provided, userId and groupId is ignored.

Request

There are no request parameters for this operation.

Supported Media Types
Request Body - application/xml ()
Root Schema : schema
Type: object
Request object for truncating the preferences.
Show Source
  • Name of the device to be deleted in the user preference associated with factorkey. This is optional field and must also have factorykey if this parameter is provided.
  • factor key to be deleted in the user preference. This is optional field. If the field is missing then it all the factors in the user profile will be deleted.
  • GroupId / ApplicationId of the user whose preferences data is to be deleted. If this parameter is not present then, a value of Default is used.
  • Canonical ID of the user in the external systems. The call can be made using userId and groupId.
  • UserId or loginId of the user whose preferences data is to be deleted.
Request Body - application/json ()
Root Schema : schema
Type: object
Request object for truncating the preferences.
Show Source
  • Name of the device to be deleted in the user preference associated with factorkey. This is optional field and must also have factorykey if this parameter is provided.
  • factor key to be deleted in the user preference. This is optional field. If the field is missing then it all the factors in the user profile will be deleted.
  • GroupId / ApplicationId of the user whose preferences data is to be deleted. If this parameter is not present then, a value of Default is used.
  • Canonical ID of the user in the external systems. The call can be made using userId and groupId.
  • UserId or loginId of the user whose preferences data is to be deleted.
Back to Top

Response

Supported Media Types

201 Response

User preferences are truncated.
Body ()
Root Schema : PrefAPIResponse
Type: object
Show Source

401 Response

Unauthorized

412 Response

Invalid input
Body ()
Root Schema : PrefAPIResponse
Type: object
Show Source

500 Response

Internal server error

503 Response

Service Unavailable
Back to Top

Examples

The following example shows a sample request and response for truncating the user's challenge preferences.

cURL Command to Truncate Challenge Preferences in JSON Format

curl --location --request PUT '<OAAService>/oaa/runtime/preferences/v1/truncateuserpreferencessecurely' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>' \
--data '{
    "userId": "user1",
    "groupId": "financeapp",
    "uniqueUserId": "22a29071-16f2-4b69-a94c-73be672e34eb"
}'

Sample Response in JSON Format

{
    "responseCode": "202",
    "responseMessage": "Deletion is complete"
}

cURL Command to Truncate Challenge Preferences in XML Format

curl --location --request PUT '<OAAService>/oaa/runtime/preferences/v1/truncateuserpreferencessecurely' \
--header 'Content-Type: application/xml' \
--header 'Accept: application/xml' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>' \
--data '<?xml version="1.0" encoding="UTF-8" ?>
 <PrefTruncateRequest>
    <userId>user1</userId>
    <groupId>financeapp4</groupId>
    <uniqueUserId>22a29071-16f2-4b69-a94c-73be672e34eb</uniqueUserId>
 </PrefTruncateRequest>
'

Sample Response in XML Format

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
 <PrefTruncateRequest>
    <userId>user1</userId>
    <groupId>financeapp4</groupId>
    <uniqueUserId>22a29071-16f2-4b69-a94c-73be672e34eb</uniqueUserId>
 </PrefTruncateRequest>
Back to Top