ジャンプ先

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

一時許可の設定

put

/customercare/v1/{customerId}/provision

ユーザーに対する一時許可を設定します。

リクエスト

パス・パラメータ

• customerId(required): string
  ユーザーのuniqueUserIdです。詳細は、ユーザー・プリファレンスAPIを参照してください。

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

• application/xml
• application/json

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

ルート・スキーマ: schema

型: object

ソースを表示

• expirationDate: string (date-time)
  rfc3339セクション5.6の形式の日時文字列。https://tools.ietf.org/html/rfc3339#section-5.6 (例: 2021-08-13T01:29:29.768Z)
• tempAllowType: integer
  customercare.case.tempallow.level.enumの列挙タイプのいずれかにする必要があります

{
    "type":"object",
    "properties":{
        "tempAllowType":{
            "type":"integer",
            "description":"Should be one of the enumerated types in customercare.case.tempallow.level.enum"
        },
        "expirationDate":{
            "$ref":"#/components/schemas/DateTime"
        }
    }
}

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

ルート・スキーマ: schema

型: object

ソースを表示

• expirationDate: string (date-time)
  rfc3339セクション5.6の形式の日時文字列。https://tools.ietf.org/html/rfc3339#section-5.6 (例: 2021-08-13T01:29:29.768Z)
• tempAllowType: integer
  customercare.case.tempallow.level.enumの列挙タイプのいずれかにする必要があります

{
    "type":"object",
    "properties":{
        "tempAllowType":{
            "type":"integer",
            "description":"Should be one of the enumerated types in customercare.case.tempallow.level.enum"
        },
        "expirationDate":{
            "$ref":"#/components/schemas/DateTime"
        }
    }
}

先頭に戻る

レスポンス

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

• application/xml
• application/json

200レスポンス

成功

本文()

ルート・スキーマ: StatusResponse

型: object

APIコールのステータス情報

ソースを表示

• responseCode: string
  リクエストのステータス・コード
• responseMessage: string
  レスポンス・コードに関連するレスポンス・メッセージ(必要に応じて)。
• sessionId: string
  認証のセッションID。
• status: boolean
  認証更新リクエスト・ステータス

{
    "type":"object",
    "description":"Status information for API call",
    "properties":{
        "responseCode":{
            "type":"string",
            "description":"status code of the request"
        },
        "responseMessage":{
            "type":"string",
            "description":"response message related to the response code if needed."
        },
        "status":{
            "type":"boolean",
            "description":"authentication update request status"
        },
        "sessionId":{
            "type":"string",
            "description":"session id of the authentcation."
        }
    }
}

400レスポンス

無効な入力

404レスポンス

顧客IDが見つかりません

先頭に戻る

例

次の例は、ユーザーに一時的な許可権限を付与するサンプルのリクエストとレスポンスを示しています。

JSON形式で一時的な許可を付与するcURLコマンド

curl --location --request PUT '<RISKCC>/risk-cc/customercare/v1/{customerId}/provision' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>' \
--data '{
"tempAllowType":1,
"expirationDate":"2021-10-15T01:29:29.768Z"
}'

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

{
    "responseCode": "0",
    "responseMessage": "",
    "status": true
}

XML形式で一時的な許可を付与するcURLコマンド

curl --location --request PUT '<RISKCC>/risk-cc/customercare/v1/{customerId}/provision' \
--header 'Content-Type: application/xml' \
--header 'Accept: application/xml' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>'
--data '<?xml version="1.0" encoding="UTF-8" ?>
<TempAllowRequest>
<tempAllowType>1</tempAllowType>
<expirationDate>2025-10-15T01:29:29.768Z</expirationDate>
</TempAllowRequest>
'

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

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<StatusResponse>
    <responseCode>0</responseCode>
    <responseMessage></responseMessage>
    <status>true</status>
</StatusResponse>

先頭に戻る