GravioBAPUserCreate - Gravio BAPのユーザー登録
Gravio BAPにユーザーを登録します。
登録するサムネイル画像および顔認証画像の最大サイズは幅、高さともに4096ピクセル。サポートしているファイル種別はpngとjpegです。
顔認証画像は最大で３画像登録することができます。
■ストリーム情報
| 入力 | フォーマット | すべて | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 接続数 | 無制限 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 説明 | 入力ストリームは使用せず、すべて無視します。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 出力 | フォーマット | Record | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 説明 |
次のようなフィールド定義の固定のレコードが出力されます。
|
■コンポーネントプロパティ
| 名前 | プロパティ型 | マッピング | 説明 |
|---|---|---|---|
| コネクション名 | connection | - | 接続先のサーバーを指定します。コネクションペインまたは管理コンソールにて作成されたGravioBAP接続名を選択します。 |
| ID | string | 入力＆出力 |
ユーザーのIDを指定します。 この値はシステム内のユーザー全体で一意である必要があります。 「_」と「-」を除く特殊文字と記号は許可されません。 |
| 表示名 | string | 入力＆出力 |
ユーザーの表示名を指定します。 「_」と「-」を除く特殊文字と記号は許可されません。 |
| グループ | string | 入力＆出力 | ユーザーを登録するグループを指定します。 |
| 説明 | string | 入力＆出力 | ユーザーの説明を指定します。 |
| 顔認証画像ファイルパス１ | remoteFile | 入力＆出力 |
顔認証に使用する画像ファイルのパスを指定します。 UNIXシステムの場合は、パス名は接頭辞が "/" の場合に絶対パスとみなします。Windowsシステムの場合は、パス名は接頭辞がドライブ指示子のあとに "\\" が続く場合、または接頭辞が "\\" の場合に絶対パスとみなします。 相対パスで指定した場合は、相対パスの起点で指定したホームからの相対になります。 例： directory/face.jpg C:\directory\face.jpg \\server\share\face.jpg |
| 顔認証画像ファイルパス２ | remoteFile | 入力＆出力 | 顔認証に使用する２つ目の画像ファイルのパスを指定します。詳細は顔認証画像ファイルパス１と同様です。 |
| 顔認証画像ファイルパス３ | remoteFile | 入力＆出力 | 顔認証に使用する３つ目の画像ファイルのパスを指定します。詳細は顔認証画像ファイルパス１と同様です。 |
| サムネイル画像ファイルパス | remoteFile | 入力＆出力 |
サムネイルに使用する画像ファイルのパスを指定します。 UNIXシステムの場合は、パス名は接頭辞が "/" の場合に絶対パスとみなします。Windowsシステムの場合は、パス名は接頭辞がドライブ指示子のあとに "\\" が続く場合、または接頭辞が "\\" の場合に絶対パスとみなします。 相対パスで指定した場合は、相対パスの起点で指定したホームからの相対になります。 例： directory/thumbnail.jpg C:\directory\thumbnail.jpg \\server\share\thumbnail.jpg |
| ファイルパスの詳細設定 | group | - | ファイルパスの詳細設定を行うプロパティ群です。 |
| 相対パスの起点 | pathResolver | 入力＆出力 |
相対パス指定の場合にベースフォルダーを指定します。
|
| 絶対パスを許可 | boolean | 入力＆出力 | 絶対パスを許可するかどうか選択します。 |
| 「..」を許可 | boolean | 入力＆出力 | 上のフォルダへ移動する記述に「..」を許可するかどうか選択します。 |
■ループ処理
なし。
■トランザクション処理
| コミット | 何もしません。 |
|---|---|
| ロールバック | 何もしません。 |
■エラー処理
| タイプ | パラメーター | エラー処理フロー へのストリーム | エラー コード | 説明 |
|---|---|---|---|---|
| 汎用 | なし | コンポーネントの入力ストリーム | 1 | 必須パラメーターが指定されていなかった場合 |
| 2 | 顔認証画像ファイルパス１、顔認証画像ファイルパス２、顔認証画像ファイルパス３、サムネイル画像ファイルパスに指定したファイルが見つからなかった場合 | |||
| 3 | 顔認証画像ファイルパス１、顔認証画像ファイルパス２、顔認証画像ファイルパス３、サムネイル画像ファイルパスに指定したファイルのファイル種別がサポートしていないファイル種別だった場合 | |||
| 4 | 顔認証画像ファイルパス１、顔認証画像ファイルパス２、顔認証画像ファイルパス３、サムネイル画像ファイルパスに指定したファイルの読み込みに失敗した場合 | |||
| 5 | 指定したグループが見つからなかった場合 | |||
| APIエラー | 「APIエラーの パラメーター」を 参照してください。 | コンポーネントの入力ストリーム | 201 | APIの実行でエラーコードを受け取った場合 |
| 接続エラー | なし | コンポーネントの入力ストリーム | 301 | サーバーへの接続に失敗した場合 |
■APIエラーのパラメーター
APIエラーが発生したときに設定されるエラーのパラメーターです。
| No. | 名前 | 説明 |
|---|---|---|
| 1 | Message | Gravio BAPから取得したエラーメッセージ。エラーの詳細につきましては、Gravio BAPのサイトを参照ください。 |