カテゴリー内の他の記事

ユーザーを追加、更新、または削除する

フォローする

Index

ユーザーを追加する

ログイン名、名前、パスワードをリクエストのパラメーターとして受け取り、ユーザーを作成し、作成したユーザーの情報をレスポンスとして返す API です。 パスワードを指定しなかった場合は、”cybozu”が初期パスワードとして設定されます。 また、パスワードに空文字を指定することはできません。

API名

AdminAddUserAccount

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

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

リクエスト

パッケージ版 バージョン 3.1.0以降

パラメーター名 パラメーター数 説明
login_name/text() xsd:string 1 作成するユーザーのログイン名
display_name/text() xsd:string 1 作成するユーザーの名前
password_raw/text() xsd:string 0 ~ 1 作成するユーザーのパスワード
user_info admin:UserInfoType 0 ~ 1 作成するユーザーの情報

パッケージ版 バージョン 3.0.x

パラメーター名 パラメーター数 説明
login_name/text() xsd:string 1 作成するユーザーのログイン名
display_name/text() xsd:string 1 作成するユーザーの名前
password_raw/text() xsd:string 0 ~ 1 作成するユーザーのパスワード
password_salt/text() xsd:string 0 ~ 1  ユーザーのパスワードの暗号化に使用する文字列
password_hashed/text() xsd:string 0 ~ 1  saltとパスワードから求められるハッシュ値

パッケージ版 バージョン 3.1.0以降

<parameters>
  <login_name xmlns="">user2</login_name>
  <display_name xmlns="">ユーザー2</display_name>
  <password_raw xmlns="">user2</password_raw>
  <user_info xmlns="" primary_group="1" position="2"
    sort_key="ゆーざー2" email_address="user2@sample-mail-server"
    description="メモ" post="部長" telephone_number="0000-00-0000"
    url="http://xxx" locale="1" base="2">
    <organization>1</organization>
    <organization>2</organization>
  </user_info>
</parameters>

パッケージ版 バージョン 3.0.x

<parameters> 
  <login_name xmlns="">user2</login_name> 
  <display_name xmlns="">ユーザー2</display_name> 
  <password_raw xmlns="">user2</password_raw> 
</parameters>

レスポンス

パラメーター名 パラメーター数 説明
userAccount admin:UserDetail 0 ~ 1
  • 0:作成されたユーザーが存在しない
  • 1:作成されたユーザーが存在する
作成されたユーザーの情報

パッケージ版 バージョン 3.1.0以降

<returns> 
  <userAccount> 
    <userId>3</userId> 
    <login_name>user2</login_name> 
    <display_name>ユーザー2</display_name> 
  </userAccount> 
</returns>

パッケージ版 バージョン 3.0.x

