システム管理APIで使用するデータの構造
固定リンクがコピーされました
UserDetail
固定リンクがコピーされました
ユーザー情報を表す型です。
使用可能なGaroonのバージョン
固定リンクがコピーされました
- クラウド版Garoon
- パッケージ版Garoon 3.0以降
データ構造
固定リンクがコピーされました
| パラメーター名 | 型 | パラメーター数 | 説明 | 変更履歴 |
|---|---|---|---|---|
| userId/text() | xsd:integer | 1 | GaroonユーザーID | |
| login_name/text() | xsd:string | 1 | ユーザーのログイン名 | |
| display_name/text() | xsd:string | 1 | ユーザーの名前 | |
| password_raw/text() | xsd:string | 0～1
|
ユーザーのパスワード（平文） | パッケージ版Garoon 3.1で削除 |
| password_salt/text() | xsd:string | 0～1 | ユーザーのパスワードの暗号化に使用される文字列 | パッケージ版Garoon 3.1で削除 |
| password_hashed | xsd:string | 0～1 | 暗号化されたパスワード | パッケージ版Garoon 3.1 で削除 |
OrgDetail
固定リンクがコピーされました
組織情報を表す型です。
使用可能なGaroonのバージョン
固定リンクがコピーされました
- クラウド版Garoon
- パッケージ版Garoon 3.0以降
データ構造
固定リンクがコピーされました
| パラメーター名 | 型 | パラメーター数 | 説明 |
|---|---|---|---|
| orgId/text() | xsd:integer | 1 | 組織ID |
| org_code/text() | xsd:string | 1 | 組織コード |
| org_name/text() | xsd:string | 1 | 組織名 |
UserInfoType
固定リンクがコピーされました
ユーザー情報の詳細を表す型です。
使用可能なGaroonのバージョン
固定リンクがコピーされました
- クラウド版Garoon
- パッケージ版Garoon 3.1以降
データ構造
固定リンクがコピーされました
| パラメーター名 | 型 | パラメーター数 | 説明 |
|---|---|---|---|
| primary_group | base:IDType | 0～1 | 優先する組織のID |
| position | xsd:unsignedLong | 0～1 | 表示優先度 |
| invalid | xsd:boolean | 0～1 | 使用状態
|
| sort_key | xsd:string | 0～1 | よみ |
| email_address | xsd:string | 0～1 | |
| description | xsd:string | 0～1 | メモ |
| post | xsd:string | 0～1 | 役職 |
| telephone_number | xsd:string | 0～1 | 電話番号 |
| url | xsd:string | 0～1 | URL |
| locale | base:IDType | 0～1 | ロケールID |
| base | base:IDType | 0～1 | 拠点ID |
| image | base:FileType | 0～1 | 画像 |
| organization | xsd:integer | 0～ 無制限 | ユーザーが所属する組織のID一覧 |