システム管理APIで使用するデータの構造

フォローする

Index

UserDetail

ユーザー情報を表す型です。

使用可能なガルーンのバージョン

  • Garoon on cybozu
  • パッケージ版 バージョン 3.0.0以降

データ構造

パラメーター名 パラメーター数 説明 変更履歴
userId/text() xsd:integer 1 ユーザーのID  
login_name/text() xsd:string 1 ユーザーのログイン名  
display_name/text() xsd:string 1 ユーザーの名前  
password_raw/text() xsd:string 0 ~ 1
  • 0:パスワードが空
  • 1:1文字以上のパスワードが存在する
ユーザーのパスワード(平文) パッケージバージョン 3.1.0 で削除 
password_salt/text() xsd:string 0 ~ 1 ユーザーのパスワードの暗号化に使用される文字列 パッケージバージョン 3.1.0 で削除
password_hashed xsd:string 0 ~ 1 暗号化されたパスワード パッケージバージョン 3.1.0 で削除

OrgDetail

組織情報を表す型です。

使用可能なガルーンのバージョン

  • Garoon on cybozu
  • パッケージ版 バージョン 3.0.0以降

データ構造

パラメーター名 パラメーター数 説明
orgId/text() xsd:integer 1 組織ID
org_code/text() xsd:string 1 組織コード
org_name/text() xsd:string 1 組織名

UserInfoType

ユーザー情報の詳細を表す型です。

使用可能なガルーンのバージョン

  • Garoon on cybozu
  • パッケージ版 バージョン 3.1.0以降

データ構造

パラメーター名 パラメーター数 説明
primary_group base:IDType 0 ~ 1 優先する組織のID
position xsd:unsignedLong 0 ~ 1 表示優先度
invalid xsd:boolean 0 ~ 1 使用状態
  • true:停止中
  • false:使用中
sort_key xsd:string 0 ~ 1 よみ
email_address xsd:string 0 ~ 1 E-mail
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一覧

記事に関するフィードバック

直接的に記事と関連がないご質問はcybozu developer コミュニティをご活用ください。

ログインしてコメントを残してください。
Powered by Zendesk