<returns> 
  <userAccount> 
    <userId>3</userId> 
    <login_name>user2</login_name> 
    <display_name>ゆーざー2</display_name> 
    <password_raw>cybozu</password_raw> 
    <password_salt>1((d</password_salt> 
    <password_hashed>2163429666565b2d9dcbb72f7c64e53c67c3abc7</password_hashed> 
  </userAccount> 
</returns>

エラー

エラー番号 説明
GRN_CMMN_00102 ガルーンにすでに存在するログイン名をlogin_nameに指定した場合

ユーザーを削除する

ユーザーID をリクエストのパラメーターとして受け取り、指定されたユーザーを削除する API です。 この API は、削除したユーザーの数とユーザーID をレスポンスとして返します。 存在しないユーザーID を指定した場合は、エラーは発生せず、その ID に対する処理は行いません。

API名

AdminRemoveUsersByIds

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

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

リクエスト

パラメーター名 パラメーター数 説明
userId/text() xsd:integer 1 ~ 無制限 削除するユーザーのID

<parameters> 
  <userId>4</userId> 
</parameters>

レスポンス

パラメーター名 パラメーター数 説明
number_accounts_affected/text() xsd:integer 1 削除されたユーザーの数
affected_userId/text() xsd:integer 0 ~ 無制限
  • 0:削除されたユーザーが存在しない
削除されたユーザーのID

<returns> 
  <number_accounts_affected>1</number_accounts_affected> 
  <affected_userId>4</affected_userId> 
</returns>

ユーザーを更新する

ユーザーID、ログイン名、名前、パスワードをリクエストのパラメーターとして受け取り、ユーザー情報を変更する API です。 この API のレスポンスには、変更したユーザー情報が返されます。 ログイン名、名前、パスワードの指定は任意で、指定した場合その情報を変更し、指定しない場合は情報の変更を行いません。 パスワードに空文字を指定することはできません。

API名

AdminModifyUserAccount

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

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

リクエスト

パッケージ版 バージョン 3.1.0以降

パラメーター名 パラメーター数 説明
userId/text() xsd:integer 1 変更するユーザーのID
login_name/text() xsd:string 0 ~ 1 変更するユーザーのログイン名
display_name/text() xsd:string 0 ~ 1 変更するユーザーの名前
password_raw/text() xsd:string 0 ~ 1 変更するユーザーのパスワード
user_info admin:UserInfoType 0 ~ 1 変更するユーザーの情報

注:2016年12月現在、下記の不具合情報公開サイトに掲載の通り、login_nameとdisplay_nameについては省略した場合にエラーが発生するという不具合が確認されています。

不具合情報公開サイト
https://support.cybozu.com/ja-jp/article/7948

パッケージ版 バージョン 3.0.x

パラメーター名 パラメーター数 説明
userId/text() xsd:integer 1 変更するユーザーのID
login_name/text() xsd:string 0 ~ 1 変更するユーザーのログイン名
display_name/text() xsd:string 0 ~ 1 変更するユーザーの名前
password_raw/text() xsd:string 0 ~ 1 変更するユーザーのパスワード
password_salt/text() xsd:string 0 ~ 1  パスワードを暗号化するsalt
password_hashed/text() xsd:string 0 ~ 1  saltとパスワードから求められるハッシュ値

パッケージ版 バージョン 3.1.0以降

<parameters>
  <userId xmlns="">4</userId>
  <login_name xmlns="">AB</login_name>
  <display_name xmlns="">AB</display_name>
  <user_info xmlns="" primary_group="2" position="10"
    sort_key="えーびー" email_address="user2@sample-mail-server"
    description="メモ" post="係長" telephone_number="0000-00-0000"
    url="http://xxx" locale="1" base="2">
    <organization>2</organization>
  </user_info>
</parameters>

パッケージ版 バージョン 3.0.x

<parameters> 
  <userId>4</userId> 
  <login_name>AB</login_name> 
  <display_name>AB</display_name> 
</parameters>

レスポンス

パラメーター名 パラメーター数 説明
userAccount admin:UserDetail 1 変更されたユーザーの情報

パッケージ版 バージョン 3.1.0以降

<returns> 
  <userAccount> 
    <userId>4</userId> 
    <login_name>AB</login_name> 
    <display_name>AB</display_name> 
  </userAccount> 
</returns>

パッケージ版 バージョン 3.0.x

<returns> 
  <userAccount> 
    <userId>4</userId> 
    <login_name>AB</login_name> 
    <display_name>AB</display_name> 
    <password_raw>cybozu</password_raw> 
    <password_salt>1((d</password_salt> 
    <password_hashed>2163429666565b2d9dcbb72f7c64e53c67c3abc7</password_hashed> 
  </userAccount> 
</returns>

エラー

エラー番号 説明
GRN_SYSAPI_64008 指定したユーザーIDが存在しない場合

ユーザーを組織に所属させる

ユーザーIDと、そのユーザーが新たに所属する組織のIDをリクエストのパラメーターとして受け取り、設定を変更したユーザーと組織の情報をレスポンスとして返すAPIです。 AdminAddUsersToOrgと異なり、このAPIは一人のユーザーに対して複数の組織を指定することができます。

API名

AdminSetOrgsOfUser

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

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

リクエスト

パラメーター名 パラメーター数 説明
userId/text() xsd:integer 1 設定を変更するユーザーのID
orgId/text() xsd:integer 1 ~ 無制限 ユーザが新たに所属する組織のID

<parameters> 
  <userId>20</userId> 
  <orgId>489</orgId> 
  <orgId>428</orgId> 
  <orgId>367</orgId> 
</parameters>

レスポンス

パラメーター名 パラメーター数 説明
number_relationships_affected/text() xsd:integer 1 ユーザーが新たに所属した組織の数
affected_userId/text() xsd:integer 1 設定が変更されたユーザーのID
affected_orgId/text() xsd:integer 0 ~ 無制限 ユーザーが新たに所属した組織のID

<returns> 
  <number_relationships_affected> 
    3 
  </number_relationships_affected> 
  <affected_userId>20</affected_userId> 
  <affected_orgId>367</affected_orgId> 
  <affected_orgId>428</affected_orgId> 
  <affected_orgId>489</affected_orgId> 
</returns>

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

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

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