PlatioDeleteUser - Platioユーザーの削除

Platioユーザーを削除します。
共通ユーザー機能が有効な場合には使用できません。

■ストリーム情報

入力フォーマットすべて
接続数無制限
説明 入力ストリームは使用せず、すべて無視します。
出力フォーマットすべて
説明 入力ストリームをそのまま出力します。

■コンポーネントプロパティ

名前プロパティ型マッピング説明
コネクションを使用boolean- 接続先に以下のコネクション名 を使用するかどうか選択します。
はい [true] - 以下のコネクション名 で指定されたPlatio接続名を接続先として使用します。
いいえ [false] - コネクション情報 以下のプロパティを使ってPlatioに接続を行います。
コネクション名connection-コネクションを使用 が「はい」の場合に、Platioアプリケーションへの接続用コネクションを指定します。
コネクションペインまたは管理コンソールにて作成した接続名を選択します。
コネクション情報group-コネクションを使用 プロパティが「いいえ」の場合に使用されるプロパティ群です。
アプリケーションベースURLstring入力&出力 PlatioのアプリケーションベースURLを指定します。
指定するURLは「 https://api.plat.io/v1/[アプリケーションのID] 」の形式で指定します。 コネクションを使用 が「いいえ」の場合にこの設定が参照されます。
トークンIDstring入力&出力 Platioの開発者向け情報ページから取得したAPIトークンのトークンIDを指定します。
詳細については下記トピック「APIトークンの取得方法」を参照してください。
コネクションを使用 が「いいえ」の場合にこの設定が参照されます。
秘密トークンpassword入力&出力 Platioの開発者向け情報ページから取得したAPIトークンの秘密トークンを指定します。
詳細については下記トピック「APIトークンの取得方法」を参照してください。
コネクションを使用 が「いいえ」の場合にこの設定が参照されます。
タイムアウトint入力&出力 Platioアプリケーションへの接続時のタイムアウト値を指定します。
コネクションを使用 が「いいえ」の場合にこの設定が参照されます。
プロキシ設定を使用boolean- 管理コンソールで設定したプロキシ設定を使用するかどうかを指定します。
コネクションを使用 が「いいえ」の場合にこの設定が参照されます。
はい [true] - プロキシ設定を使用します。
いいえ [false] - プロキシ設定を使用しません。
ユーザーIDstring入力&出力 削除するユーザーのIDを指定します。

■ループ処理

■トランザクション処理

コミット何もしません。
ロールバック何もしません。

■エラー処理

タイプパラメーターエラー処理フロー
へのストリーム
エラー
コード
説明
APIエラー「APIエラーのパラメーター 」
を参照してください。
コンポーネントの入力ストリーム1 Platio APIがエラーを返した場合
  • パラメーターが不正な場合
  • ユーザー認証に失敗した場合
  • リクエストが許可されていない場合
  • リクエスト数の制限に達した場合
  • サーバー上で問題が発生した場合
  • 一時的にサービスを使用することができない場合
接続エラー なし コンポーネントの入力ストリーム2Platioとの通信中にエラーが発生した場合
3Platioとの通信中、もしくは通信前処理でエラーが発生した場合
汎用 なし コンポーネントの入力ストリーム5コネクション名 に指定したコネクションが見つからない場合
9Platioに関連するその他のエラーが発生した場合
12ユーザーIDが指定されていない場合

■「APIエラー」のパラメーター

No.名前説明
1ErrorCodePlatio APIのエラーコードが返されます。
2StatusCodeHTTPのステータスコードが返されます。
3ErrorResponseエラーレスポンスのJSONが返されます。

■APIトークンの取得方法

Platio APIを使用するためにはAPIトークンを生成する必要があり、PlatioDeleteUserコンポーネントは生成したAPIトークンを指定する必要があります。
APIトークンには「トークンID」と「秘密トークン」がありPlatioの「開発者向け情報」ページで生成することができます。
「トークンID」はAPIトークンを生成後、Platioの「開発者向け情報」ページよりいつでも確認することができますが、「秘密トークン」はAPIトークン生成時のみ表示され、その後、値を確認することはできません。
「秘密トークン」はAPIトークン生成時に「クリップボードにコピー」アイコンをクリックしてコピーし保存してください。

■Platio APIリクエスト回数

PlatioDeleteUserコンポーネントのPlatio APIリクエスト回数は以下のようになります。
API説明
ユーザーの作成・更新・削除 「ユーザーの削除」は実行時に1回実行します。