ジャンプ先

• リクエスト
• レスポンス
• 例

ユーザー・プリファレンスが切り捨てられる。

put

/oaa/runtime/preferences/v1/truncateuserpreferencessecurely

ユーザー・プリファレンスを切り捨てる。このAPIは、ユーザーのプリファレンスを切り捨てます。OAAシステムからユーザーが実際に削除されることはありません。

APIコールには、userIdおよびgroupIdを含める必要があります。uniqueUserIdが指定されている場合は、ユーザーを一意に識別するために使用されます。uniqueUserIdが指定されていない場合は、userIdとgroupIdの組合せを使用してユーザーを一意に識別します。

リクエスト

この操作にはリクエスト・パラメータはありません。

サポートされているメディア・タイプ

• application/xml
• application/json

リクエスト本文 - application/xml ()

ルート・スキーマ: schema

型: object

プリファレンスを切り捨てるためのリクエスト・オブジェクト。

ソースの表示

• devicename: string
  factorkeyに関連付けられたユーザー・プリファレンスで削除されるデバイスの名前。これはオプションのフィールドで、このパラメータを指定する場合はfactorykeyも必要です。
• factorkey: string
  ユーザー・プリファレンスで削除するファクタ・キー。これはオプション・フィールドです。フィールドがない場合は、ユーザー・プロファイル内のすべてのファクタが削除されます。
• groupId(required): string
  プリファレンス・データを削除するユーザーのGroupId/ApplicationId。このパラメータが存在しない場合は、Defaultという値が使用されます。
• uniqueUserId: string
  外部システムのユーザーの正規のID。このコールは、userIdおよびgroupIdを使用して実行できます。
• userId(required): string
  プリファレンス・データを削除するユーザーのuserIdまたはloginId。

{
    "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."
        }
    }
}

リクエスト本文 - application/json ()

ルート・スキーマ: schema

型: object

プリファレンスを切り捨てるためのリクエスト・オブジェクト。

ソースの表示

• devicename: string
  factorkeyに関連付けられたユーザー・プリファレンスで削除されるデバイスの名前。これはオプションのフィールドで、このパラメータを指定する場合はfactorykeyも必要です。
• factorkey: string
  ユーザー・プリファレンスで削除するファクタ・キー。これはオプション・フィールドです。フィールドがない場合は、ユーザー・プロファイル内のすべてのファクタが削除されます。
• groupId(required): string
  プリファレンス・データを削除するユーザーのGroupId/ApplicationId。このパラメータが存在しない場合は、Defaultという値が使用されます。
• uniqueUserId: string
  外部システムのユーザーの正規のID。このコールは、userIdおよびgroupIdを使用して実行できます。
• userId(required): string
  プリファレンス・データを削除するユーザーのuserIdまたはloginId。

{
    "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."
        }
    }
}

先頭に戻る

レスポンス

サポートされているメディア・タイプ

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

201レスポンス

ユーザー・プリファレンスが切り捨てられる。

本文()

ルート・スキーマ: PrefAPIResponse

型: object

ソースの表示

• responseCode: string
• responseMessage: string

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

401レスポンス

未認可

412レスポンス

無効な入力

本文()

ルート・スキーマ: PrefAPIResponse

型: object

ソースの表示

• responseCode: string
• responseMessage: string

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

500レスポンス

内部サーバー・エラー

503レスポンス

サービス使用不可

先頭に戻る

例

次の例は、ユーザーのチャレンジ・プリファレンスを切り捨てるためのリクエストとレスポンスのサンプルを示しています。

JSON形式でuniqueUserIdを指定してチャレンジ・プリファレンスを切り捨てるcURLコマンド

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"
}'

JSON形式のサンプル・レスポンス

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

XML形式でuniqueUserIdを指定してチャレンジ・プリファレンスを切り捨てるcURLコマンド

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>
'

XML形式のサンプル・レスポンス

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

uniqueUserIdを指定せずにJSON形式でチャレンジ・プリファレンスを切り捨てるcURLコマンド

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"
}'

JSON形式のサンプル・レスポンス

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

uniqueUserIdを指定せずにXML形式でチャレンジ・プリファレンスを切り捨てるcURLコマンド

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>'

XML形式のサンプル・レスポンス

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

先頭に戻る