Jump to

• Request
• Response
• Examples

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.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/xml
• application/json
• text/plain

201 Response

User preferences are truncated.

Body ()

Root Schema : PrefAPIResponse

Type: object

Show Source

• responseCode: string
• responseMessage: string

{
    "type":"object",
    "properties":{
        "responseCode":{
            "type":"string"
        },
        "responseMessage":{
            "type":"string"
        }
    }
}

401 Response

Unauthorized

412 Response

Invalid input

Body ()

Root Schema : PrefAPIResponse

Type: object

Show Source

• responseCode: string
• responseMessage: string

{
    "type":"object",
    "properties":{
        "responseCode":{
            "type":"string"
        },
        "responseMessage":{
            "type":"string"
        }
    }
}

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": "testuser4",
    "groupId": "testfinanceapp4"
}'

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>testuser4</userId>
     <groupId>testfinanceapp4</groupId>
 </PrefTruncateRequest>
'

Sample Response in XML Format

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
 <PrefAPIResponse
     <responseCode>202</responseCode>
     <responseMessage>Deletion is complete</responseMessage>
 </PrefAPIResponse

Back to Top