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.

The API call must include userId and groupId. If uniqueUserId is provided, It is used to uniquely identify the user. If uniqueUserId is not provided, the combination of userId and groupId is used to uniquely identify the user.

Request

There are no request parameters for this operation.

Supported Media Types

• application/xml
• application/json

Request Body - application/xml ()

Root Schema : schema

Type: object

Request object for truncating the preferences.

Show Source

• devicename: string
  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.
• factorkey: string
  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(required): string
  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.
• uniqueUserId: string
  Canonical ID of the user in the external systems. The call can be made using userId and groupId.
• userId(required): string
  UserId or loginId of the user whose preferences data is to be deleted.

{
    "type":"object",
    "description":"Request object for truncating the preferences.",
    "required":[
        "userId",
        "groupId"
    ],
    "properties":{
        "userId":{
            "description":"UserId or loginId of the user whose preferences data is to be deleted.",
            "type":"string"
        },
        "groupId":{
            "type":"string",
            "description":"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."
        },
        "uniqueUserId":{
            "type":"string",
            "description":"Canonical ID of the user in the external systems. The call can be made using userId and groupId."
        },
        "factorkey":{
            "type":"string",
            "description":"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."
        },
        "devicename":{
            "type":"string",
            "description":"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."
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Request object for truncating the preferences.

Show Source

• devicename: string
  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.
• factorkey: string
  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(required): string
  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.
• uniqueUserId: string
  Canonical ID of the user in the external systems. The call can be made using userId and groupId.
• userId(required): string
  UserId or loginId of the user whose preferences data is to be deleted.

{
    "type":"object",
    "description":"Request object for truncating the preferences.",
    "required":[
        "userId",
        "groupId"
    ],
    "properties":{
        "userId":{
            "description":"UserId or loginId of the user whose preferences data is to be deleted.",
            "type":"string"
        },
        "groupId":{
            "type":"string",
            "description":"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."
        },
        "uniqueUserId":{
            "type":"string",
            "description":"Canonical ID of the user in the external systems. The call can be made using userId and groupId."
        },
        "factorkey":{
            "type":"string",
            "description":"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."
        },
        "devicename":{
            "type":"string",
            "description":"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."
        }
    }
}

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 with uniqueUserId 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": "user1"
}'

Sample Response in JSON Format

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

cURL Command to Truncate Challenge Preferences with uniqueUserId 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>financeapp</groupId>
    <uniqueUserId>user1</uniqueUserId>
 </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>

cURL Command to Truncate Challenge Preferences in JSON Format Without Specifying uniqueUserId

curl --location --request PUT '<OAAService>/oaa/runtime/preferences/v1/truncateuserpreferencessecurely' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>' \
--data '{
    "userId" : "user6",
    "groupId" :"financeapp"
}'

Sample Response in JSON Format

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

cURL Command to Truncate Challenge Preferences in XML Format Without Specifying uniqueUserId

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>user5</userId>
    <groupId>financeapp</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