PlatioDeleteUser - Platioユーザーの削除
Platioユーザーを削除します。
共通ユーザー機能が有効な場合には使用できません。
■ストリーム情報
| 入力 | フォーマット | すべて |
|---|---|---|
| 接続数 | 無制限 | |
| 説明 | 入力ストリームは使用せず、すべて無視します。 | |
| 出力 | フォーマット | すべて |
| 説明 | 入力ストリームをそのまま出力します。 |
■コンポーネントプロパティ
| 名前 | プロパティ型 | マッピング | 説明 | ||||||
|---|---|---|---|---|---|---|---|---|---|
| コネクションを使用 | boolean | - |
接続先に以下のコネクション名 を使用するかどうか選択します。
|
||||||
| コネクション名 | connection | - | コネクションを使用 が「はい」の場合に、Platioアプリケーションへの接続用コネクションを指定します。
コネクションペインまたは管理コンソールにて作成した接続名を選択します。 各コネクションの詳細については、「はじめに」-「詳細なトピック」-「フローの構成要素」-「コネクションプロパティ」を参照してください。 |
||||||
| コネクション情報 | group | - | コネクションを使用 プロパティが「いいえ」の場合に使用されるプロパティ群です。 | ||||||
| アプリケーションベースURL | string | 入力＆出力 |
PlatioのアプリケーションベースURLを指定します。
指定するURLは「 https://api.plat.io/v1/[アプリケーションのID] 」の形式で指定します。 コネクションを使用 が「いいえ」の場合にこの設定が参照されます。 |
||||||
| トークンID | string | 入力＆出力 |
Platioの開発者向け情報ページから取得したAPIトークンのトークンIDを指定します。
詳細については下記トピック「APIトークンの取得方法」を参照してください。 コネクションを使用 が「いいえ」の場合にこの設定が参照されます。 |
||||||
| 秘密トークン | password | 入力＆出力 |
Platioの開発者向け情報ページから取得したAPIトークンの秘密トークンを指定します。
詳細については下記トピック「APIトークンの取得方法」を参照してください。 コネクションを使用 が「いいえ」の場合にこの設定が参照されます。 |
||||||
| タイムアウト | int | 入力＆出力 |
Platioアプリケーションへの接続時のタイムアウト値を指定します。
コネクションを使用 が「いいえ」の場合にこの設定が参照されます。 |
||||||
| プロキシ設定を使用 | boolean | - |
管理コンソールで設定したプロキシ設定を使用するかどうかを指定します。
コネクションを使用 が「いいえ」の場合にこの設定が参照されます。
|
||||||
| ユーザーID | string | 入力＆出力 |
削除するユーザーのIDを指定します。
|
■ループ処理
■トランザクション処理
| コミット | 何もしません。 |
|---|---|
| ロールバック | 何もしません。 |
■エラー処理
| タイプ | パラメーター | エラー処理フロー
へのストリーム | エラー
コード | 説明 |
|---|---|---|---|---|
| APIエラー | 「APIエラーのパラメーター
」
を参照してください。 | コンポーネントの入力ストリーム | 1 |
Platio APIがエラーを返した場合
|
| 接続エラー | なし | コンポーネントの入力ストリーム | 2 | Platioとの通信中にエラーが発生した場合 |
| 3 | Platioとの通信中、もしくは通信前処理でエラーが発生した場合 | |||
| 汎用 | なし | コンポーネントの入力ストリーム | 5 | コネクション名 に指定したコネクションが見つからない場合 |
| 9 | Platioに関連するその他のエラーが発生した場合 | |||
| 12 | ユーザーIDが指定されていない場合 |
■「APIエラー」のパラメーター
| No. | 名前 | 説明 |
|---|---|---|
| 1 | ErrorCode | Platio APIのエラーコードが返されます。 |
| 2 | StatusCode | HTTPのステータスコードが返されます。 |
| 3 | ErrorResponse | エラーレスポンスのJSONが返されます。 |
■APIトークンの取得方法
Platio APIを使用するためにはAPIトークンを生成する必要があり、PlatioDeleteUserコンポーネントは生成したAPIトークンを指定する必要があります。
APIトークンには「トークンID」と「秘密トークン」がありPlatioの「開発者向け情報」ページで生成することができます。
「トークンID」はAPIトークンを生成後、Platioの「開発者向け情報」ページよりいつでも確認することができますが、「秘密トークン」はAPIトークン生成時のみ表示され、その後、値を確認することはできません。
「秘密トークン」はAPIトークン生成時に「クリップボードにコピー」アイコンをクリックしてコピーし保存してください。
■Platio APIリクエスト回数
PlatioDeleteUserコンポーネントのPlatio APIリクエスト回数は以下のようになります。
| API | 説明 | |
|---|---|---|
| ユーザーの作成・更新・削除 |
「ユーザーの削除」は実行時に１回実行します。
|
|