PlatioUpdateUser - Platioユーザーの更新

Platioユーザーを更新します。
共通ユーザー機能が有効かどうか、チーム機能が有効かどうかによって、指定するプロパティが異なります。操作対象の組織・アプリケーションの設定をご確認の上、ご利用ください。

■ストリーム情報

入力	フォーマット	すべて
	接続数	無制限
	説明	入力ストリームは使用せず、すべて無視します。
出力	フォーマット	Record
	説明	更新したユーザー情報を以下のフィールドを持つレコード形式で出力します。 フィールド名 データ型 値 Id String ユーザーのID Name String ユーザーの名前 Email String ユーザーのメールアドレス Admin Boolean ユーザーが管理者かどうかのフラグ ApiAccess Boolean ユーザーがPlatio APIを使えるかどうかのフラグ ManagementApiAccess Boolean ユーザーが管理APIを使えるかどうかのフラグ ProfileName String ユーザーに割り当てるプロファイル TeamName String ユーザーに割り当てるチーム TeamLeader Boolean ユーザーがチームリーダーかどうかのフラグ Disabled Boolean ユーザーの有効・無効フラグ

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

名前	プロパティ型	マッピング	説明
コネクションを使用	boolean	-	接続先に以下のコネクション名 を使用するかどうか選択します。 はい [true] - 以下のコネクション名 で指定されたPlatio接続名を接続先として使用します。 いいえ [false] - コネクション情報 以下のプロパティを使ってPlatioに接続を行います。
コネクション名	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	-	管理コンソールで設定したプロキシ設定を使用するかどうかを指定します。 コネクションを使用 が「いいえ」の場合にこの設定が参照されます。 はい [true] - プロキシ設定を使用します。 いいえ [false] - プロキシ設定を使用しません。
ユーザーID	string	入力＆出力	更新するユーザーのIDを指定します。
メールアドレス	string	入力＆出力	メールアドレスを変更する場合に指定します。 共通ユーザーモードが有効な場合にこのプロパティーに値を設定すると実行時にAPIエラーになります。
パスワード	password	入力＆出力	パスワードを変更する場合に指定します。 共通ユーザーモードが有効な場合にこのプロパティーに値を設定すると実行時にAPIエラーになります。
管理者	choice	入力＆出力	管理者かどうかを変更する場合に指定します。 未指定 [none] - 未指定 はい [true] - 管理者 いいえ [false] - 管理者ではない
APIアクセス権	choice	入力＆出力	Platio APIを使えるかどうかを変更する場合に指定します。 未指定 [none] - 未指定 はい [true] - Platio APIを使える いいえ [false] - Platio APIを使えない
管理APIアクセス権	choice	入力＆出力	管理APIを使えるかどうかを変更する場合に指定します。 未指定 [none] - 未指定 はい [true] - 管理APIを使える いいえ [false] - 管理APIを使えない
プロファイル	string	入力＆出力	ユーザーに割り当てるプロファイルを変更する場合に指定します。
チーム	string	入力＆出力	ユーザーに割り当てるチームを変更する場合に指定します。 チームモードが無効な場合にこのプロパティーに値を設定すると実行時にAPIエラーになります。
チームリーダー	choice	入力＆出力	チームリーダーかどうかを変更する場合に指定します。 チームモードが無効な場合にこのプロパティーに値を設定すると実行時にAPIエラーになります。 未指定 [none] - 未指定 はい [true] - チームリーダー いいえ [false] - チームリーダーではない
有効・無効	choice	入力＆出力	ユーザーの有効・無効を変更する場合に指定します。 ユーザーを無効にすると、アプリケーションにログインできなくなります。 未指定 [none] - 未指定 無効 [true] - ユーザーを無効にする 有効 [false] - ユーザーを有効にする

■ループ処理

■トランザクション処理

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

■エラー処理

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

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

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

■APIトークンの取得方法

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

■Platio APIリクエスト回数

PlatioUpdateUserコンポーネントのPlatio APIリクエスト回数は以下のようになります。

API		説明
ユーザーの作成・更新・削除		「ユーザーの更新」は実行時に１回実行します。
ユーザーリスト・ユーザーの取得		「ユーザーの更新」APIに必須のプロパティが未設定の場合は、既存のユーザー情報を取得するために、実行時に１回実行します。