Jump to

• Request
• Response
• Examples

Deprecated - User Preferences are deleted.

delete

/oaa/runtime/preferences/v1

Deprecated Please use deleteuserpreferencessecurely API.This API deletes user's preference for the given userid and group .

Request

Query Parameters

• 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: 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
  Immutable ID of the user in the external systems. If this is present, then it takes precedence over userId + groupId combination.
• userId(required): string
  UserId or loginId of the user whose preferences data is to be deleted.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

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

201 Response

User preferences are deleted.

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 deleting user's preferences. It does not actually remove users from the OAA system. For users that have deleted preferences, one cannot invoke create preferences again (POST operation). Instead, update preferences should be used.

cURL Command to Delete User's Preferences in JSON Format

curl --location --request DELETE '<OAAService>/oaa/runtime/preferences/v1?userId=testuser1&groupId=default \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>'

Sample Response in JSON Format

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

Back to Top